SchedulerBase
Widget

A thin base class for Scheduler. Does not include any features by default, allowing smaller custom-built bundles if used in place of Scheduler.

NOTE: In most scenarios you do probably want to use Scheduler instead of SchedulerBase.

const scheduler = new SchedulerBase({
    appendTo  : 'container',
    startDate : new Date(2024, 0, 1),
    endDate   : new Date(2024, 0, 8),
    columns   : [
        { text : 'Name', field : 'name', width : 130 }
    ]
});

Useful configs and functions

Member	Description
mode	Display mode: `horizontal` or `vertical`
readOnly	Set to `true` to prevent editing
eventStore	Store holding event records
resourceStore	Store holding resource records
responsiveLevels	Responsive breakpoint configurations
editEvent	Programmatically open the event editor
beforeEventAdd	Fires before an event is added
eventAutoCreated	Fires after an auto-created event

Configs

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

keyMap : Object<String, KeyMapConfig>

See Keyboard shortcuts for details
mode : 'horizontal'/'vertical'

NON-LAZY-LOAD

Scheduler mode. Supported values: horizontal, vertical

Has a corresponding runtime mode property.
rowHeight : Number60

The height in pixels of Scheduler rows.
inheritEventColor : Boolean

Set to true for child nodes in a tree store to inherit their parent´s eventColor

Has a corresponding runtime inheritEventColor property.
listRangeMenu : MenuConfig
This property is for use when the Scheduler is used as a Calendar view - a mode.

A Menu configuration block which configures the range choosing menu provided which by default selects one of the following:
- day
- week
- month
- year
- decade
This menu is added to the TimeAxisHeaderMenu when the Scheduler is used as a Calendar view.

This may be used to either reconfigure that menu, or, by configuring it as null, could remove the menu entirely if the date range of this view is controlled by other means.

The individual range menu items are under the items property and have the following property names:
- listRangeDayItem
- listRangeWeekItem
- listRangeMonthItem
- listRangeYearItem
- listRangeDecadeItem
These may be reconfigured:
```
calendar = new Calendar({
    ...
    modes : {
        timeline : {
            type          : 'scheduler',
            range         : 'month',
            listRangeMenu : {
                items : {
                    // We don't want the decade range option
                    listRangeDecadeItem : null
                }
            }
        }
    }
});
```
Has a corresponding runtime listRangeMenu property.
transition : Object
Configure UI transitions for various actions in the grid.
- insertRecord : Boolean
  
  Transition record insertions
- removeRecord : Boolean
  
  Transition record removals
- toggleColumn : Boolean
  
  Transition column visibility changes
- expandCollapseColumn : Boolean
  
  Transition parent/group column expand/collapse
- toggleRegion : Boolean
  
  Transition region expand/collapse
- toggleTreeNode : Boolean
  
  Transition tree node expand/collapse
- toggleGroup : Boolean
  
  Transition group expand/collapse
- filterRemoval : Boolean
  
  Transition row removals caused by filtering (under specific conditions)
- removeEvent : Boolean
  
  Transition event removals
- changeEvent : Boolean
  
  Transition event changes
Has a corresponding runtime transition property.
eventCls : Stringb-sch-event

private

CSS class to add to rendered events
overScheduledEventClass : Stringb-hover

private

A CSS class to apply to each event in the view on mouseover (defaults to 'b-hover').
timeCellCls : Stringb-sch-time-axis-cell

private

CSS class to add to cells in the timeaxis column
date : Date

The date to display when used as a component of a Calendar.

This is required by the Calendar Mode Interface.

Has a corresponding runtime date property.
range : String/DurationConfig"week"

Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are 'month', 'week' and 'day'.

This may also be specified as a duration with a magnitude part and a unit part. For example '1m' would mean one month, and '4w' would mean four weeks. See parseDuration for details of syntax.

When using a range of weeks or months, then when this widget's date is synced with its owning Calendar's date property, this widget's startDate is snapped to the closest start point of the range which encompasses that date.

So if using range : '1w', then setting the date to Thursday, 28th October 2021 Would mean that the startDate snaps to Sunday 24th October 2021 (assuming the locale uses Sunday as the week start day).

Has a corresponding runtime range property.
shiftIncrement : String/DurationConfig
This property is for use when the Scheduler is used as a Calendar view - a mode - it will have no effect on a Scheduler which is not inside a Calendar.

The time range to move by when next or previous is called.

If not specified, this view moves by its duration in days as derived from its range.

Valid values are:
- day
- week
- month
- year
- decade
This may also be specified as a duration with a magnitude part and a unit part. For example '1m' would mean one month, and '4w' would mean four weeks. See parseDuration for details of syntax.

When using a range of weeks, months, years or decades, then when this widget's date is synced with its owning Calendar's date, this widget's startDate is snapped to the closest start point of the range which encompasses that date.

So if using range : '1w', then setting the date to Thursday, 28th October 2021 would mean that the startDate snaps to Sunday 24th October 2021 (assuming the locale uses Sunday as the week start day).

If configured to use a range of days, no snapping is done. There's no defined start point so the startDate is set to the incoming Calendar date.

Has a corresponding runtime shiftIncrement property.
assignmentStore : AssignmentStore/AssignmentStoreConfig

The optional AssignmentStore, holding assignments between resources and events. Required for multi assignments.

Has a corresponding runtime assignmentStore property.
assignments : AssignmentModel[]/Object[]

NON-LAZY-LOAD

Inline assignments, will be loaded into an internally created AssignmentStore.

Has a corresponding runtime assignments property.
dependencies : DependencyModel[]/DependencyModelConfig

NON-LAZY-LOAD

Inline dependencies, will be loaded into an internally created DependencyStore.

Has a corresponding runtime dependencies property.
dependencyStore : DependencyStore/DependencyStoreConfig

The optional DependencyStore.

Has a corresponding runtime dependencyStore property.
eventStore : EventStore/EventStoreConfig

The EventStore holding the events to be rendered into the scheduler (required).

Has a corresponding runtime eventStore property.
events : EventModel[]/EventModelConfig

NON-LAZY-LOAD

Inline events, will be loaded into an internally created EventStore.

Has a corresponding runtime events property.
resourceStore : ResourceStore/ResourceStoreConfig

The ResourceStore holding the resources to be rendered into the scheduler (required).

Has a corresponding runtime resourceStore property.
resources : ResourceModel[]/ResourceModelConfig

NON-LAZY-LOAD

Inline resources, will be loaded into an internally created ResourceStore.

Has a corresponding runtime resources property.
scrollBuffer : Number0

internal

Number of pixels to horizontally extend the visible render zone by, controlling the events that will be rendered. You can use this to increase or reduce the amount of event rendering happening when scrolling along a horizontal time axis. This can be useful if you render huge amount of events.

To force the scheduler to render all events within the TimeAxis start & end dates, set this to -1. The initial render will take slightly longer but no extra event rendering will take place when scrolling.

NOTE: This is an experimental API which might change in future releases.
getRowHeight : Function
Scheduler overrides Grid's default implementation of getRowHeight to pre-calculate row heights based on events in the rows.

The amount of rows that are pre-calculated is limited for performance reasons. The limit is configurable by specifying the preCalculateHeightLimit config.

The results of the calculation are cached internally.

Apps are not currently intended to override this logic, instead they can control height of individual rows using a cell renderer. See the snippet below for an example.
```
new Scheduler({
    columns : [
        {
            text  : 'Name',
            field : 'name',
            width : 130,
            renderer({ value, record, size }) {
                // Set your desired height here
                size.height = record.parentIndex % 2 === 0 ? 100 : 40;

                return value;
            }
        }
    ]
});
```
Also note that the height set is used as the base height for the event layout used, for example if stacking two events in a stack layout, the row will be twice as heigh (+ any margins).
Parameters
- record : ResourceModel
  
  Resource record to determine row height for
Returns

Number
:

Desired row height
preCalculateHeightLimit : Number10000

Maximum number of resources for which height is pre-calculated. If you have many events per resource you might want to lower this number to gain some initial rendering performance.

Specify a falsy value to opt out of row height pre-calculation.
lazyLoadingIndicator : Boolean

By default, when the EventStore (and similar stores) is lazy loading, a loading indicator will be displayed just below the timeline headers. Set this to false to prevent this indicator being shown.

Has a corresponding runtime lazyLoadingIndicator property.
readOnly : Booleanfalse

Configure as true to make the scheduler read-only, by disabling any UIs for modifying data.

Note that checks MUST always also be applied at the server side.

Has a corresponding runtime readOnly property.
responsiveLevels : Object<String, Number | String | SchedulerResponsiveLevelConfig>
"Break points" for which responsive config to use.

Each level can be specified as:
- A number representing the width threshold (e.g., 400)
- The string '*' to match all sizes above other thresholds
- A SchedulerResponsiveLevelConfig object with levelWidth and scheduler properties
See the responsive guide for details and examples.
showEventColorPickers : Booleanfalse

