React Scheduler Events

This section describes events fired by this widget.

appointmentAdded

Raised after an appointment is added to the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The added appointment's data.
error	JavaScript Error Object	The standard Error object that defines the occurred error.

Main article: onAppointmentAdded

appointmentAdding

Raised before an appointment is added to the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The data of the appointment to be added.
cancel	Boolean \| Promise<Boolean> (jQuery or native)	Allows you to cancel appointment adding. If you pass a Promise to this field, appointment adding is continued or canceled once the Promise has been resolved.

Main article: onAppointmentAdding

appointmentClick

Raised when an appointment is clicked or tapped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The initial appointment.
targetedAppointmentData	Object	The clicked appointment.
appointmentElement	HTMLElement \| jQuery	The clicked appointment's container. It is an HTML Element or a jQuery Element when you use jQuery.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
cancel	Boolean	Allows you to cancel execution of the default appointment click handler.

Main article: onAppointmentClick

appointmentContextMenu

Raised when a user attempts to open the browser's context menu for an appointment.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
appointmentData	Object	The initial appointment.
targetedAppointmentData	Object	The appointment on which the context menu is invoked. For details on the difference between this and the appointmentData fields, see the onAppointmentClick option description.
appointmentElement	HTMLElement \| jQuery	The container of the appointment on which the context menu is invoked. It is an HTML Element or a jQuery Element when you use jQuery.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler's execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler's execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Main article: onAppointmentContextMenu

appointmentDblClick

Raised when an appointment is double-clicked or double-tapped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The initial appointment.
targetedAppointmentData	Object	The clicked appointment.
appointmentElement	HTMLElement \| jQuery	The clicked appointment's container. It is an HTML Element or a jQuery Element when you use jQuery.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
cancel	Boolean	Allows you to cancel execution of the default appointment click handler.

Main article: onAppointmentDblClick

appointmentDeleted

Raised after an appointment is deleted from the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The deleted appointment's data.
error	JavaScript Error Object	The standard Error object that defines the occurred error.

Main article: onAppointmentDeleted

appointmentDeleting

Raised before an appointment is deleted from the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The data of the appointment to be deleted.
cancel	Boolean \| Promise<Boolean> (jQuery or native)	Allows you to prevent the appointment from being deleted. If you pass a Promise to this field, appointment deleting is continued or canceled once the Promise has been resolved.

Main article: onAppointmentDeleting

appointmentFormCreated

Raised before an appointment's details form is opened.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
appointmentData	Object	The data of the appointment for which a form is opened.
form	Form	The form's instance.

Main article: onAppointmentFormCreated

appointmentRendered

Raised when an appointment is rendered.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The initial appointment's data.
targetedAppointmentData	Object	The current appointment's data.
appointmentElement	HTMLElement \| jQuery	The appointment's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onAppointmentRendered

appointmentUpdated

Raised after an appointment is updated in the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
appointmentData	Object	The updated appointment's data.
error	JavaScript Error Object	The standard Error object that defines the occurred error.

Main article: onAppointmentUpdated

appointmentUpdating

Raised before an appointment is updated in the data source.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
oldData	Object	The data of the appointment to be updated.
newData	Object	The appointment with new data.
cancel	Boolean \| Promise<Boolean> (jQuery or native)	Allows you to prevent an appointment update. If you pass a Promise to this field, the appointment updating is continued or canceled once the Promise has been resolved.

Main article: onAppointmentUpdating

cellClick

Raised when a view cell is clicked.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
cellData	Object	The clicked cell's data.
cellElement	HTMLElement \| jQuery	The clicked cell's container. It is an HTML Element or a jQuery Element when you use jQuery.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
cancel	Boolean	Allows you to cancel execution of the default cell click handler.

Main article: onCellClick

cellContextMenu

Raised when a user attempts to open the browser's context menu for a cell.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
cellData	Object	The data of the cell on which the context menu is invoked.
cellElement	HTMLElement \| jQuery	The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler's execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler's execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Main article: onCellContextMenu

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Scheduler

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

The model data. Available only when using Knockout.

Main article: onContentReady.

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Scheduler	The widget instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.

Name

Type

Description

component

Scheduler

The widget instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

The model data. Available only if you use Knockout.

Main article: onDisposing

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Scheduler

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Scheduler	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Main article: onOptionChanged

React Scheduler Events

See Also

appointmentAdded

See Also

appointmentAdding

See Also

appointmentClick

See Also

appointmentContextMenu

See Also

appointmentDblClick

See Also

appointmentDeleted

See Also

appointmentDeleting

See Also

appointmentFormCreated

See Also

appointmentRendered

See Also

appointmentUpdated

See Also

appointmentUpdating

See Also

cellClick

See Also

cellContextMenu

See Also

contentReady

See Also

disposing

See Also

initialized

See Also

optionChanged

See Also