Interface: IFilterBarProxy¶
FilterBarProxy is mainly for FilterBar operations.
Remarks¶
Use this proxy to read FilterBar sections and navigate to their controls.
Hierarchy¶
-
IFilterBarProxy
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
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setLanguage
- setRegion
- setTheme
- setUseInAppCamera
- showActivityIndicator
- updateProgressBanner
Accessors¶
filterBarFilterQuery¶
Get Signature¶
▸ getter
Get the active filter query string generated from current FilterBar selections.
Remarks¶
Returns the query expression that is currently applied as filter criteria.
Example¶
const filterBarProxy = context;
const filterQuery = filterBarProxy.filterBarFilterQuery;
console.log(`Current FilterBar filter query: ${filterQuery}`);
Returns¶
string
filterBarSorterQuery¶
Get Signature¶
▸ getter
Get the active sorter query string generated from current FilterBar selections.
Remarks¶
Returns the orderBy expression that is currently applied.
Example¶
const filterBarProxy = context;
const sorterQuery = filterBarProxy.filterBarSorterQuery;
console.log(`Current FilterBar sorter query: ${sorterQuery}`);
Returns¶
string
filters¶
Get Signature¶
▸ getter
Get current filter selections represented by the FilterBar controls.
Remarks¶
Includes only controls that currently contribute a selection.
Example¶
const filterBarProxy = context;
const filters = filterBarProxy.filters;
console.log(`Selected filter count: ${filters.length}`);
Returns¶
Methods¶
getParent¶
▸ getParent(): IBindableSectionProxy
Get the parent section proxy for this FilterBar.
Returns: IBindableSectionProxy
Remarks¶
The parent is the section that owns the FilterBar.
Overrides ISectionRowElementProxy.getParent
getSections¶
▸ getSections(): IFilterBarSectionProxy[]
Get all sections of this FilterBar.
Returns: IFilterBarSectionProxy[]
Remarks¶
Each section contains a group of FilterBar controls.
setFilters¶
▸ setFilters(newFilters: FilterSelection[]): Promise<any>
This method sets and overrides the currently applied filters
Parameters:
| Name | Type | Description |
|---|---|---|
| newFilters | FilterSelection[] | An array of filter selection objects to be applied to the filter bar. Each entry should include the control name, and value. |
Returns: Promise<any>
A promise that resolves when the filters have been applied and the filter bar has been updated.