If set to true this will show a color field in the EventEdit editor and also a picker in the EventMenu. Both enables the user to choose a color which will be applied to the event bar's background. See EventModel's eventColor config. config.
updateTimelineContextOnScroll : Booleantrue

By default, scrolling the schedule will update the timelineContext to reflect the new currently hovered context. When displaying a large number of events on screen at the same time, this will have a slight impact on scrolling performance. In such scenarios, opt out of this behavior by setting this config to false.

Has a corresponding runtime updateTimelineContextOnScroll property.
allowOverlap : Booleantrue

Set to false if you don't want to allow events overlapping times for any one resource (defaults to true).

Note that toggling this at runtime won't affect already overlapping events.

Has a corresponding runtime allowOverlap property.
autoCreate : Boolean/String/Object
If this config is set, then its gesture property (which defaults to dblclick) creates a new event at the mouse or touch event's time point.

When set to true, the gesture is dblclick, and the new event will have a duration of 1 time axis tick.

This may be specified as the string DOM event name to listen for, such as 'click', 'dblclick' and the new event will have a duration of 1 time axis tick.

The duration of the new event can be set by specifying the duration property as a DurationConfig.

If that is not set, then setting the useEventModelDefaults property will cause the duration to be specified by the default values of the duration and durationUnit fields

Example:
```
new Scheduler({
    autoCreate : {
        gesture  : 'click',
        duration : '2 hours',
        newName  : 'New appointment'
    }
});
```
Parameters
- gesture : 'click'/'dblclick'
  
  The gesture to trigger auto creation of an event. Defaults to dblclick.
- useEventModelDefaults : Boolean
  
  Set to true to set default duration based on the defaults specified by the duration and durationUnit fields.
- snapType : 'round'/'ceil'/'floor'
  
  The type of snapping to apply to the event start date. If omitted, the date will be floored to the time axis resolution.
- step : DurationConfig/String
  
  The increment to snap the event start date to.
- duration : DurationConfig/String
  
  The duration of the event to create. Defaults to 1 time axis tick.
- name : String
  
  The name of the event to create. Defaults to the Object.newEvent property from the locale.
Has a corresponding runtime autoCreate property.
getDateConstraints : Function
A method allowing you to define date boundaries that will constrain resize, create and drag drop operations. The method will be called with the Resource record, and the Event record.
```
 new Scheduler({
     getDateConstraints(resourceRecord, eventRecord) {
         // Assuming you have added these extra fields to your own EventModel subclass
         const { minStartDate, maxEndDate } = eventRecord;

         return {
             start : minStartDate,
             end   : maxEndDate
         };
     }
 });
```
Parameters
- resourceRecord : ResourceModel
  
  The resource record
- eventRecord : EventModel
  
  The event record
Returns

DateConstraint
:

Constraining Object containing start and end constraints. Omitting either will mean that end is not constrained. So you can prevent a resize or move from moving before a certain time while not constraining the end date.

verticalTimeAxisColumn : VerticalTimeAxisColumnConfig

The time axis column config for vertical mode.

Object with VerticalTimeAxisColumn configuration.

This object will be used to configure the vertical time axis column instance.

The config allows configuring the VerticalTimeAxisColumn instance used in vertical mode with any Column options that apply to it.

Example:

new Scheduler({
    mode     : 'vertical',
    features : {
        filterBar : true
    },
    verticalTimeAxisColumn : {
        text  : 'Filter by event name',
        width : 180,
        filterable : {
            // add a filter field to the vertical column access header
            filterField : {
                type        : 'text',
                placeholder : 'Type to search',
                onChange    : ({ value }) => {
                    // filter event by name converting to lowerCase to be equal comparison
                    scheduler.eventStore.filter({
                        filters : event => event.name.toLowerCase().includes(value.toLowerCase()),
                        replace : true
                    });
                }
            }
        }
    },
    ...
});

resourceTimeRangeRenderer : Function

FROM-FEATURE
An empty function by default, but provided so that you can override it. This function is called each time a resource time range is rendered into the schedule. It's called with resourceTimeRangeRecord, resourceRecord, and renderData params.

You should never modify any records inside this method.

By default, the DOM markup of a resource time range bar includes placeholders for 'cls' and 'style'. The cls property is a DomClassList which will be added to the main element. The style property is an inline style declaration for the main element.

IMPORTANT: When returning content, be sure to consider how that content should be encoded to avoid XSS (Cross-Site Scripting) attacks. This is especially important when including user-controlled data such as the event's name. The function encodeHtml as well as xss can be helpful in these cases.
```
resourceTimeRangeRenderer({ resourceTimeRangeRecord, resourceRecord, renderData }) {
    renderData.style = 'color:white'; // You can use inline styles too.

    // Property names with truthy values are added to the resulting elements CSS class.
    renderData.cls.isModified = resourceTimeRangeRecord.isModified;

    // Or, you can treat it as a string, but this is less efficient, especially
    // if your renderer wants to *remove* classes that may be there.
    renderData.cls += ' extra-class';

    return StringHelper.xss`${DateHelper.format(resourceTimeRangeRecord.startDate, 'YYYY-MM-DD')}:
    ${resourceTimeRangeRecord.name}`;
}
```
Added by the ResourceTimeRanges feature, only available when that feature is enabled.
Parameters
- detail : Object
  
  An object containing the information needed to render a ResourceTimeRangeModel.
- resourceTimeRangeRecord : ResourceTimeRangeModel
  
  The resource time range record.
- resourceRecord : ResourceModel
  
  The resource record.
- renderData : Object
  
  An object containing details about the event rendering.
Returns

String/DomConfig/DomConfig[]
:

A simple string, or a DomConfig object describing the markup

Properties

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

isSchedulerBase : Booleantrue

READONLY

static

ADVANCED

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

isHorizontal : Boolean

private

READONLY

Checks if scheduler is in horizontal mode
isVertical : Boolean

private

READONLY

Checks if scheduler is in vertical mode
mode : 'horizontal'/'vertical'

READONLY

Get mode (horizontal/vertical)

Has a corresponding mode config.
dateBounds : Date[]

internal

Returns the date or ranges of included dates as an array. If only the startDate is significant, the array will have that date as its only element. Otherwise, a range of dates is returned as a two-element array with [0] is the startDate and [1] is the lastDate.
eventCount : Number

READONLY

Gets the count of events within a date range between current startDate and endDate.
inheritEventColor : Boolean

Set to true for child nodes in a tree store to inherit their parent´s eventColor

Has a corresponding inheritEventColor config.
lastDate : Date

internal

The last day that is included in the date range. This is different than endDate since that date is not inclusive. For example, an endDate of 2022-07-21 00:00:00 indicates that the time range ends at that time, and so 2022-07-21 is not in the range. In this example, lastDate would be 2022-07-20 since that is the last day included in the range.
listRangeMenu : MenuConfig

READONLY
This property is for use when the Scheduler is used as a Calendar view - a mode.

This property yields a Menu configuration block which encapsulates the range choices which this widget may be set to encapsulate:
- day
- week
- month
- year
- decade
By default a list view adds these choices to the header context menu. An agenda view creates a floating settings button which offers this menu. The property may be used to create a custom UI for changing the range. The value yielded by the default get listRangeMenu() implementation looks like this:
```
{
    items : {
        listRangeDayItem    : {config for DAY range menu item },
        listRangWeekItem    : {config for WEEK range menu item },
        listRangMonthItem   : {config for MONTH range menu item },
        listRangeYearItem   : {config for YEAR range menu item },
        listRangeDecadeItem : {config for DECADE range menu item }
    }
}
```
A subclass can override get listRangeMenu() and mutate the object returned by the super call.

For example, it could delete properties of the items block to limit which ranges may be selected.

Has a corresponding listRangeMenu config.
range : String/DurationConfig

The time range encapsulated by the current date.

When a range is used, changing the date snaps the startDate to the closest starting date of the range. For Example if the range was configured as '1 week' then setting the date to the date of next Wednesday would mean that the startDate would be the start of next week, and an entire week would be encapsulated by this view.

Has a corresponding range config.
transition : Object
Configure UI transitions for various actions in the grid.
- insertRecord : Boolean
  
  Transition record insertions
- removeRecord : Boolean
  
  Transition record removals
- toggleColumn : Boolean
  
  Transition column visibility changes
- expandCollapseColumn : Boolean
  
  Transition parent/group column expand/collapse
- toggleRegion : Boolean
  
  Transition region expand/collapse
- toggleTreeNode : Boolean
  
  Transition tree node expand/collapse
- toggleGroup : Boolean
  
  Transition group expand/collapse
- filterRemoval : Boolean
  
  Transition row removals caused by filtering (under specific conditions)
- removeEvent : Boolean
  
  Transition event removals
- changeEvent : Boolean
  
  Transition event changes
Has a corresponding transition config.
date : Date

The date to display when used as a component of a Calendar.

This is required by the Calendar Mode Interface.

Has a corresponding date config.
shiftIncrement : String/DurationConfig
This property is for use when the Scheduler is used as a Calendar view - a mode - it will have no effect on a Scheduler which is not inside a Calendar.

