EventSelection

Configs

deselectAllOnScheduleClick: Boolean= trueAlso a property

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

deselectOnClickEventSelection

eventSelectionDisabledEventSelection

highlightPredecessorsEventSelection

highlightSuccessorsEventSelection

isEventSelectableEventSelection

maintainSelectionOnDatasetChangeEventSelection

multiEventSelectEventSelection

selectResourceOnEventNavigateEventSelection

selectResourceOnScheduleClickEventSelection

triggerSelectionChangeOnRemoveEventSelection

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

deselectAllOnScheduleClick: Boolean= trueAlso a config

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

selectedEvents: EventModel[]

The events which are selected.

isEventSelectableEventSelection

selectedAssignmentsEventSelection

selectResourceOnEventNavigateEventSelection

selectResourceOnScheduleClickEventSelection

Functions

clearEventSelection

Deselects all events.

deselect

Deselects the passed eventif it is selected.

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

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 to be deselected

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 if it is not selected.

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

selectEvent

Selects the passed event if it is not selected.

Parameter	Type	Description
`event`	EventModel	The event 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

deselectAssignmentEventSelection

deselectAssignmentsEventSelection

isAssignmentSelectedEventSelection

selectAssignmentEventSelection

selectAssignmentsEventSelection

Events

selectionChange

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

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

});

Parameter	Type	Description
`source`	Calendar	The Calendar 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.

assignmentSelectionChangeEventSelection

beforeAssignmentSelectionChangeEventSelection

beforeEventSelectionChangeEventSelection

eventSelectionChangeEventSelection

Event handlers

onSelectionChange

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

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

    }
});

Parameter	Type	Description
`source`	Calendar	The Calendar 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.

onAssignmentSelectionChangeEventSelection

onBeforeAssignmentSelectionChangeEventSelection

onBeforeEventSelectionChangeEventSelection

onEventSelectionChangeEventSelection