Calendar.js - Documentation - Custom Triggers
Below is a list of all the custom triggers supported in Calendar.js, which are fired when specific actions occur.
Download Now
Below is a list of all the custom triggers supported in Calendar.js, which are fired when specific actions occur.
Download Now
Fires when an event is about to be added/edited via the Event Editor dialog (stops the Event Editor dialog opening).
Parameter: event: ‘Event’ - The event details (if being edited).
Fires when an event is added.
Parameter: event: ‘Event’ - The event details.
Fires when an event is updated.
Parameter: event: ‘Event’ - The event details.
Fires when an event is removed.
Parameter: event: ‘Event’ - The event details.
Fires when events are added.
Parameter: events: ‘Event[]’ - The array of events.
Fires when events are updated.
Parameter: events: ‘Event[]’ - The array of events.
Fires when events are set (all other events are cleared).
Parameter: events: ‘Event[]’ - The array of events.
Fires when events are set from JSON (all other events are cleared).
Parameter: json: ‘string’ - The JSON.
Fires when events are added from JSON.
Parameter: json: ‘string’ - The JSON.
Fires when events are exported.
Parameter: events: ‘Event[]’ - The array of events.
Fires when events are cleared.
Fires when dragging an event is started.
Parameter: event: ‘Event’ - The event details.
Fires when dragging an event is stopped.
Parameter: event: ‘Event’ - The event details.
Fires when an event that was dragged is dropped on a date.
Parameter: event: ‘Event’ - The event details.
Parameter: targetDate: ‘Object’ - The date the event was dropped on.
Fires when an event is clicked.
Parameter: event: ‘Event’ - The event details.
Fires when an event is double-clicked (only enabled when Editing Mode is disabled).
Parameter: event: ‘Event’ - The event details.
Fires when an event URL is clicked.
Parameter: url: ‘string’ - The URL clicked.
Fires when the calendar refreshes (it will pull an array of events to add, or update).
Returns: ‘Event[]’ - An array of event.
Fires when events are imported.
Parameter: events: ‘Event[]’ - The array of events.
Fires when the Calendar is rendered.
Parameter: id: ‘string’ - The Id of the Calendar.
Fires when the Full Day view renders an event.
Parameter: element: ‘Object’ - The events DOM element that has been added.
Parameter: event: ‘Event’ - The event details.
Returns: ‘boolean’ - States if this event has been custom rendered.
Fires when the Full Week view renders an event.
Parameter: element: ‘Object’ - The events DOM element that has been added.
Parameter: event: ‘Event’ - The event details.
Returns: ‘boolean’ - States if this event has been custom rendered.
Fires when the Full Month view (default) renders an event.
Parameter: element: ‘Object’ - The events DOM element that has been added.
Parameter: event: ‘Event’ - The event details.
Returns: ‘boolean’ - States if this event has been custom rendered.
Fires when the All Events view renders an event.
Parameter: element: ‘Object’ - The events DOM element that has been added.
Parameter: event: ‘Event’ - The event details.
Returns: ‘boolean’ - States if this event has been custom rendered.
Fires when the Timeline view renders an event.
Parameter: element: ‘Object’ - The events DOM element that has been added.
Parameter: event: ‘Event’ - The event details.
Returns: ‘boolean’ - States if this event has been custom rendered.
Fires when the Widget mode renders an event.
Parameter: element: ‘Object’ - The events DOM element that has been added.
Parameter: event: ‘Event’ - The event details.
Returns: ‘boolean’ - States if this event has been custom rendered.
Fires when a tooltip is rendered for an event.
Parameter: tooltip: ‘Object’ - The tooltip DOM element that has been shown.
Parameter: event: ‘Event’ - The event details.
Returns: ‘boolean’ - States if this tooltip has been custom rendered.
Fires when the Full Day view renders its title.
Parameter: dateTime: ‘Object’ - The Date and Time being displayed.
Returns: ‘boolean’ - States if the title has been custom rendered.
Fires when the Full Week view renders its title.
Parameter: weekStartDateTime: ‘Object’ - The Date and Time being displayed for the start of the end.
Parameter: weekStartEndTime: ‘Object’ - The Date and Time being displayed for the end of the week.
Returns: ‘boolean’ - States if the title has been custom rendered.
Fires when the Timeline view renders its title.
Parameter: dateTime: ‘Object’ - The Date and Time being displayed.
Returns: ‘boolean’ - States if the title has been custom rendered.
Fires when the Full Month pin-up is rendered after a month/year change.
Parameter: pinup: ‘Object’ - The pinup DOM element that has been shown.
Parameter: date: ‘Object’ - The Date being displayed.
Returns: ‘boolean’ - States if the pin-up area has been custom rendered.
Fires when the calendar moves to the previous month.
Parameter: date: ‘Object’ - The new display date.
Fires when the calendar moves to the next month.
Parameter: date: ‘Object’ - The new display date.
Fires when the calendar moves to the previous year.
Parameter: date: ‘Object’ - The new display date.
Fires when the calendar moves to the next year.
Parameter: date: ‘Object’ - The new display date.
Fires when the calendar is moved to today’s date.
Fires when the calendar date is set manually.
Parameter: date: ‘Object’ - The new display date.
Fires when all the groups are cleared from the events.
Fires when a specific group is removed.
Parameter: groupName: ‘string’ - The name of the group.
Fires when the configurable options are updated.
Parameter: options: ‘Options’ - The options.events.
Fires when the configurable search options are updated.
Parameter: options: ‘Search’ - The options.events.
Fires when the DatePicker moves to a specific date.
Parameter: date: ‘Object’ - The new display date.
Fires when the DatePicker is opened.
Parameter: id: ‘string’ - The Id of the DatePicker.
Fires when the DatePicker is closed.
Parameter: id: ‘string’ - The Id of the DatePicker.
Fires when the full-screen mode is changed.
Parameter: flag: ‘boolean’ - States if full-screen mode is on.
Fires when the Calendar is destroyed.
Parameter: id: ‘string’ - The Id of the Calendar.
Fires when the Calendar is refreshed.
Fires when the busy state changes.
Parameter: flag: ‘boolean’ - The flag that states if the calendar is busy.
Fires when a browser notification is clicked for an event.
Parameter: event: ‘Event’ - The event details.
Fires when a browser notification is shown for an event.
Parameter: event: ‘Event’ - The event details.
Fires when the visible groups are changed.
Parameter: groupNames: ‘string[]’ - The visible group names.
Fires when the visible groups are changed.
Parameter: eventTypeIds: ‘number[]’ - The visible event type IDs.
Fires when the current view is changed.
Parameter: viewName: ‘string’ - The name ID of the view currently being displayed.