The time range to move by when next or previous is called.

If not specified, this view moves by its duration in days as derived from its range.

Valid values are:
- day
- week
- month
- year
- decade
This may also be specified as a duration with a magnitude part and a unit part. For example '1m' would mean one month, and '4w' would mean four weeks. See parseDuration for details of syntax.

When using a range of weeks, months, years or decades, then when this widget's date is synced with its owning Calendar's date, this widget's startDate is snapped to the closest start point of the range which encompasses that date.

So if using range : '1w', then setting the date to Thursday, 28th October 2021 would mean that the startDate snaps to Sunday 24th October 2021 (assuming the locale uses Sunday as the week start day).

If configured to use a range of days, no snapping is done. There's no defined start point so the startDate is set to the incoming Calendar date.

Has a corresponding shiftIncrement config.
isSchedulerBase : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of SchedulerBase class, or subclass thereof.
assignmentStore : AssignmentStore

Get/set the event store instance of the backing project.

Has a corresponding assignmentStore config.
assignments : AssignmentModel[]/Object[]

Get/set assignments, applies to the backing project's AssignmentStore.

Has a corresponding assignments config.
dependencies : DependencyModel[]/DependencyModelConfig[]

Get/set dependencies, applies to the backing projects DependencyStore.

Has a corresponding dependencies config.
dependencyStore : DependencyStore

Get/set the dependencies store instance of the backing project.

Has a corresponding dependencyStore config.
eventStore : EventStore

Get/set the event store instance of the backing project.

Has a corresponding eventStore config.
events : EventModel[]/EventModelConfig[]

Get/set events, applies to the backing project's EventStore.

Has a corresponding events config.
resourceStore : ResourceStore

Get/set the resource store instance of the backing project

Has a corresponding resourceStore config.
resources : ResourceModel[]/ResourceModelConfig[]

Get/set resources, applies to the backing project's ResourceStore.

Has a corresponding resources config.
lazyLoadingIndicator : Boolean

By default, when the EventStore (and similar stores) is lazy loading, a loading indicator will be displayed just below the timeline headers. Set this to false to prevent this indicator being shown.

Has a corresponding lazyLoadingIndicator config.
readOnly : Boolean

Get/set the scheduler's read-only state. When set to true, any UIs for modifying data are disabled.

Has a corresponding readOnly config.
updateTimelineContextOnScroll : Booleantrue

By default, scrolling the schedule will update the timelineContext to reflect the new currently hovered context. When displaying a large number of events on screen at the same time, this will have a slight impact on scrolling performance. In such scenarios, opt out of this behavior by setting this config to false.

Has a corresponding updateTimelineContextOnScroll config.
visibleResources : Object

READONLY
Returns an object defining the range of visible resources
- first : ResourceModel
  
  First visible resource
- last : ResourceModel
  
  Last visible resource
allowOverlap : Booleantrue

Set to false if you don't want to allow events overlapping times for any one resource (defaults to true).

Note that toggling this at runtime won't affect already overlapping events.

Has a corresponding allowOverlap config.
autoCreate : Boolean/String/Object
If this config is set, then its gesture property (which defaults to dblclick) creates a new event at the mouse or touch event's time point.

When set to true, the gesture is dblclick, and the new event will have a duration of 1 time axis tick.

This may be specified as the string DOM event name to listen for, such as 'click', 'dblclick' and the new event will have a duration of 1 time axis tick.

The duration of the new event can be set by specifying the duration property as a DurationConfig.

If that is not set, then setting the useEventModelDefaults property will cause the duration to be specified by the default values of the duration and durationUnit fields

Example:
```
new Scheduler({
    autoCreate : {
        gesture  : 'click',
        duration : '2 hours',
        newName  : 'New appointment'
    }
});
```
Has a corresponding autoCreate config.

Functions

Functions are methods available for calling on the class

internalGetAssignmentsToHighlight( )

internal
Internal function to get an array of assignment instances from:
- Single event or assignment instance
- Array of event or assignment instances
- Single event or assignment id (depending on usesSingleAssignment)
- Array of event or assignment ids (depending on usesSingleAssignment)
next( )

Interface method used by an encapsulating Calendar view to implement the "next" button.
previous( )

Interface method used by an encapsulating Calendar view to implement the "prev" button.
isDateRangeAvailable( startDate, endDate, excludeEvent, resourceRecord, allowOverlap )
: Boolean

Checks if a date range is allocated or not for a given resource.
getEvents( options )
: EventModel[]/Map
Returns an array of events for the date range specified by the startDate and endDate options.

By default, for any date, this includes any event which intersects that date.

To only include events that are fully contained within the date range, pass the allowPartial option as false.

By default, any occurrences of recurring events are included in the resulting array (not applicable in Gantt). If that is not required, pass the includeOccurrences option as false.

Note that if includeOccurrences is true, the start date and end date options are mandatory. The method must know what range of occurrences needs to be generated and returned.

Example:
```
 visibleEvents = eventStore.getEvents({
     resourceRecord : myResource,
     startDate      : scheduler.timeAxis.startDate,
     endDate        : scheduler.timeAxis.endDate
 });
```
editEvent( eventRecord, resourceRecord, element )

Opens an editor UI to edit the passed event, or a config object for a new event.

NOTE: Only available when the EventEdit feature is enabled.
resolveDependencyRecord( element )
: DependencyModel

Returns the dependency record for a DOM element

NOTE: Only available when the Dependencies feature is enabled.
refreshResource( resourceRecord )

Triggers a render of all the cells (in horizontal mode) in and event bars for the passed resource.

Since Scheduler uses virtualized resources, calling this method for a resource that is not currently rendered will not have any effect.

Manipulating resource or event records and Scheduler settings refreshes the Scheduler automatically. You should only need to call this function if you have outside data/settings unknown to the Scheduler that has changed and requires the resource to update to reflect the changes
refreshResources( resourceRecords )

Triggers a render of all the cells (in horizontal mode) and event bars for the passed resources. Leave the argument out to refresh all resources.

Since Scheduler uses virtualized resources, calling this method for resources that are not currently rendered will not have any effect.

Manipulating resource or event records and Scheduler settings refreshes the Scheduler automatically. You should only need to call this function if you have outside data/settings unknown to the Scheduler that has changed and requires some resources to update to reflect the changes
resumeRefresh( triggertrue )
: Promise

ASYNC

Resumes UI refresh on store operations.

Multiple calls to suspendRefresh stack up, and will require an equal number of resumeRefresh calls to actually resume UI refresh.

Specify true as the first param to trigger a refresh if this call unblocked the refresh suspension. If the underlying project is calculating changes, the refresh will be postponed until it is done.
createEvent( date, resourceRecord )
: Promise

ASYNC

Creates an event on the specified date which conforms to the autoCreate setting for the specified resource. The event is then scrolled into view.

NOTE: If the scheduler is readonly, or resource type is invalid (group header), or if allowOverlap is false and slot is already occupied - no event is created.

This method may be called programmatically by application code if the autoCreate setting is false, in which case the default values for autoCreate will be used.

If the EventEdit feature is active, the new event will be displayed in the event editor.
onEventCreated( eventRecord )

Called when new event is created. Сan be overridden to supply default record values etc.
scheduleEvent( config )
: Promise

ASYNC

