EventSelection
Mixin

Mixin that tracks event or assignment selection by clicking on one or more events in the scheduler. It supports single selection, multi-select with Ctrl/Cmd click, and range selection with Shift click.

const scheduler = new Scheduler({
    multiEventSelect : true,

    listeners : {
        eventSelectionChange({ selection }) {
            console.log('Selected events:', selection);
        }
    }
});

Configs

Configs are options you supply in a configuration object when creating an instance of this class

selectedCollection : Collection

private

Collection to store selection.
eventAssignHighlightCls : Stringb-sch-event-assign-selected

private

CSS class to add to other instances of a selected event, to highlight them.
eventSelectedCls : Stringb-selected

private

CSS class to add to selected events.
deselectAllOnScheduleClick : Booleantrue

Configure as false to preserve selection when clicking the empty schedule area.
deselectOnClick : Booleanfalse

Configure as true to deselect a selected event upon click.
eventSelectionDisabled : Booleanfalse

Configure as true, or set property to true to disable event selection.
highlightPredecessors : Booleanfalse

Configure as true, or set property to true to highlight dependent events as well when selecting an event.
highlightSuccessors : Booleanfalse

Configure as true, or set property to true to highlight dependent events as well when selecting an event.
isEventSelectable : Function
A template method (empty by default) allowing you to control if an event can be selected or not.
```
new Scheduler({
    isEventSelectable(event) {
        return event.startDate >= Date.now();
    }
})
```
This selection process is applicable to calendar too:
```
new Calendar({
    isEventSelectable(event) {
        return event.startDate >= Date.now();
    }
})
```
Parameters
- event : EventModel
  
  The event record
Returns

Boolean
:

true if event can be selected, otherwise false
Has a corresponding runtime isEventSelectable property.
maintainSelectionOnDatasetChange : Booleantrue

This flag controls whether Scheduler should preserve its selection of events when loading a new dataset (if selected event ids are included in the newly loaded dataset).
multiEventSelect : Boolean/Object
Configure as true to allow CTRL/CMD+click to select multiple events in the scheduler.

Or pass an object to control which modifier keys to use for multi selection.
- ctrlKey : Boolean
  
  Set to true to use Ctrl key for multi selection (Cmd on Mac).
- altKey : Boolean
  
  Set to true to use Alt key for multi selection (Option on Mac)
- shiftKey : Boolean
  
  Set to true to use Shift key for multi selection
selectResourceOnEventNavigate : Booleantrue

Set to false to not select the resource of the event when clicking an event bar.

Has a corresponding runtime selectResourceOnEventNavigate property.
selectResourceOnScheduleClick : Booleantrue

Set to false to not select the row/resource when clicking the empty area in a time axis cell.

Has a corresponding runtime selectResourceOnScheduleClick property.
triggerSelectionChangeOnRemove : Booleanfalse

Configure as true to trigger selectionChange when removing a selected event/assignment.

Properties

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

isEventSelection : Booleantrue

READONLY

static

ADVANCED

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

isEventSelection : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of EventSelection class, or subclass thereof.
isEventSelectable : Function
A template method (empty by default) allowing you to control if an event can be selected or not.
```
new Scheduler({
    isEventSelectable(event) {
        return event.startDate >= Date.now();
    }
})
```
This selection process is applicable to calendar too:
```
new Calendar({
    isEventSelectable(event) {
        return event.startDate >= Date.now();
    }
})
```
Has a corresponding isEventSelectable config.
selectResourceOnEventNavigate : Booleantrue

Set to false to not select the resource of the event when clicking an event bar.

Has a corresponding selectResourceOnEventNavigate config.
selectResourceOnScheduleClick : Booleantrue

Set to false to not select the row/resource when clicking the empty area in a time axis cell.

Has a corresponding selectResourceOnScheduleClick config.
selectedAssignments : AssignmentModel[]

The assignments which are selected.
selectedEvents : EventModel[]

The events which are selected.

Functions

Functions are methods available for calling on the class

onAssignmentChange( )

private

Assignment change listener to remove events from selection which are no longer in the assignments.
onAssignmentSelectionClick( )

private

Mouse listener to update selection.
onBeforeSelectedCollectionSplice( params )

private

Responds to mutations of the underlying selection Collection. Keeps the UI synced, eventSelectionChange and assignmentSelectionChange event is fired when me.silent is falsy.
onEventNavigate( )

private

Navigation listener to update selection.
clearEventSelection( )

Deselects all events and assignments.
deselect( eventOrAssignment )

Deselects the passed event or assignmentif it is selected.
deselectAssignment( assignment, event )

Deselects the passed assignmentif it is selected.
deselectAssignments( assignments )

Removes assignments from the selection.
deselectEvent( event )

Deselects the passed eventif it is selected.
deselectEvents( events )

Removes events from the selection.
isAssignmentSelected( assignment )
: Boolean

Returns true if the assignment is selected.
isEventSelected( event )
: Boolean

Returns true if the event is selected.
select( eventOrAssignment, preserveSelectionfalse )

Selects the passed event or assignmentif it is not selected. Selecting events results in all their assignments being selected.
selectAssignment( assignment, preserveSelectionfalse, event )

Selects the passed assignmentif it is not selected.
selectAssignments( assignments )

Adds assignments to the selection.
selectEvent( event, preserveSelectionfalse )

Selects the passed eventif it is not selected. Selecting an event will select all its assignments.
selectEvents( events, preserveSelectionfalse )

Adds events to the selection.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

assignmentSelectionChange

Fired any time there is a change to the assignments selected in the Scheduler.
beforeAssignmentSelectionChange

PREVENTABLE

Fired any time there is going to be a change to the assignments selected in the Scheduler. Returning false prevents the change
beforeEventSelectionChange

PREVENTABLE

Fired any time there is going to be a change to the events selected in the Scheduler. Returning false prevents the change
eventSelectionChange

Fired any time there is a change to the events selected in the Scheduler.

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onAssignmentSelectionChange

Called any time there is a change to the assignments selected in the Scheduler.
onBeforeAssignmentSelectionChange

PREVENTABLE

Called any time there is going to be a change to the assignments selected in the Scheduler. Returning false prevents the change
onBeforeEventSelectionChange

PREVENTABLE

Called any time there is going to be a change to the events selected in the Scheduler. Returning false prevents the change
onEventSelectionChange

Called any time there is a change to the events selected in the Scheduler.

Source path

Scheduler/view/mixin/EventSelection.js

Inheritance tree1

EventSelection

EventSelection
Mixin

See also

Configs

Parameters

Returns

Properties

Functions

Events

Event handlers

Source path

Inheritance tree1

Contents

EventSelection Mixin

See also

Configs

Parameters

Returns

Properties

Functions

Events

Event handlers

Source path

Inheritance tree1

Contents

EventSelection
Mixin