Interface: IFilterBarControlProxy¶
FilterBarControlProxy is mainly for operations of controls on a FilterBar.
Remarks¶
This is the base proxy for all FilterBar control types.
Hierarchy¶
-
IFilterBarControlProxy
- IFilterBarMultiSorterControlProxy
- IFilterBarSwitchControlProxy
- IFilterBarSliderControlProxy
Summary¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Methods¶
Class Methods¶
Inherited Methods¶
- 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
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCircularImage
- getClientData
- getDefinitionValue
- getEventData
- getGlobalDefinition
- getIconTextImage
- getIndex
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSectionProxy
- getSupportedLanguages
- getTheme
- getType
- getUseInAppCamera
- getVersionInfo
- initializeLogger
- isAppInMultiUserMode
- isCrashReportingEnabled
- isCurrentCrashConsentAllowed
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setLanguage
- setRegion
- setTheme
- setUseInAppCamera
- showActivityIndicator
- showCrashConsentDialog
- updateProgressBanner
Methods¶
getDisplayOnBar¶
▸ getDisplayOnBar(): boolean
Get whether this control should appear on the FilterBar header.
Returns: boolean
whether the control is shown on the bar
Remarks¶
This flag is metadata-driven and may default to true.
getLabel¶
▸ getLabel(): string
Get control label.
Returns: string
control label
getParent¶
▸ getParent(): IFilterBarSectionProxy
Get the parent FilterBar section proxy.
Returns: IFilterBarSectionProxy
Remarks¶
The parent section groups related FilterBar controls.
Overrides ISectionRowElementProxy.getParent
getSectionProxy¶
▸ getSectionProxy(): IBindableSectionProxy
Get the section proxy that owns this FilterBar.
Returns: IBindableSectionProxy
Remarks¶
This is the table/collection section where the FilterBar is defined.
Overrides ISectionRowElementProxy.getSectionProxy
getSimpleQuery¶
▸ getSimpleQuery(): any
Get the simple query configuration associated with this control.
Returns: any
the simple query object
Remarks¶
Returns the metadata-defined simple query object (for example property/operator) used for query generation.
getValue¶
▸ getValue(): any
Get current control value.
Returns: any
the current value
Remarks¶
Value type depends on control type and metadata definition.