Class: CalendarProxy¶
CalendarProxy is mainly for Calendar operations.
Hierarchy¶
-
CalendarProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Currently none in this class.
Inherited Accessors¶
Methods¶
Class Methods¶
- getCalendarType
- getEventLoadRange
- getEvents
- getEventsOfSelectedDate
- getEventsOfSelectedDateRange
- getIndicators
- getSelectedDate
- getSelectedDateRange
- getTargets
- scrollToDate
- setSelectedDate
- setSelectedDateRange
Inherited Methods¶
- _clientAPIProps
- _getExecuteSource
- base64StringToBinary
- binaryToBase64String
- callFunction
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createFilterCriteria
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCircularImage
- getClientData
- getControl
- getControls
- getDefinitionValue
- getEventData
- getExtensions
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- getGroupHeader
- getHeader
- getIconTextImage
- getLanguage
- getLoadedItemsCount
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getProperty
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTheme
- getType
- getUseInAppCamera
- getVersionInfo
- getVisible
- initializeLogger
- isAppInMultiUserMode
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- isStaticSection
- localizeText
- read
- redraw
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setIndicatorState
- setLanguage
- setMdkWindows
- setRegion
- setTheme
- setUseInAppCamera
- setVisible
- showActivityIndicator
- updateProgressBanner
Constructors¶
Constructor¶
+ new CalendarProxy(context: IContext): CalendarProxy
Overrides SectionProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: CalendarProxy
Methods¶
getCalendarType¶
▸ getCalendarType(): string
Returns the calendar type
Implementation of ICalendarProxy.getCalendarType
Returns: string
getEventLoadRange¶
▸ getEventLoadRange(): number
Implementation of ICalendarProxy.getEventLoadRange
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[]
Implementation of ICalendarProxy.getEvents
Returns: any[]
return array of static events defined for the calendar section.
getEventsOfSelectedDate¶
▸ getEventsOfSelectedDate(): any
Implementation of ICalendarProxy.getEventsOfSelectedDate
Returns: any
return event of selected date if any.
getEventsOfSelectedDateRange¶
▸ getEventsOfSelectedDateRange(): any[]
Implementation of ICalendarProxy.getEventsOfSelectedDateRange
Returns: any[]
return array of events within selected date range.
getIndicators¶
▸ getIndicators(): any[]
Implementation of ICalendarProxy.getIndicators
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
Implementation of ICalendarProxy.getSelectedDate
Returns: Date
getSelectedDateRange¶
▸ getSelectedDateRange(): IDateRangeProxy
Returns the selected date range based on device's local time zone via JavaScript Date Object. Mobile only, not supported on the Web.
Implementation of ICalendarProxy.getSelectedDateRange
Returns: IDateRangeProxy
getTargets¶
▸ getTargets(): any[]
Implementation of ICalendarProxy.getTargets
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): void
Scrolls the calendar to the specified date based on device's local time zone. Mobile only, not supported on the Web. Accepted inputs: - date string in "yyyy-MM-dd" or "yyyy-MM-ddThh:mm:ss" format - JavaScript Date Object.
Implementation of ICalendarProxy.scrollToDate
Parameters:
| Name | Type |
|---|---|
| dateInput | any |
Returns: void
setSelectedDate¶
▸ setSelectedDate(dateInput: any): void
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.
Implementation of ICalendarProxy.setSelectedDate
Parameters:
| Name | Type |
|---|---|
| dateInput | any |
Returns: void
setSelectedDateRange¶
▸ setSelectedDateRange(dateRange: IDateRangeProxy): void
Changes the selected date range in the calendar based on device's local time zone. Mobile only, not supported on the Web.
Implementation of ICalendarProxy.setSelectedDateRange
Parameters:
| Name | Type |
|---|---|
| dateRange | IDateRangeProxy |
Returns: void