Vue Common - Object Structures - SchedulerAppointment
An object that describes an appointment in the Scheduler widget.
allDay
Specifies whether the appointment lasts all day.
For details on all-day appointments, refer to the Appointment Types article.
component
An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
endDate
Specifies the ending of the appointment.
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.
recurrenceException
Specifies exceptions for the current recurring appointment.
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.
For details on recurring appointments, refer to the Appointment Types article.
recurrenceRule
Specifies a recurrence rule for generating recurring appointments in the scheduler.
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.
render
An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
startDate
Specifies the start of the appointment.
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.
template
Specifies a template that should be used to render this appointment only.
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.
The subject will present the appointment in a timetable.
If you have technical questions, please create a support ticket in the DevExpress Support Center.