Interface: ICalendarProxy¶

A ICalendarProxy can get/set the section's calendar dates, as well as scroll to a given date.

Hierarchy¶

ISectionProxy
ICalendarProxy

Implemented by¶

CalendarProxy

Summary¶

Properties¶

Class Properties¶

Currently none in this class.

Inherited Properties¶

Methods¶

Class Methods¶

Inherited Methods¶

Methods¶

getCalendarType¶

▸ getCalendarType(): string

Returns the calendar type

Returns: string

getEventLoadRange¶

▸ getEventLoadRange(): number

Returns: number

returns number of months before and after the currently selected month to load events. This is used to optimize the loading of events in the calendar. For example, if set to 1, events for the current month, the previous month, and the next month will be loaded. If set to 2, events for the current month, the two previous months, and the two next months will be loaded. This property is only applicable when CalendarType is set to Month. If set to 0, all events will be loaded..

getEvents¶

▸ getEvents(): any[]

Returns: any[]

return array of all events displayed on the calendar.

getEventsOfSelectedDate¶

▸ getEventsOfSelectedDate(): any

Returns: any

return event of selected date if any.

getEventsOfSelectedDateRange¶

▸ getEventsOfSelectedDateRange(): any[]

Returns: any[]

return array of events within selected date range.

getIndicators¶

▸ getIndicators(): any[]

Returns: any[]

return array of indicators displayed on the calendar.

getSelectedDate¶

▸ getSelectedDate(): Date

Returns the selected date based on device's local time zone via JavaScript Date Object

Returns: Date

getSelectedDateRange¶

▸ getSelectedDateRange(): any

Returns the selected date range based on device's local time zone via JavaScript Date Object

Returns: any

getTargets¶

▸ getTargets(): any[]

Returns: any[]

return array of targets to be used for the calendar section. Each target is represented by a binding or rule that returns an array of data items. The calendar will use these targets to populate the events and execute the rules defined in the Event/IndicatorName to determine the events in the calendar.

scrollToDate¶

▸ scrollToDate(dateInput: any): any

Scrolls the calendar to the specified date based on device's local time zone. Accepted values: date string in "yyyy-MM-dd" or "yyyy-MM-ddThh:mm:ss" format, JavaScript Date Object.

Parameters:

Name	Type	Description
`dateInput`	any

Returns: any

setSelectedDate¶

▸ setSelectedDate(dateInput: any): any

Changes the selected date in the calendar based on device's local time zone. Accepted inputs: date string in "yyyy-MM-dd" or "yyyy-MM-ddThh:mm:ss" format, JavaScript Date Object.

Parameters:

Name	Type	Description
`dateInput`	any

Returns: any

setSelectedDateRange¶

▸ setSelectedDateRange(startDate: any, endDate: any): any

Changes the selected date range in the calendar based on device's local time zone. Accepted inputs: date string in "yyyy-MM-dd" or "yyyy-MM-ddThh:mm:ss" format, JavaScript Date Object.

Parameters:

Name	Type	Description
`startDate`	any	Accepted inputs: date string in "yyyy-MM-dd" or "yyyy-MM-ddThh:mm:ss" format, JavaScript Date Object.
`endDate`	any

Returns: any