Interface SchedulerTemplates

public agenda_date(start: Date, end: Date): string

specifies the date in the header of the view

Parameters

• start: Date

  the start date of the view

• end: Date

  the end date of the view

Returns

string

public agenda_text(start: Date, end: Date, event: any): string

specifies the text in the second column of the Agenda view

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public agenda_time(start: Date, end: Date, event: any): string

specifies the date in the first column of the Agenda view

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public api_date(date: Date): string

specifies the format for dates that are set by means of API methods. Used to parse incoming dates

Parameters

• date: Date

  the date which needs formatting

Returns

string

public calendar_date(date: Date): string

specifies the format of the day in a cell

Parameters

• date: Date

  the cell date

Returns

string

public calendar_month(date: Date): string

specifies the date in the header of the calendar

Parameters

• date: Date

  the date which needs formatting

Returns

string

public calendar_scale_date(date: Date): string

specifies the day name in the week sub-header of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public calendar_time(date: Date): string

specifies the date format of the lightbox start and end date inputs

Parameters

• date: Date

  the date which needs formatting

Returns

string

public day_date(date: Date): string

specifies the date in the header of the Day and Units views

Parameters

• date: Date

  the date which needs formatting

Returns

string

public day_scale_date(date: Date): string

specifies the date in the sub-header of the Day view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public event_bar_date(start: Date, end: Date, event: any): string

specifies the date of an event. Applied to one-day events only

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public event_bar_text(start: Date, end: Date, event: any): string

specifies the event text. Applied to all events

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public event_class(start: Date, end: Date, event: any): string

specifies the css style for the event container

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public event_date(date: Date): string

specifies the time part of the start and end dates of the event. Mostly used by other templates for presenting time periods

Parameters

• date: Date

  the date which needs formatting

Returns

string

public event_header(start: Date, end: Date, event: any): string

specifies the event header

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public event_text(start: Date, end: Date, event: any): string

specifies the event text

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public grid_date(start: Date, end: Date): string

specifies the date in the header of the view

Parameters

• start: Date

  the start date of the view

• end: Date

  the end date of the view

Returns

string

public grid_field(field_name: string, event: any): string

specifies the text in the columns

Parameters

• field_name: string

  the column id

• event: any

  the event object

Returns

string

public grid_full_date(start: Date, end: Date, ev: any): string

specifies the format of dates in columns with id='date'

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• ev: any

  the event object

Returns

string

public grid_single_date(date: Date): string

specifies the format of dates in columns with id='start_date' or id='end_date'

Parameters

• date: Date

  the date which needs formatting

Returns

string

public hour_scale(date: Date): string

specifies the items of the Y-Axis

Parameters

• date: Date

  the date which needs formatting

Returns

string

public lightbox_header(start: Date, end: Date, event: any): string

specifies the lightbox header

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public load_format(date: Date): string

specifies the format of requests in the dynamic loading mode

Parameters

• date: Date

  the date which needs formatting

Returns

string

public map_date(start: Date, end: Date): string

specified the date in the header of the view

Parameters

• start: Date

  the start date of the view

• end: Date

  the end date of the view

Returns

string

public map_text(start: Date, end: Date, event: any): string

specifies the text in the second column of the view

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public map_time(start: Date, end: Date, event: any): string

specifies the date in the first column of the view

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public marker_date(start: Date, end: Date, event: any): string

specifies the date of the event in the Google Maps popup marker

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public marker_text(start: Date, end: Date, event: any): string

specifies the text of the event in the Google Maps popup marker

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public month_date(date: Date): string

specifies the date in the header of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public month_date_class(start: Date, end: Date, event: any): string

specifies the css class that will be applied to a day cell

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public month_day(date: Date): string

specifies the format of the day in a cell

Parameters

• date: Date

  the date which needs formatting

Returns

string

public month_events_link(date: Date, count: number): string

specifies the presentation of the 'View more' link in the cell of the Month view

Parameters

• date: Date

  the date of a month cell

• count: number

  the number of events in the cell

Returns

string

public month_scale_date(date: Date): string

specifies the date format of the X-Axis of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public quick_info_content(start: Date, end: Date, event: any): string

specifies the content of the pop-up edit form

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public quick_info_date(start: Date, end: Date, event: any): string

specifies the date of the pop-up edit form

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public quick_info_title(start: Date, end: Date, event: any): string

