Search results

Field

A Class that holds the collection of event fields that requires to be mapped with the dataSource fields along with its available configuration settings. Each field in it accepts both string and Object data type. When each of the field is assigned with simple string value, it is assumed that the dataSource field name is mapped with it. If the object type is defined on each fields, then the validation related settings and mapping of those fields with dataSource can be given altogether within it.

Properties

description

FieldOptionsModel

It maps the description field from the dataSource and denotes the event description which is optional.

Defaults to { name: null, default: null, title: null, validation: {} }

endTime

FieldOptionsModel

The endTime field defines the end time of an event and it is mandatory to provide the end time for any of the valid event objects.

Defaults to { name: null, default: null, title: null, validation: {} }

endTimezone

FieldOptionsModel

It maps the endTimezone field from the dataSource and usually accepts the valid IANA timezone names. It is assumed that the value provided for this field is taken into consideration while processing the endTime field. When this field is not mapped with any timezone names, then the events will be processed based on the timezone assigned to the Schedule.

Defaults to { name: null, default: null, title: null, validation: {} }

id

string

The id field needs to be defined as mandatory, when the Schedule is bound to remote data and it is optional, if the same is bound with JSON data. This field usually assigns ID value to each of the events.

Defaults to null

isAllDay

FieldOptionsModel

The isAllDay field is mapped from the dataSource and is used to denote whether an event is created for an entire day or for specific time alone.

Defaults to { name: null, default: null, title: null, validation: {} }

isBlock

string

The isBlock field allows you to block certain time interval on the Scheduler. It is a boolean type property accepting either true or false values. When set to true, creates a block range for the specified time interval and disables the event scheduling actions on that time range.

Defaults to null

isReadonly

string

The isReadonly field is mapped from the dataSource and is used to prevent the CRUD actions on specific events.

Defaults to null

location

FieldOptionsModel

It maps the location field from the dataSource and the location field value will be displayed over events, while given it for an event object.

Defaults to { name: null, default: null, title: null, validation: {} }

recurrenceException

FieldOptionsModel

It maps the recurrenceException field from dataSource and is used to hold the exception dates which needs to be excluded from recurring type.

Defaults to { name: null, default: null, title: null, validation: {} }

recurrenceID

FieldOptionsModel

It maps the recurrenceID field from dataSource and usually holds the ID value of the parent recurrence event. It is applicable only for the edited occurrence events.

Defaults to { name: null, default: null, title: null, validation: {} }

recurrenceRule

FieldOptionsModel

It maps the recurrenceRule field from dataSource and is used to uniquely identify whether the event belongs to a recurring event type or normal ones.

Defaults to { name: null, default: null, title: null, validation: {} }

startTime

FieldOptionsModel

The startTime field defines the start time of an event and it is mandatory to provide it for any of the valid event objects.

Defaults to { name: null, default: null, title: null, validation: {} }

startTimezone

FieldOptionsModel

It maps the startTimezone field from the dataSource and usually accepts the valid IANA timezone names. It is assumed that the value provided for this field is taken into consideration while processing the startTime field. When this field is not mapped with any timezone names, then the events will be processed based on the timezone assigned to the Schedule.

Defaults to { name: null, default: null, title: null, validation: {} }

subject

FieldOptionsModel

The subject field is optional, and usually assigns the subject text to each of the events.

Defaults to { name: null, default: ‘Add title’, title: null, validation: {} }