SchedulerAppointment

An object that describes an appointment in the Scheduler widget.

Type:

Object

allDay

Specifies whether the appointment lasts all day.

Type:

Boolean

For details on all-day appointments, refer to the Appointment Types article.

component

An alias for the template option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

description

Specifies a detail description of the appointment.

Type:

String

disabled

Specifies whether the appointment responds to user interaction.

Type:

Boolean

Default Value: false

endDate

Specifies the ending of the appointment.

Type:

Date

The startDate and endDate fields are used to position the rectangle representing an appointment in the scheduler.

endDateTimeZone

Specifies the time zone for an appointment's endDate. Applies only if the timeZone option is unspecified.

Type:

String

This option accepts values from the IANA time zone database.

View Demo

See Also

html

Specifies HTML code inserted into the appointment element.

Type:

String

recurrenceException

Specifies exceptions for the current recurring appointment.

Type:

String

To define an exception for a recurring appointment, specify the recurrenceException field in the appointment object. This field enables you to specify several appointments to exclude. Each appointment is specified by the start date and time. The start time of each excluded appointment should strictly match the start time of the initial appointment.

NOTE
This option makes sense only if the appointment recurrenceRule is specified.

For details on recurring appointments, refer to the Appointment Types article.

View Demo

recurrenceRule

Specifies a recurrence rule for generating recurring appointments in the scheduler.

Type:

String

To define a recurring appointment, specify the recurrenceRule field in the appointment object. This field should be set using the iCalendar RFC 2445 specification.

For details on recurring appointments, refer to the Appointment Types article.

View Demo

render

An alias for the template option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

startDate

Specifies the start of the appointment.

Type:

Date

The startDate and endDate fields are used to position the rectangle representing an appointment in the scheduler.

startDateTimeZone

Specifies the time zone for an appointment's startDate. Applies only if the timeZone option is unspecified.

Type:

String

This option accepts values from the IANA time zone database.

View Demo

See Also

template

Specifies a template that should be used to render this appointment only.

Type:

template

Template Data:

undefined

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.
See Also

text

Specifies the subject of the appointment.

Type:

String

The subject will present the appointment in a timetable.

visible

Specifies whether or not an appointment must be displayed.

Type:

Boolean

Default Value: true