React Scheduler Events

This section describes events fired by this widget.

See Also

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
appointmentData

Object

The added appointment's data.
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.
error

JavaScript Error Object

The standard Error object that defines the occurred error.
model

Object

The model data. Available only if Knockout is used.

Main article: onAppointmentAdded

See Also

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
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.
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.

Main article: onAppointmentAdding

See Also

appointmentClick

Raised when an appointment is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
appointmentData

Object

The initial appointment.
appointmentElement

HTMLElement | jQuery

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

Boolean

Allows you to cancel execution of the default appointment click handler.
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.
event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event 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.
model

Object

The model data. Available only if Knockout is used.
targetedAppointmentData

Object

The clicked appointment.

Main article: onAppointmentClick

See Also

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
appointmentData

Object

The initial appointment.
appointmentElement

HTMLElement | jQuery

The appointment's container. It is an HTML Element or a jQuery Element when you use jQuery.
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.
event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event 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.
model

Object

The model data. Available only if you use Knockout.
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.

Main article: onAppointmentContextMenu

See Also

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
appointmentData

Object

The initial appointment.
appointmentElement

HTMLElement | jQuery

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

Boolean

Allows you to cancel execution of the default appointment click handler.
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.
event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event 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.
model

Object

The model data. Available only if Knockout is used.
targetedAppointmentData

Object

The clicked appointment.

Main article: onAppointmentDblClick

See Also

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
appointmentData

Object

The deleted appointment's data.
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.
error

JavaScript Error Object

The standard Error object that defines the occurred error.
model

Object

The model data. Available only if Knockout is used.

Main article: onAppointmentDeleted

See Also

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
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.
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.

Main article: onAppointmentDeleting

See Also

appointmentFormCreated Deprecated

Use the onAppointmentFormOpening event instead.

Raised before an appointment details form is opened.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
appointmentData

Object

The data of the appointment for which a form is opened.
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.
form

Form

The form's instance; created only once - when the function is executed for the first time.
model

Object

The model data. Available only if you use Knockout.

appointmentFormOpening

Raised before an appointment details form is opened.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
appointmentData

Object

The data of the appointment for which a form is opened.
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.
form

Form

The form's instance; created only once - when the function is executed for the first time.
model

Object

The model data. Available only if you use Knockout.

Main article: onAppointmentFormOpening

See Also

appointmentRendered

Raised when an appointment is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
appointmentData

Object

The initial appointment's data.
appointmentElement

HTMLElement | jQuery

The appointment's container. It is an HTML Element or a jQuery Element when you use jQuery.
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.
targetedAppointmentData

Object

The current appointment's data.

Main article: onAppointmentRendered

See Also

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
appointmentData

Object

The updated appointment's data.
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.
error

JavaScript Error Object

The standard Error object that defines the occurred error.
model

Object

The model data. Available only if Knockout is used.

Main article: onAppointmentUpdated

See Also

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
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.
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.
newData

Object

The appointment with new data.
oldData

Object

The data of the appointment to be updated.

Main article: onAppointmentUpdating

See Also

cellClick

Raised when a view cell is clicked.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel execution of the default cell click handler.
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.
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.
event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event 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.
model

Object

The model data. Available only if Knockout is used.

Main article: onCellClick

See Also

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
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.
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.
event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event 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.
model

Object

The model data. Available only if you use Knockout.

Main article: onCellContextMenu

See Also

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.

See Also

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.

Main article: onDisposing

See Also

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

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model

Object

The model data. Available only if you use Knockout.
fullName

String

The path to the modified option that includes all parent options.
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.
name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value any

The modified option's new value.

Main article: onOptionChanged

See Also