EventSelection

Configs

deselectAllOnScheduleClick: Boolean= true

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

deselectOnClick: Boolean= false

Configure as true to deselect a selected event upon click.

eventSelectionDisabled: Boolean= false

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

highlightPredecessors: Boolean= false

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

highlightSuccessors: Boolean= false

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

isEventSelectable: functionAlso a property

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();
    }
})

Parameter	Type	Description
`event`	EventModel	The event record

Returns: Boolean -

true if event can be selected, otherwise false

maintainSelectionOnDatasetChange: Boolean= true

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.

Parameter	Type	Description
`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: Boolean= trueAlso a property

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

selectResourceOnScheduleClick: Boolean= trueAlso a property

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

triggerSelectionChangeOnRemove: Boolean= false

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

Properties

Class hierarchy

isEventSelection: Boolean= truereadonly

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

isEventSelection: Boolean= truereadonlystatic

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

Selection

isEventSelectable: functionAlso a config

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();
    }
})

Parameter	Type	Description
`event`	EventModel	The event record

Returns: Boolean -

true if event can be selected, otherwise false

selectedAssignments: AssignmentModel[]

The events which are selected.

selectedEvents: EventModel[]

The events which are selected.

selectResourceOnEventNavigate: Boolean= trueAlso a config

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

selectResourceOnScheduleClick: Boolean= trueAlso a config

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

Functions

clearEventSelection

Deselects all events and assignments.

deselect

Deselects the passed event or assignment if it is selected.

Parameter	Type	Description
`eventOrAssignment`	EventModel \| AssignmentModel	The event or assignment to deselect.

deselectAssignment

Deselects the passed assignment if it is selected.

Parameter	Type	Description
`assignment`	AssignmentModel	The assignment to deselect
`event`	Event	If this method was invoked as a result of a user action, this is the DOM event that triggered it

deselectAssignments

Removes assignments from the selection.

Parameter	Type	Description
`assignments`	AssignmentModel[]	Assignments to be deselected

deselectEvent

Deselects the passed event if it is selected.

Parameter	Type	Description
`event`	EventModel	The event to deselect.

deselectEvents

Removes events from the selection.

Parameter	Type	Description
`events`	EventModel[]	Events or assignments to be deselected

isAssignmentSelected

Returns true if the assignment is selected.

Parameter	Type	Description
`assignment`	AssignmentModel	The assignment

Returns: Boolean -

Returns true if the assignment is selected

isEventSelected

Returns true if the event is selected.

Parameter	Type	Description
`event`	EventModel	The event

Returns: Boolean -

Returns true if the event is selected

select

Selects the passed event or assignment if it is not selected. Selecting events results in all their assignments being selected.

Parameter	Type	Description
`eventOrAssignment`	EventModel \| AssignmentModel	The event or assignment to select
`preserveSelection`	Boolean	Pass `true` to preserve any other selected events or assignments

selectAssignment

Selects the passed assignment if it is not selected.

Parameter	Type	Description
`assignment`	AssignmentModel	The assignment to select
`preserveSelection`	Boolean	Pass `true` to preserve any other selected assignments
`event`	Event	If this method was invoked as a result of a user action, this is the DOM event that triggered it

selectAssignments

Adds assignments to the selection.

Parameter	Type	Description
`assignments`	AssignmentModel[]	Assignments to be selected

selectEvent

Selects the passed event if it is not selected. Selecting an event will select all its assignments.

Parameter	Type	Description
`event`	EventModel	The event to select
`preserveSelection`	Boolean	Pass `true` to preserve any other selected events

selectEvents

Adds events to the selection.

Parameter	Type	Description
`events`	EventModel[]	Events to be selected
`preserveSelection`	Boolean	Pass `true` to preserve any other selected events

Events

assignmentSelectionChange

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

// Adding a listener using the "on" method
eventSelection.on('assignmentSelectionChange', ({ source, action, selected, deselected, selection }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	AssignmentModel[]	An array of the Assignments added to the selection.
`deselected`	AssignmentModel[]	An array of the Assignments removed from the selection.
`selection`	AssignmentModel[]	The new selection.

beforeAssignmentSelectionChange

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

// Adding a listener using the "on" method
eventSelection.on('beforeAssignmentSelectionChange', ({ source, action, selected, deselected, selection }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	AssignmentModel[]	An array of assignments that will be added to the selection.
`deselected`	AssignmentModel[]	An array of assignments that will be removed from the selection.
`selection`	AssignmentModel[]	The currently selected assignments, before applying `selected` and `deselected`.

beforeEventSelectionChange

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

// Adding a listener using the "on" method
eventSelection.on('beforeEventSelectionChange', ({ source, action, selected, deselected, selection }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	EventModel[]	An array of events that will be added to the selection.
`deselected`	EventModel[]	An array of events that will be removed from the selection.
`selection`	EventModel[]	The currently selected events, before applying `selected` and `deselected`.

eventSelectionChange

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

// Adding a listener using the "on" method
eventSelection.on('eventSelectionChange', ({ source, action, selected, deselected, selection }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	EventModel[]	An array of the Events added to the selection.
`deselected`	EventModel[]	An array of the Event removed from the selection.
`selection`	EventModel[]	The new selection.

Event handlers

onAssignmentSelectionChange

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

new EventSelection({
    onAssignmentSelectionChange({ source, action, selected, deselected, selection }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	AssignmentModel[]	An array of the Assignments added to the selection.
`deselected`	AssignmentModel[]	An array of the Assignments removed from the selection.
`selection`	AssignmentModel[]	The new selection.

onBeforeAssignmentSelectionChange

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

new EventSelection({
    onBeforeAssignmentSelectionChange({ source, action, selected, deselected, selection }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	AssignmentModel[]	An array of assignments that will be added to the selection.
`deselected`	AssignmentModel[]	An array of assignments that will be removed from the selection.
`selection`	AssignmentModel[]	The currently selected assignments, before applying `selected` and `deselected`.

onBeforeEventSelectionChange

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

new EventSelection({
    onBeforeEventSelectionChange({ source, action, selected, deselected, selection }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	EventModel[]	An array of events that will be added to the selection.
`deselected`	EventModel[]	An array of events that will be removed from the selection.
`selection`	EventModel[]	The currently selected events, before applying `selected` and `deselected`.

onEventSelectionChange

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

new EventSelection({
    onEventSelectionChange({ source, action, selected, deselected, selection }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler instance.
`action`	select \| deselect \| update \| clear	One of the actions 'select', 'deselect', 'update', 'clear'
`selected`	EventModel[]	An array of the Events added to the selection.
`deselected`	EventModel[]	An array of the Event removed from the selection.
`selection`	EventModel[]	The new selection.