EventHighlighting
Mixin

Mixin that provides event highlighting for the Calendar. Highlighted events are displayed at full opacity while non-highlighted events fade to 20% opacity.

This matches the highlightEvents() / unhighlightEvents() API available on Scheduler and Gantt via TimelineBase.

const calendar = new Calendar({ ... });

// Highlight specific events by id
calendar.highlightEvents({ events : [1, 2, 3] });

// Highlight and scroll to the event
calendar.highlightEvents({ events : 42, scroll : true });

// Remove all highlighting
calendar.unhighlightEvents();

No results

Properties

Properties are getters/setters or publicly accessible variables on this class

isEventHighlighting : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of EventHighlighting class, or subclass thereof.

isEventHighlighting : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of EventHighlighting class, or subclass thereof.

Functions

Functions are methods available for calling on the class

cleanupHighlightedEvents( )

private

Called from onCalendarStoreChange to clean up highlighted events for records that have been removed from the event store.
updateHighlighted( )

private

Syncs the b-highlighted CSS class on all visible event elements to match the current set of highlighted event records.
highlightEvents( options )
Highlights the elements of the passed event records (or record ids). The first highlighted event element will be scrolled into view by default.

Adds the CSS class b-highlighted to highlighted event elements, and b-is-highlighting to the Calendar's root element, which fades non-highlighted events to 20% opacity.
```
// Highlight single event
calendar.highlightEvents({ events : 22 });
// Highlight multiple events
calendar.highlightEvents({ events : [1, 40] });
// Don't scroll to highlighted event, and don't un-highlight on click
calendar.highlightEvents({ events : 1000, scroll : false, unhighlightOnClick : false });
```
isEventHighlighted( eventOrId )
: Boolean

Returns true if the passed event (or event id) is currently highlighted.

unhighlightEvents( options )

Removes highlighting from the elements of the passed event records (or record ids). If no events are passed all highlighted events will be un-highlighted.

calendar.unhighlightEvents({ events : 22 }); // single event
calendar.unhighlightEvents({ events : [1, 40] }); // multiple events
calendar.unhighlightEvents(); // un-highlight all

Source path

Calendar/view/mixin/EventHighlighting.js

Inheritance tree1

EventHighlighting

EventHighlighting Mixin

Properties

Functions

Source path

Inheritance tree1

Contents

EventHighlighting
Mixin