specifies the title of the pop-up edit form

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public time_picker(): string

specifies the drop-down time selector in the lightbox

Returns

string

public timeline_cell_class(evs: any, date: Date, section: any): string

specifies the css style for a cell of the view

Parameters

• evs: any

  an array of objects of events contained in a cell (defined only in the 'cell' mode)

• date: Date

  the date of a column

• section: any

  the section object

Returns

string

public timeline_cell_value(evs: any): string

specifies the number of scheduled events in a cell of the view

Parameters

• evs: any

  an array of objects of events contained in a cell

Returns

string

public timeline_date(date1: Date, date2: Date): string

specifies the date in the header of the view

Parameters

• date1: Date

  the date when an event is scheduled to begin

• date2: Date

  the date when an event is scheduled to be completed

Returns

string

public timeline_scale_date(date: Date): string

specifies items of the X-Axis

Parameters

• date: Date

  the date which needs formatting

Returns

string

public timeline_scale_label(key: string, label: string, section: any): string

specifies items of the Y-Axis

Parameters

• key: string

  the section id (key)

• label: string

  the section label

• section: any

  the section object containing the key and label properties

Returns

string

public timeline_scalex_class(date: Date): string

specifies the name of a CSS class that will be applied to items of the X-Axis

Parameters

• date: Date

  the date which needs formatting

Returns

string

public timeline_scaley_class(key: string, label: string, section: any): string

specifies the name of a CSS class that will be applied to items of the Y-Axis

Parameters

• key: string

  the section id

• label: string

  the section label

• section: any

  the section object that contains the key and label properties

Returns

string

public timeline_second_scale_date(date: Date): string

specifies items of the second X-Axis

Parameters

• date: Date

  the date which needs formatting

Returns

string

public timeline_second_scalex_class(date: Date): string

specifies the name of a CSS class that will be applied to items of the second X-Axis

Parameters

• date: Date

  the date which needs formatting

Returns

string

public timeline_tooltip(start: Date, end: Date, event: any): string

specifies the tooltip over a day cell containing some scheduled event(s)

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public tooltip_date_format(date: Date): string

specifies the format of start and end dates displayed in the tooltip

Parameters

• date: Date

  the date which needs formatting

Returns

string

public tooltip_text(start: Date, end: Date, event: any): string

specifies the text of tooltips

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public units_date(date: Date): string

specifies the date in the header of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public units_scale_text(key: string, label: string, unit: any): string

specifies items of the X-Axis

Parameters

• key: string

  the unit id (key)

• label: string

  the unit label

• unit: any

  the unit object containing the key and label properties

Returns

string

public week_agenda_event_text(start: Date, end: Date, event: any, cellDate: Date, pos: string): string

specifies the event text

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

• cellDate: Date

  the date of a day cell that an one-day event or a single occurrence of the recurring event displayes in

• pos: string

  the position a single occurrence in the recurring event: 'start' - the first occurrence, 'end' - the last occurrence, 'middle' - for remaining occurrences

Returns

string

public week_agenda_scale_date(date: Date): string

the date of a day cell of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public week_date(start: Date, end: Date): string

specified the date in the header of the view

Parameters

• start: Date

  the start date of the view

• end: Date

  the end date of the view

Returns

string

public week_date_class(start: Date, end: Date, event: any): string

specifies the css class that will be applied to a day cell

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string

public week_scale_date(date: Date): string

specifies the date in the sub-header of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public xml_date(date: Date): Date

a string from an XML file is converted into a date object in conformity with this template

Parameters

• date: Date

  the string which need to be parsed

Returns

Date

public xml_format(date: Date): string

a date object is converted into a string in conformity with this template. Used to send data back to the server

Parameters

• date: Date

  the date which needs formatting

Returns

string

public year_date(date: Date): string

specifies the date in the header of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public year_month(date: Date): string

specifies the month name in the header of a month block of the view.

Parameters

• date: Date

  the date which needs formatting

Returns

string

public year_scale_date(date: Date): string

specifies the day name in the sub-header of a month block of the view

Parameters

• date: Date

  the date which needs formatting

Returns

string

public year_tooltip(start: Date, end: Date, event: any): string

specifies the tooltip over a day cell containing some scheduled event(s)

Parameters

• start: Date

  the date when an event is scheduled to begin

• end: Date

  the date when an event is scheduled to be completed

• event: any

  the event object

Returns

string