Class: CalendarProxy

Hierarchy

• SectionProxy

• CalendarProxy

Implements

• IClientAPI
• ISectionProxy
• ICalendarProxy

Summary

Constructors

• constructor

Properties

Class Properties

Currently none in this class.

Inherited Properties

• _context

Accessors

Class Accessors

Currently none in this class.

Inherited Accessors

• actionResults

• binding

• currentPage

• dataSubscriptions

• filterTypeEnum

• mdkWindows

• searchString

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

• createLinkSpecifierProxy

• deleteODataCacheImages

• dismissActivityIndicator

• downloadInProgressForPage

• downloadInProgressForReadLink

• evaluateTargetPath

• evaluateTargetPathForAPI

• executeAction

• formatBase64String

• formatCurrency

• formatDate

• formatDatetime

• formatNumber

• formatPercentage

• formatScientific

• formatTime

• getActionResult

• getAppClientData

• getAppEventData

• getAppName

• getAppearanceMode

• getAvailableThemes

• getBindingObject

• getCircularImage

• getClientData

• getControl

• getControls

• getDefinitionValue

• 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

• getVersionInfo

• getVisible

• initializeLogger

• isAppInMultiUserMode

• isCurrentPage

• isDemoMode

• isDeviceCompliant

• isMediaLocal

• isStaticSection

• localizeText

• read

• redraw

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setDebugSettings

• setIndicatorState

• setLanguage

• setRegion

• setTheme

• setVisible

• showActivityIndicator

• updateProgressBanner

• Create

• setMdkWindows

Constructors

constructor

+ new CalendarProxy(context: IContext): CalendarProxy

Overrides SectionProxy.constructor

Parameters:

Name	Type
context	IContext

Returns: CalendarProxy

Methods

getCalendarType

▸ getCalendarType(): string

Implementation of ICalendarProxy

Returns the calendar type

Returns: string

---

getEventLoadRange

▸ getEventLoadRange(): number

Implementation of ICalendarProxy

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

Returns: any[]

return array of all events displayed on the calendar.

---

getEventsOfSelectedDate

▸ getEventsOfSelectedDate(): any

Implementation of ICalendarProxy

Returns: any

return event of selected date if any.

---

getEventsOfSelectedDateRange

▸ getEventsOfSelectedDateRange(): any[]

Implementation of ICalendarProxy

Returns: any[]

return array of events within selected date range.

---

getIndicators

▸ getIndicators(): any[]

Implementation of ICalendarProxy

Returns: any[]

return array of indicators displayed on the calendar.

---

getSelectedDate

▸ getSelectedDate(): Date

Implementation of ICalendarProxy

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

Returns: Date

---

getSelectedDateRange

▸ getSelectedDateRange(): DateRangeProxy

Implementation of ICalendarProxy

Returns the selected date range based on device's local time zone via JavaScript Date Object. Mobile only, not supported on the Web.

Returns: DateRangeProxy

---

getTargets

▸ getTargets(): any[]

Implementation of ICalendarProxy

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

Implementation of ICalendarProxy

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.

Parameters:

Name	Type	Description
dateInput	any

Returns: void

---

setSelectedDate

▸ setSelectedDate(dateInput: any): void

Implementation of ICalendarProxy

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: void

---

setSelectedDateRange

▸ setSelectedDateRange(dateRange: DateRangeProxy): void

Changes the selected date range in the calendar based on device's local time zone. Mobile only, not supported on the Web.

Parameters:

Name	Type	Description
dateRange	DateRangeProxy

Returns: void

---