Assigns and schedules an unassigned event record (+ adds it to this Scheduler's event store unless already in it).
showContextMenu( event, alignSpec )
: Promise

ASYNC

Shows the context menu.
copyEvents( records, isCutfalse )
: Promise

ASYNC

FROM-FEATURE

Copy events (when using single assignment mode) or assignments (when using multi assignment mode) to clipboard to paste later

Added by the EventCopyPaste feature, only available when that feature is enabled.

Triggers: beforeCopy, copy
pasteEvents( date, resourceRecord )
: Promise

ASYNC

FROM-FEATURE

Paste events or assignments to specified date and resource

Added by the EventCopyPaste feature, only available when that feature is enabled.

Triggers: beforePaste, paste
resolveResourceTimeRangeRecord( rangeElement )
: ResourceTimeRangeModel

FROM-FEATURE

Returns a resource time range record from the passed element

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
getElementFromResourceTimeRangeRecord( record )
: HTMLElement

FROM-FEATURE

Returns the element for the passed resource time range record, if rendered into DOM.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
startTimelineCellsNavigation( )

FROM-FEATURE

Starts navigating the TimeAxis column cells (if the timeaxis column is focused)

Added by the ScheduleContext feature, only available when that feature is enabled.
stopTimelineCellsNavigation( )

FROM-FEATURE

Stops navigating the TimeAxis column cells

Added by the ScheduleContext feature, only available when that feature is enabled.
split( options )
: Promise

ASYNC

FROM-FEATURE
Split the grid into two or four parts.
- Splits into two when passed direction : 'vertical', direction : 'horizontal' or atColumn or atRecord.
- Splits into four when passed direction : 'both' or atColumn and atRecord.
```
// Split horizontally (at the row in the center of the grid)
await grid.split({ direction : 'horizontal' });

// Split both ways by a specific column and record
await grid.split({
   atRecord : grid.store.getById(10),
   atColumn : grid.columns.get('city')
});
```
To return to a single grid, call unsplit.

Note that this function is callable directly on the grid instance.

Added by the Split feature, only available when that feature is enabled.
unsplit( )
: Promise

ASYNC

FROM-FEATURE

Remove splits, returning to a single grid.

Note that this function is callable directly on the grid instance.

Added by the Split feature, only available when that feature is enabled.
showPrintDialog( )
: Promise

ASYNC

Shows the print dialog
print( config )
: Promise

ASYNC

Starts the print process. Accepts a config object which overrides any default configs. NOTE Component should not be interacted with when print is in progress

Events

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

beforeAutoCreate

ASYNC

PREVENTABLE

This event fires whenever the autoCreate gesture is detected.

This event is preventable and may be used to validate autoCreate-initiated event creation.
beforeEventAdd

PREVENTABLE

Fires before an event is added. Can be triggered by schedule double click or drag create action.
eventAutoCreated

Fired when a double click or drag gesture has created a new event and added it to the event store.
eventKeyDown

Triggered when a keydown event is observed if there are selected events.
eventKeyUp

Triggered when a keyup event is observed if there are selected events.
releaseEvent

Fired after releasing an event, useful to cleanup of custom content added on renderEvent or in eventRenderer.
renderEvent

Fired after rendering an event, when its element is available in DOM.
resourceHeaderClick

Fired when clicking a resource header cell
resourceHeaderContextmenu

Fired when activating context menu on a resource header cell
resourceHeaderDblclick

Fired when double clicking a resource header cell
shiftIncrementChange

Fired when the shiftIncrement of this view changes.
This event is only fired when used as a mode of a Calendar
beforeDependencyCreateDrag

PREVENTABLE

Fired on the owning Scheduler/Gantt before a dependency creation drag operation starts. Return false to prevent it
dependencyCreateDragStart

Fired on the owning Scheduler/Gantt when a dependency creation drag operation starts
dependencyValidationComplete

Fired on the owning Scheduler/Gantt when asynchronous dependency validation completes
dependencyValidationStart

Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
beforeDependencyCreateFinalize

ASYNC

PREVENTABLE

Fired on the owning Scheduler/Gantt when a dependency drag creation operation is about to finalize
dependencyCreateDrop

Fired on the owning Scheduler/Gantt when a dependency drag creation operation succeeds
afterDependencyCreateDrop

Fired on the owning Scheduler/Gantt after a dependency drag creation operation finished, no matter to outcome
beforeShowTerminals

PREVENTABLE

Fired on the owning Scheduler/Gantt before showing dependency terminals on a task or event. Return false to prevent it
dependenciesDrawn

FROM-FEATURE

Fired when dependencies are rendered

Added by the Dependencies feature, only available when that feature is enabled.
dependencyContextMenu

FROM-FEATURE

Fires on the owning Scheduler/Gantt when a context menu event is registered on a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
dependencyClick

FROM-FEATURE

Fires on the owning Scheduler/Gantt when a click is registered on a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
dependencyDblClick

FROM-FEATURE

Fires on the owning Scheduler/Gantt when a double click is registered on a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
dependencyMouseOver

FROM-FEATURE

Fires on the owning Scheduler/Gantt when the mouse moves over a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
dependencyMouseOut

FROM-FEATURE

Fires on the owning Scheduler/Gantt when the mouse moves out of a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
beforeDependencyEditShow

FROM-FEATURE

Fires on the owning Scheduler or Gantt widget when the editor for a dependency is available, but before it is shown. Allows manipulating fields before the widget is shown.

Added by the DependencyEdit feature, only available when that feature is enabled.
beforeDependencyEdit

ASYNC

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler or Gantt widget before an dependency is displayed in the editor. This may be listened for to allow an application to take over dependency editing duties. Return false to stop the default editing UI from being shown or a Promise yielding true or false for async vetoing.

Added by the DependencyEdit feature, only available when that feature is enabled.
beforeDependencySave

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler or Gantt widget before a dependency is saved using the dependency edit popup

Added by the DependencyEdit feature, only available when that feature is enabled.
beforeDependencyAdd

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler or Gantt widget before a dependency is added from the dependency edit popup

Added by the DependencyEdit feature, only available when that feature is enabled.
afterDependencySave

FROM-FEATURE

Fires on the owning Scheduler or Gantt widget after a dependency is successfully saved using the dependency edit popup

Added by the DependencyEdit feature, only available when that feature is enabled.
beforeDependencyDelete

ASYNC

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler or Gantt widget before a dependency is deleted from the dependency edit popup, or when clicking the delete icon on a selected dependency line.

Added by the DependencyEdit feature, only available when that feature is enabled.
contextMenuItem

This event fires on the owning widget when an item is selected in the context menu.
contextMenuToggleItem

This event fires on the owning widget when a check item is toggled in the context menu.
dependencyMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This event fires on the owning Scheduler before the context menu is shown for a dependency. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

Added by the DependencyMenu feature, only available when that feature is enabled.
dependencyMenuItem

FROM-FEATURE

This event fires on the owning Scheduler when an item is selected in the context menu.

Added by the DependencyMenu feature, only available when that feature is enabled.
dependencyMenuShow

FROM-FEATURE

This event fires on the owning Scheduler after showing the context menu for an event

Added by the DependencyMenu feature, only available when that feature is enabled.
copy

FROM-FEATURE

Fires on the owning Scheduler after a copy action is performed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

Added by the EventCopyPaste feature, only available when that feature is enabled.
beforeCopy

ASYNC

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler before a copy action is performed, return false to prevent the action

Added by the EventCopyPaste feature, only available when that feature is enabled.
paste

FROM-FEATURE

Fires on the owning Scheduler after a paste action is performed.

Added by the EventCopyPaste feature, only available when that feature is enabled.
pasteNotAllowed

FROM-FEATURE

Fires on the owning Scheduler if a paste action is not allowed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

Added by the EventCopyPaste feature, only available when that feature is enabled.
beforePaste

ASYNC

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler before a paste action is performed, return false to prevent the action. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

Added by the EventCopyPaste feature, only available when that feature is enabled.
eventDragModeChange

FROM-FEATURE

Triggered when drag mode is changed, for example when copy key is pressed or released while dragging.

Added by the EventDrag feature, only available when that feature is enabled.
beforeEventDropFinalize

FROM-FEATURE
This event is fired on the owning Scheduler after the event drag operation completes, but before changing any data. It allows implementer to use asynchronous validation/finalization by setting context.async = true in the listener, for example, to show a confirmation popup, make async data request etc. In such case, implementer need to call the context.finalize() method manually:
```
 scheduler.on('beforeeventdropfinalize', ({ context }) => {
     context.async = true;
     setTimeout(() => {
         // `true` to perform the drop, `false` to ignore it
         context.finalize(true);
     }, 1000);
 })
```
For synchronous one-time validation, simply set context.valid to true or false.
```
 scheduler.on('beforeeventdropfinalize', ({ context }) => {
     context.valid = false;
 })
```
Added by the EventDrag feature, only available when that feature is enabled.
afterEventDrop

FROM-FEATURE

Fired on the owning Scheduler after event drop

Added by the EventDrag feature, only available when that feature is enabled.
eventDrop

FROM-FEATURE

Fired on the owning Scheduler when an event is dropped

Added by the EventDrag feature, only available when that feature is enabled.
beforeEventDrag

PREVENTABLE

FROM-FEATURE

Fired on the owning Scheduler before event dragging starts. Return false to prevent the action.

Added by the EventDrag feature, only available when that feature is enabled.
eventDragStart

FROM-FEATURE

Fired on the owning Scheduler when event dragging starts

Added by the EventDrag feature, only available when that feature is enabled.
eventDrag

FROM-FEATURE

Fired on the owning Scheduler when event is dragged

Added by the EventDrag feature, only available when that feature is enabled.
eventDragAbort

FROM-FEATURE

Fired on the owning Scheduler after an event drag operation has been aborted

Added by the EventDrag feature, only available when that feature is enabled.
eventDragReset

FROM-FEATURE

Fired on the owning Scheduler after an event drag operation regardless of the operation being cancelled or not

Added by the EventDrag feature, only available when that feature is enabled.
dragCreateEnd

FROM-FEATURE

Fires on the owning Scheduler after the new event has been created.

Added by the EventDragCreate feature, only available when that feature is enabled.
beforeDragCreate

PREVENTABLE

FROM-FEATURE
Fires on the owning Scheduler at the beginning of the drag gesture. Returning false from a listener prevents the drag create operation from starting.
```
const scheduler = new Scheduler({
    listeners : {
        beforeDragCreate({ date }) {
            // Prevent drag creating events in the past
            return date >= Date.now();
        }
    }
});
```
Added by the EventDragCreate feature, only available when that feature is enabled.
dragCreateStart

FROM-FEATURE

Fires on the owning Scheduler after the drag start has created a new Event record.

Added by the EventDragCreate feature, only available when that feature is enabled.
beforeDragCreateFinalize

FROM-FEATURE
Fires on the owning Scheduler to allow implementer to prevent immediate finalization by setting data.context.async = true in the listener, to show a confirmation popup etc.
```
 scheduler.on('beforeDragCreateFinalize', ({context}) => {
     context.async = true;
     setTimeout(() => {
         // async code don't forget to call finalize
         context.finalize();
     }, 1000);
 })
```
Note that at this point the new eventRecord does not yet have the dates set, you can instead find the dates in the context object.

Added by the EventDragCreate feature, only available when that feature is enabled.
afterDragCreate

FROM-FEATURE

Fires on the owning Scheduler at the end of the drag create gesture whether or not a new event was created by the gesture.

Added by the EventDragCreate feature, only available when that feature is enabled.
beforeEventDragSelect

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler before drag selection starts. Return false to prevent the operation.

Added by the EventDragSelect feature, only available when that feature is enabled.
afterEventDragSelect

FROM-FEATURE

Fires on the owning Scheduler after the selection is finished.

Added by the EventDragSelect feature, only available when that feature is enabled.
eventDragSelect

FROM-FEATURE

Fires on the owning Scheduler when the selection area is updated.

Added by the EventDragSelect feature, only available when that feature is enabled.
afterEventEdit

Fires on the owning Scheduler after editor is closed by any action - save, delete or cancel
eventEditBeforeSetRecord

FROM-FEATURE

Fired before the editor will load the event record data into its input fields. This is useful if you want to modify the fields before data is loaded (e.g. set some input field to be readonly)

Added by the EventEdit feature, only available when that feature is enabled.
beforeEventEditShow

FROM-FEATURE

Fires on the owning Scheduler when the editor for an event is available but before it is populated with data and shown. Allows manipulating fields etc.

Added by the EventEdit feature, only available when that feature is enabled.
beforeEventEdit

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler before an event is displayed in an editor. This may be listened for to allow an application to take over event editing duties. Returning false stops the default editing UI from being shown.

Be aware of that when returning false, your app must take care of the eventRecord lifecycle - for example by committing it or removing it from the store.

Added by the EventEdit feature, only available when that feature is enabled.
afterEventSave

FROM-FEATURE

Fires on the owning Scheduler after an event is successfully saved

Added by the EventEdit feature, only available when that feature is enabled.

beforeEventSave

ASYNC

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler before an event is saved. Return false to immediately prevent saving

 scheduler.on({
     beforeEventSave() {
         // prevent saving if some custom variable hasn't 123 value
         return myCustomValue === 123;
     }
 });

or a Promise yielding true or false for async vetoing.

 scheduler.on({
     beforeEventSave() {
         const
             // send ajax request
             response = await fetch('http://my-server/check-parameters.php'),
             data     = await response.json();

         // decide whether it's ok to save based on response "okToSave" property
         return data.okToSave;
     }
 });

Added by the EventEdit feature, only available when that feature is enabled.

eventMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This event fires on the owning Scheduler before the context menu is shown for an event. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

Added by the EventMenu feature, only available when that feature is enabled.
eventMenuItem

FROM-FEATURE

This event fires on the owning Scheduler when an item is selected in the context menu.

Added by the EventMenu feature, only available when that feature is enabled.
eventMenuShow

FROM-FEATURE

This event fires on the owning Scheduler after showing the context menu for an event

Added by the EventMenu feature, only available when that feature is enabled.
beforeEventResize

PREVENTABLE

FROM-FEATURE

Fired on the owning Scheduler before resizing starts. Return false to prevent the action.

Added by the EventResize feature, only available when that feature is enabled.
eventResizeStart

FROM-FEATURE

Fires on the owning Scheduler when event resizing starts

Added by the EventResize feature, only available when that feature is enabled.
eventPartialResize

FROM-FEATURE

Fires on the owning Scheduler on each resize move event

Added by the EventResize feature, only available when that feature is enabled.
beforeEventResizeFinalize

ASYNC

FROM-FEATURE
Fired on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise in the listener, to show a confirmation popup etc
```
 scheduler.on('beforeeventresizefinalize', event => {
     event.async = true;
     setTimeout(() => {
         // async code don't forget to call finalize
         event.finalize();
     }, 1000);
 })
```
Added by the EventResize feature, only available when that feature is enabled.
eventResizeEnd

FROM-FEATURE

Fires on the owning Scheduler after the resizing gesture has finished.

Added by the EventResize feature, only available when that feature is enabled.
timeRangeHeaderClick

Fired on the owning Scheduler or Gantt widget when a click happens on a time range header element
timeRangeHeaderDblClick

Fired on the owning Scheduler or Gantt widget when a double click happens on a time range header element
timeRangeHeaderContextMenu

Fired on the owning Scheduler or Gantt widget when a right click happens on a time range header element
beforePan

PREVENTABLE

FROM-FEATURE

Fires on the owning Scheduler or Gantt widget before pan starts. Return false to prevent the operation.

Added by the Pan feature, only available when that feature is enabled.
resourceColumnBeforeDragStart

PREVENTABLE

FROM-FEATURE

Fired before dragging starts, return false to prevent the drag operation.

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
resourceColumnDragStart

FROM-FEATURE

Fired when dragging starts.

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
resourceColumnDrag

FROM-FEATURE

Fired while the resource column is being dragged. You can signal that the drop position is valid or invalid by setting context.valid = false;

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
resourceColumnBeforeDropFinalize

ASYNC

PREVENTABLE

FROM-FEATURE

Fired before the drop is finalized. You can return false or a Promise that resolves to false to cancel the drop operation.

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
resourceColumnDrop

FROM-FEATURE

Fired after drop

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
resourceColumnDragAbort

FROM-FEATURE

Fired when drag is aborted

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
resourceMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This event fires on the owning scheduler before the context menu is shown for a resource. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Added by the ResourceMenu feature, only available when that feature is enabled.
resourceMenuShow

FROM-FEATURE

This event fires on the owning scheduler after the context menu is shown for a resource.

Added by the ResourceMenu feature, only available when that feature is enabled.
resourceMenuItem

FROM-FEATURE

This event fires on the owning scheduler when an item is selected in the context menu.

Added by the ResourceMenu feature, only available when that feature is enabled.
resourceMenuToggleItem

FROM-FEATURE

This event fires on the owning grid when a check item is toggled in the context menu.

Added by the ResourceMenu feature, only available when that feature is enabled.
resourceTimeRangeMouseDown

FROM-FEATURE

Triggered for mouse down ona resource time range. Only triggered if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
resourceTimeRangeMouseUp

FROM-FEATURE

Triggered for mouse up ona resource time range. Only triggered if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
resourceTimeRangeClick

FROM-FEATURE

Triggered for click on a resource time range. Only triggered if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
resourceTimeRangeDblClick

FROM-FEATURE

Triggered for double-click on a resource time range. Only triggered if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
resourceTimeRangeContextMenu

FROM-FEATURE

Triggered for right-click on a resource time range. Only triggered if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
resourceTimeRangeMouseOver

FROM-FEATURE

Triggered for mouse over on a resource time range. Only triggered if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
resourceTimeRangeMouseOut

FROM-FEATURE

Triggered for mouse out of a resource time range. Only triggered if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
gridRowBeforeDragStart

PREVENTABLE

FROM-FEATURE

Fired before dragging starts, return false to prevent the drag operation.

Added by the RowReorder feature, only available when that feature is enabled.
gridRowDragStart

FROM-FEATURE

Fired when dragging starts.

Added by the RowReorder feature, only available when that feature is enabled.
gridRowDrag

FROM-FEATURE

Fired while the row is being dragged, in the listener function you have access to context.insertBefore a grid / tree record, and additionally context.parent (a TreeNode) for trees. You can signal that the drop position is valid or invalid by setting context.valid = false;

Added by the RowReorder feature, only available when that feature is enabled.
gridRowBeforeDropFinalize

ASYNC

PREVENTABLE

FROM-FEATURE

Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a Promise yielding true / false which allows for asynchronous abort (e.g. first show user a confirmation dialog).

Added by the RowReorder feature, only available when that feature is enabled.
gridRowDrop

FROM-FEATURE

Fired after the row drop operation has completed, regardless of validity

Added by the RowReorder feature, only available when that feature is enabled.
gridRowDragAbort

FROM-FEATURE

Fired when a row drag operation is aborted

Added by the RowReorder feature, only available when that feature is enabled.
beforeContextShow

PREVENTABLE

FROM-FEATURE

This event is fired on the owning Scheduler when the context element or widget is about to be shown.

The position and size of the context element may be mutated by a handler.

If using a widget, the position object will be applied by the widget's setConfig method, so properties may be deleted or added or mutated to affect the widget in any way.

If using a renderer, the position object will be used to size and position the element which is used to highlight the context.

Returning false from a handler will prevent the context element from being shown.

Added by the ScheduleContext feature, only available when that feature is enabled.
beforeSelectedContextsShow

PREVENTABLE

FROM-FEATURE

This event is fired on the owning Scheduler before the selected contexts are rendered. The event is triggered only when multiSelect is enabled

The position and size of the context element may be mutated by a handler.

If using a widget, the position object will be applied by the widget's setConfig method, so properties may be deleted or added or mutated to affect the widget in any way.

If using a renderer, the position object will be used to size and position the element which is used to highlight the context.

Returning false from a handler will prevent the context element from being shown.

Added by the ScheduleContext feature, only available when that feature is enabled.
scheduleMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the schedule. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

Added by the ScheduleMenu feature, only available when that feature is enabled.
scheduleMenuItem

FROM-FEATURE

This event fires on the owning Scheduler or Gantt widget when an item is selected in the context menu.

Added by the ScheduleMenu feature, only available when that feature is enabled.
scheduleMenuShow

FROM-FEATURE

This event fires on the owning Scheduler or Gantt widget after showing the context menu for the schedule.

Added by the ScheduleMenu feature, only available when that feature is enabled.
scrollButtonClick

PREVENTABLE

FROM-FEATURE

Fires on owner when the scroll button is clicked, return false to prevent default scroll behavior

Added by the ScrollButtons feature, only available when that feature is enabled.
split

FROM-FEATURE

Fires when splitting the Grid.

Added by the Split feature, only available when that feature is enabled.
unsplit

FROM-FEATURE

Fires when un-splitting the Grid.

Added by the Split feature, only available when that feature is enabled.
lockRows

FROM-FEATURE

Fires when row locking is enabled.

Added by the LockRows feature, only available when that feature is enabled.
unlockRows

FROM-FEATURE

Fires when row locking is disabled.

Added by the LockRows feature, only available when that feature is enabled.
headerMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This event fires on the owning Grid before the context menu is shown for a header. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
headerMenuShow

FROM-FEATURE

This event fires on the owning Grid after the context menu is shown for a header

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
headerMenuItem

FROM-FEATURE

This event fires on the owning Grid when an item is selected in the header context menu.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
headerMenuToggleItem

FROM-FEATURE

This event fires on the owning Grid when a check item is toggled in the header context menu.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
timeAxisHeaderMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This event fires on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
timeAxisHeaderMenuShow

FROM-FEATURE

This event fires on the owning Scheduler or Gantt widget after the context menu is shown for a header

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
timeAxisHeaderMenuItem

FROM-FEATURE

This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
currentTimelineUpdate

FROM-FEATURE

Fires on the owning Scheduler/Gantt when the line indicating the current time is updated (see currentTimeLineUpdateInterval).

Added by the TimeRanges feature, only available when that feature is enabled.
timeSelectionElementClick

FROM-FEATURE

Triggered when clicking the time selection header element

Added by the TimeSelection feature, only available when that feature is enabled.
timeSelectionChange

FROM-FEATURE

Triggered when time selection changes

Added by the TimeSelection feature, only available when that feature is enabled.
tickCellMouseDown

FROM-FEATURE

Triggered for mouse down on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
tickCellMouseUp

FROM-FEATURE

Triggered for mouse up on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
tickCellClick

FROM-FEATURE

Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
tickCellDblClick

FROM-FEATURE

Triggered for double-click on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
tickCellContextMenu

FROM-FEATURE

Triggered for right-click on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
beforeCSVExport

PREVENTABLE

FROM-FEATURE

Fires on the owning Grid before CSV export starts. Return false to cancel the export.

Added by the ExcelExporter feature, only available when that feature is enabled.
beforeExcelExport

PREVENTABLE

FROM-FEATURE

Fires on the owning Grid before Excel export starts. Return false to cancel the export.

Added by the ExcelExporter feature, only available when that feature is enabled.
beforePdfExport

PREVENTABLE

FROM-FEATURE

Fires on the owning Grid before export started. Return false to cancel the export.

Added by the PdfExport feature, only available when that feature is enabled.
pdfExport

FROM-FEATURE

Fires on the owning Grid when export has finished

Added by the PdfExport feature, only available when that feature is enabled.

Event handlers

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

onBeforeAutoCreate

ASYNC

PREVENTABLE

This handler is called whenever the autoCreate gesture is detected.

This event is preventable and may be used to validate autoCreate-initiated event creation.
onBeforeEventAdd

PREVENTABLE

Called before an event is added. Can be called by schedule double click or drag create action.
onEventAutoCreated

Called when a double click or drag gesture has created a new event and added it to the event store.
onEventKeyDown

Called when a keydown event is observed if there are selected events.
onEventKeyUp

Called when a keyup event is observed if there are selected events.
onReleaseEvent

Called after releasing an event, useful to cleanup of custom content added on renderEvent or in eventRenderer.
onRenderEvent

Called after rendering an event, when its element is available in DOM.
onResourceHeaderClick

Called when clicking a resource header cell
onResourceHeaderContextmenu

Called when activating context menu on a resource header cell
onResourceHeaderDblclick

Called when double clicking a resource header cell
onShiftIncrementChange

Called when the shiftIncrement of this view changes.
This event is only called when used as a mode of a Calendar
onBeforeDependencyCreateDrag

PREVENTABLE

Called on the owning Scheduler/Gantt before a dependency creation drag operation starts. Return false to prevent it
onDependencyCreateDragStart

Called on the owning Scheduler/Gantt when a dependency creation drag operation starts
onDependencyValidationComplete

Called on the owning Scheduler/Gantt when asynchronous dependency validation completes
onDependencyValidationStart

Called on the owning Scheduler/Gantt when asynchronous dependency validation starts
onBeforeDependencyCreateFinalize

ASYNC

PREVENTABLE

Called on the owning Scheduler/Gantt when a dependency drag creation operation is about to finalize
onDependencyCreateDrop

Called on the owning Scheduler/Gantt when a dependency drag creation operation succeeds
onAfterDependencyCreateDrop

Called on the owning Scheduler/Gantt after a dependency drag creation operation finished, no matter to outcome
onBeforeShowTerminals

PREVENTABLE

Called on the owning Scheduler/Gantt before showing dependency terminals on a task or event. Return false to prevent it
onDependenciesDrawn

FROM-FEATURE

Called when dependencies are rendered

Added by the Dependencies feature, only available when that feature is enabled.
onDependencyContextMenu

FROM-FEATURE

Called on the owning Scheduler/Gantt when a context menu event is registered on a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
onDependencyClick

FROM-FEATURE

Called on the owning Scheduler/Gantt when a click is registered on a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
onDependencyDblClick

FROM-FEATURE

Called on the owning Scheduler/Gantt when a double click is registered on a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
onDependencyMouseOver

FROM-FEATURE

Called on the owning Scheduler/Gantt when the mouse moves over a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
onDependencyMouseOut

FROM-FEATURE

Called on the owning Scheduler/Gantt when the mouse moves out of a dependency line.

Added by the Dependencies feature, only available when that feature is enabled.
onBeforeDependencyEditShow

FROM-FEATURE

Called on the owning Scheduler or Gantt widget when the editor for a dependency is available, but before it is shown. Allows manipulating fields before the widget is shown.

Added by the DependencyEdit feature, only available when that feature is enabled.
onBeforeDependencyEdit

ASYNC

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler or Gantt widget before an dependency is displayed in the editor. This may be listened for to allow an application to take over dependency editing duties. Return false to stop the default editing UI from being shown or a Promise yielding true or false for async vetoing.

Added by the DependencyEdit feature, only available when that feature is enabled.
onBeforeDependencySave

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler or Gantt widget before a dependency is saved using the dependency edit popup

Added by the DependencyEdit feature, only available when that feature is enabled.
onBeforeDependencyAdd

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler or Gantt widget before a dependency is added from the dependency edit popup

Added by the DependencyEdit feature, only available when that feature is enabled.
onAfterDependencySave

FROM-FEATURE

Called on the owning Scheduler or Gantt widget after a dependency is successfully saved using the dependency edit popup

Added by the DependencyEdit feature, only available when that feature is enabled.
onBeforeDependencyDelete

ASYNC

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler or Gantt widget before a dependency is deleted from the dependency edit popup, or when clicking the delete icon on a selected dependency line.

Added by the DependencyEdit feature, only available when that feature is enabled.
onContextMenuItem

This handler is called on the owning widget when an item is selected in the context menu.
onContextMenuToggleItem

This handler is called on the owning widget when a check item is toggled in the context menu.
onDependencyMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This handler is called on the owning Scheduler before the context menu is shown for a dependency. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

Added by the DependencyMenu feature, only available when that feature is enabled.
onDependencyMenuItem

FROM-FEATURE

This handler is called on the owning Scheduler when an item is selected in the context menu.

Added by the DependencyMenu feature, only available when that feature is enabled.
onDependencyMenuShow

FROM-FEATURE

This handler is called on the owning Scheduler after showing the context menu for an event

Added by the DependencyMenu feature, only available when that feature is enabled.
onCopy

FROM-FEATURE

Called on the owning Scheduler after a copy action is performed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

Added by the EventCopyPaste feature, only available when that feature is enabled.
onBeforeCopy

ASYNC

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler before a copy action is performed, return false to prevent the action

Added by the EventCopyPaste feature, only available when that feature is enabled.
onPaste

FROM-FEATURE

Called on the owning Scheduler after a paste action is performed.

Added by the EventCopyPaste feature, only available when that feature is enabled.
onPasteNotAllowed

FROM-FEATURE

Called on the owning Scheduler if a paste action is not allowed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

Added by the EventCopyPaste feature, only available when that feature is enabled.
onBeforePaste

ASYNC

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler before a paste action is performed, return false to prevent the action. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

Added by the EventCopyPaste feature, only available when that feature is enabled.
onEventDragModeChange

FROM-FEATURE

Called when drag mode is changed, for example when copy key is pressed or released while dragging.

Added by the EventDrag feature, only available when that feature is enabled.
onBeforeEventDropFinalize

FROM-FEATURE
This event is called on the owning Scheduler after the event drag operation completes, but before changing any data. It allows implementer to use asynchronous validation/finalization by setting context.async = true in the listener, for example, to show a confirmation popup, make async data request etc. In such case, implementer need to call the context.finalize() method manually:
```
 scheduler.on('beforeeventdropfinalize', ({ context }) => {
     context.async = true;
     setTimeout(() => {
         // `true` to perform the drop, `false` to ignore it
         context.finalize(true);
     }, 1000);
 })
```
For synchronous one-time validation, simply set context.valid to true or false.
```
 scheduler.on('beforeeventdropfinalize', ({ context }) => {
     context.valid = false;
 })
```
Added by the EventDrag feature, only available when that feature is enabled.
onAfterEventDrop

FROM-FEATURE

Called on the owning Scheduler after event drop

Added by the EventDrag feature, only available when that feature is enabled.
onEventDrop

FROM-FEATURE

Called on the owning Scheduler when an event is dropped

Added by the EventDrag feature, only available when that feature is enabled.
onBeforeEventDrag

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler before event dragging starts. Return false to prevent the action.

Added by the EventDrag feature, only available when that feature is enabled.
onEventDragStart

FROM-FEATURE

Called on the owning Scheduler when event dragging starts

Added by the EventDrag feature, only available when that feature is enabled.
onEventDrag

FROM-FEATURE

Called on the owning Scheduler when event is dragged

Added by the EventDrag feature, only available when that feature is enabled.
onEventDragAbort

FROM-FEATURE

Called on the owning Scheduler after an event drag operation has been aborted

Added by the EventDrag feature, only available when that feature is enabled.
onEventDragReset

FROM-FEATURE

Called on the owning Scheduler after an event drag operation regardless of the operation being cancelled or not

Added by the EventDrag feature, only available when that feature is enabled.
onDragCreateEnd

FROM-FEATURE

Called on the owning Scheduler after the new event has been created.

Added by the EventDragCreate feature, only available when that feature is enabled.
onBeforeDragCreate

PREVENTABLE

FROM-FEATURE
Called on the owning Scheduler at the beginning of the drag gesture. Returning false from a listener prevents the drag create operation from starting.
```
const scheduler = new Scheduler({
    listeners : {
        beforeDragCreate({ date }) {
            // Prevent drag creating events in the past
            return date >= Date.now();
        }
    }
});
```
Added by the EventDragCreate feature, only available when that feature is enabled.
onDragCreateStart

FROM-FEATURE

Called on the owning Scheduler after the drag start has created a new Event record.

Added by the EventDragCreate feature, only available when that feature is enabled.
onBeforeDragCreateFinalize

FROM-FEATURE
Called on the owning Scheduler to allow implementer to prevent immediate finalization by setting data.context.async = true in the listener, to show a confirmation popup etc.
```
 scheduler.on('beforeDragCreateFinalize', ({context}) => {
     context.async = true;
     setTimeout(() => {
         // async code don't forget to call finalize
         context.finalize();
     }, 1000);
 })
```
Note that at this point the new eventRecord does not yet have the dates set, you can instead find the dates in the context object.

Added by the EventDragCreate feature, only available when that feature is enabled.
onAfterDragCreate

FROM-FEATURE

Called on the owning Scheduler at the end of the drag create gesture whether or not a new event was created by the gesture.

Added by the EventDragCreate feature, only available when that feature is enabled.
onBeforeEventDragSelect

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler before drag selection starts. Return false to prevent the operation.

Added by the EventDragSelect feature, only available when that feature is enabled.
onAfterEventDragSelect

FROM-FEATURE

Called on the owning Scheduler after the selection is finished.

Added by the EventDragSelect feature, only available when that feature is enabled.
onEventDragSelect

FROM-FEATURE

Called on the owning Scheduler when the selection area is updated.

Added by the EventDragSelect feature, only available when that feature is enabled.
onAfterEventEdit

Called on the owning Scheduler after editor is closed by any action - save, delete or cancel
onEventEditBeforeSetRecord

FROM-FEATURE

Called before the editor will load the event record data into its input fields. This is useful if you want to modify the fields before data is loaded (e.g. set some input field to be readonly)

Added by the EventEdit feature, only available when that feature is enabled.
onBeforeEventEditShow

FROM-FEATURE

Called on the owning Scheduler when the editor for an event is available but before it is populated with data and shown. Allows manipulating fields etc.

Added by the EventEdit feature, only available when that feature is enabled.
onBeforeEventEdit

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler before an event is displayed in an editor. This may be listened for to allow an application to take over event editing duties. Returning false stops the default editing UI from being shown.

Be aware of that when returning false, your app must take care of the eventRecord lifecycle - for example by committing it or removing it from the store.

Added by the EventEdit feature, only available when that feature is enabled.
onAfterEventSave

FROM-FEATURE

Called on the owning Scheduler after an event is successfully saved

Added by the EventEdit feature, only available when that feature is enabled.

onBeforeEventSave

ASYNC

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler before an event is saved. Return false to immediately prevent saving

 scheduler.on({
     beforeEventSave() {
         // prevent saving if some custom variable hasn't 123 value
         return myCustomValue === 123;
     }
 });

or a Promise yielding true or false for async vetoing.

 scheduler.on({
     beforeEventSave() {
         const
             // send ajax request
             response = await fetch('http://my-server/check-parameters.php'),
             data     = await response.json();

         // decide whether it's ok to save based on response "okToSave" property
         return data.okToSave;
     }
 });

Added by the EventEdit feature, only available when that feature is enabled.

onEventMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This handler is called on the owning Scheduler before the context menu is shown for an event. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

Added by the EventMenu feature, only available when that feature is enabled.
onEventMenuItem

FROM-FEATURE

This handler is called on the owning Scheduler when an item is selected in the context menu.

Added by the EventMenu feature, only available when that feature is enabled.
onEventMenuShow

FROM-FEATURE

This handler is called on the owning Scheduler after showing the context menu for an event

Added by the EventMenu feature, only available when that feature is enabled.
onBeforeEventResize

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler before resizing starts. Return false to prevent the action.

Added by the EventResize feature, only available when that feature is enabled.
onEventResizeStart

FROM-FEATURE

Called on the owning Scheduler when event resizing starts

Added by the EventResize feature, only available when that feature is enabled.
onEventPartialResize

FROM-FEATURE

Called on the owning Scheduler on each resize move event

Added by the EventResize feature, only available when that feature is enabled.
onBeforeEventResizeFinalize

ASYNC

FROM-FEATURE
Called on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise in the listener, to show a confirmation popup etc
```
 scheduler.on('beforeeventresizefinalize', event => {
     event.async = true;
     setTimeout(() => {
         // async code don't forget to call finalize
         event.finalize();
     }, 1000);
 })
```
Added by the EventResize feature, only available when that feature is enabled.
onEventResizeEnd

FROM-FEATURE

Called on the owning Scheduler after the resizing gesture has finished.

Added by the EventResize feature, only available when that feature is enabled.
onTimeRangeHeaderClick

Called on the owning Scheduler or Gantt widget when a click happens on a time range header element
onTimeRangeHeaderDblClick

Called on the owning Scheduler or Gantt widget when a double click happens on a time range header element
onTimeRangeHeaderContextMenu

Called on the owning Scheduler or Gantt widget when a right click happens on a time range header element
onBeforePan

PREVENTABLE

FROM-FEATURE

Called on the owning Scheduler or Gantt widget before pan starts. Return false to prevent the operation.

Added by the Pan feature, only available when that feature is enabled.
onResourceColumnBeforeDragStart

PREVENTABLE

FROM-FEATURE

Called before dragging starts, return false to prevent the drag operation.

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
onResourceColumnDragStart

FROM-FEATURE

Called when dragging starts.

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
onResourceColumnDrag

FROM-FEATURE

Called while the resource column is being dragged. You can signal that the drop position is valid or invalid by setting context.valid = false;

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
onResourceColumnBeforeDropFinalize

ASYNC

PREVENTABLE

FROM-FEATURE

Called before the drop is finalized. You can return false or a Promise that resolves to false to cancel the drop operation.

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
onResourceColumnDrop

FROM-FEATURE

Called after drop

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
onResourceColumnDragAbort

FROM-FEATURE

Called when drag is aborted

Added by the ResourceColumnReorder feature, only available when that feature is enabled.
onResourceMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This handler is called on the owning scheduler before the context menu is shown for a resource. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Added by the ResourceMenu feature, only available when that feature is enabled.
onResourceMenuShow

FROM-FEATURE

This handler is called on the owning scheduler after the context menu is shown for a resource.

Added by the ResourceMenu feature, only available when that feature is enabled.
onResourceMenuItem

FROM-FEATURE

This handler is called on the owning scheduler when an item is selected in the context menu.

Added by the ResourceMenu feature, only available when that feature is enabled.
onResourceMenuToggleItem

FROM-FEATURE

This handler is called on the owning grid when a check item is toggled in the context menu.

Added by the ResourceMenu feature, only available when that feature is enabled.
onResourceTimeRangeMouseDown

FROM-FEATURE

Called for mouse down ona resource time range. Only called if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
onResourceTimeRangeMouseUp

FROM-FEATURE

Called for mouse up ona resource time range. Only called if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
onResourceTimeRangeClick

FROM-FEATURE

Called for click on a resource time range. Only called if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
onResourceTimeRangeDblClick

FROM-FEATURE

Called for double-click on a resource time range. Only called if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
onResourceTimeRangeContextMenu

FROM-FEATURE

Called for right-click on a resource time range. Only called if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
onResourceTimeRangeMouseOver

FROM-FEATURE

Called for mouse over on a resource time range. Only called if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
onResourceTimeRangeMouseOut

FROM-FEATURE

Called for mouse out of a resource time range. Only called if the ResourceTimeRange feature is configured with enableMouseEvents: true.

Added by the ResourceTimeRanges feature, only available when that feature is enabled.
onGridRowBeforeDragStart

PREVENTABLE

FROM-FEATURE

Called before dragging starts, return false to prevent the drag operation.

Added by the RowReorder feature, only available when that feature is enabled.
onGridRowDragStart

FROM-FEATURE

Called when dragging starts.

Added by the RowReorder feature, only available when that feature is enabled.
onGridRowDrag

FROM-FEATURE

Called while the row is being dragged, in the listener function you have access to context.insertBefore a grid / tree record, and additionally context.parent (a TreeNode) for trees. You can signal that the drop position is valid or invalid by setting context.valid = false;

Added by the RowReorder feature, only available when that feature is enabled.
onGridRowBeforeDropFinalize

ASYNC

PREVENTABLE

FROM-FEATURE

Called before the row drop operation is finalized. You can return false to abort the drop operation, or a Promise yielding true / false which allows for asynchronous abort (e.g. first show user a confirmation dialog).

Added by the RowReorder feature, only available when that feature is enabled.
onGridRowDrop

FROM-FEATURE

Called after the row drop operation has completed, regardless of validity

Added by the RowReorder feature, only available when that feature is enabled.
onGridRowDragAbort

FROM-FEATURE

Called when a row drag operation is aborted

Added by the RowReorder feature, only available when that feature is enabled.
onBeforeContextShow

PREVENTABLE

FROM-FEATURE

This event is called on the owning Scheduler when the context element or widget is about to be shown.

The position and size of the context element may be mutated by a handler.

If using a widget, the position object will be applied by the widget's setConfig method, so properties may be deleted or added or mutated to affect the widget in any way.

If using a renderer, the position object will be used to size and position the element which is used to highlight the context.

Returning false from a handler will prevent the context element from being shown.

Added by the ScheduleContext feature, only available when that feature is enabled.
onBeforeSelectedContextsShow

PREVENTABLE

FROM-FEATURE

This event is called on the owning Scheduler before the selected contexts are rendered. The event is called only when multiSelect is enabled

The position and size of the context element may be mutated by a handler.

If using a widget, the position object will be applied by the widget's setConfig method, so properties may be deleted or added or mutated to affect the widget in any way.

If using a renderer, the position object will be used to size and position the element which is used to highlight the context.

Returning false from a handler will prevent the context element from being shown.

Added by the ScheduleContext feature, only available when that feature is enabled.
onScheduleMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This handler is called on the owning Scheduler or Gantt widget before the context menu is shown for the schedule. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

Added by the ScheduleMenu feature, only available when that feature is enabled.
onScheduleMenuItem

FROM-FEATURE

This handler is called on the owning Scheduler or Gantt widget when an item is selected in the context menu.

Added by the ScheduleMenu feature, only available when that feature is enabled.
onScheduleMenuShow

FROM-FEATURE

This handler is called on the owning Scheduler or Gantt widget after showing the context menu for the schedule.

Added by the ScheduleMenu feature, only available when that feature is enabled.
onScrollButtonClick

PREVENTABLE

FROM-FEATURE

Called on owner when the scroll button is clicked, return false to prevent default scroll behavior

Added by the ScrollButtons feature, only available when that feature is enabled.
onSplit

FROM-FEATURE

Called when splitting the Grid.

Added by the Split feature, only available when that feature is enabled.
onUnsplit

FROM-FEATURE

Called when un-splitting the Grid.

Added by the Split feature, only available when that feature is enabled.
onLockRows

FROM-FEATURE

Called when row locking is enabled.

Added by the LockRows feature, only available when that feature is enabled.
onUnlockRows

FROM-FEATURE

Called when row locking is disabled.

Added by the LockRows feature, only available when that feature is enabled.
onHeaderMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This handler is called on the owning Grid before the context menu is shown for a header. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
onHeaderMenuShow

FROM-FEATURE

This handler is called on the owning Grid after the context menu is shown for a header

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
onHeaderMenuItem

FROM-FEATURE

This handler is called on the owning Grid when an item is selected in the header context menu.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
onHeaderMenuToggleItem

FROM-FEATURE

This handler is called on the owning Grid when a check item is toggled in the header context menu.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
onTimeAxisHeaderMenuBeforeShow

PREVENTABLE

FROM-FEATURE

This handler is called on the owning Scheduler or Gantt widget before the context menu is shown for the time axis header. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
onTimeAxisHeaderMenuShow

FROM-FEATURE

This handler is called on the owning Scheduler or Gantt widget after the context menu is shown for a header

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
onTimeAxisHeaderMenuItem

FROM-FEATURE

This handler is called on the owning Scheduler or Gantt widget when an item is selected in the header context menu.

Added by the TimeAxisHeaderMenu feature, only available when that feature is enabled.
onCurrentTimelineUpdate

FROM-FEATURE

Called on the owning Scheduler/Gantt when the line indicating the current time is updated (see currentTimeLineUpdateInterval).

Added by the TimeRanges feature, only available when that feature is enabled.
onTimeSelectionElementClick

FROM-FEATURE

Called when clicking the time selection header element

Added by the TimeSelection feature, only available when that feature is enabled.
onTimeSelectionChange

FROM-FEATURE

Called when time selection changes

Added by the TimeSelection feature, only available when that feature is enabled.
onTickCellMouseDown

FROM-FEATURE

Called for mouse down on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
onTickCellMouseUp

FROM-FEATURE

Called for mouse up on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
onTickCellClick

FROM-FEATURE

Called for click on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
onTickCellDblClick

FROM-FEATURE

Called for double-click on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
onTickCellContextMenu

FROM-FEATURE

Called for right-click on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

Added by the TreeSummary feature, only available when that feature is enabled.
onBeforeCSVExport

PREVENTABLE

FROM-FEATURE

Called on the owning Grid before CSV export starts. Return false to cancel the export.

Added by the ExcelExporter feature, only available when that feature is enabled.
onBeforeExcelExport

PREVENTABLE

FROM-FEATURE

Called on the owning Grid before Excel export starts. Return false to cancel the export.

Added by the ExcelExporter feature, only available when that feature is enabled.
onBeforePdfExport

PREVENTABLE

FROM-FEATURE

Called on the owning Grid before export started. Return false to cancel the export.

Added by the PdfExport feature, only available when that feature is enabled.
onPdfExport

FROM-FEATURE

Called on the owning Grid when export has finished

Added by the PdfExport feature, only available when that feature is enabled.

Type definitions

DateConstraint
Type containing start and end constraints.
Properties
- start : Date
  
  Start date constraint
- end : Date
  
  End date constraint
SchedulerResponsiveLevelConfig : SchedulerStateInfo
Configuration object for a responsive level. Contains a required levelWidth plus any SchedulerState properties to apply when this level is active.
Properties
- levelWidth : Number/String
  
  The width threshold for this level, or '*' for all sizes above other levels

SchedulerBase
Widget

Useful configs and functions

See also

Configs

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Properties

Functions

Events

Event handlers

Type definitions

Properties

Properties

Source path

Inheritance tree8

Mixins38

Features41

Contents

SchedulerBase Widget

Useful configs and functions

See also

Configs

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Properties

Functions

Events

Event handlers

Type definitions

Properties

Properties

Source path

Inheritance tree8

Mixins38

Features41

Contents

SchedulerBase
Widget