Class: FilterBarProxy¶
FilterBarProxy is mainly for FilterBar operations.
Hierarchy¶
-
FilterBarProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
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
- getDefinitionValue
- getEventData
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- 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
- setMdkWindows
- setRegion
- setTheme
- setUseInAppCamera
- showActivityIndicator
- updateProgressBanner
Constructors¶
Constructor¶
+ new FilterBarProxy(context: IContext): FilterBarProxy
Overrides ElementSectionRowProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: FilterBarProxy
Properties¶
Protected _row¶
• _row: any
Accessors¶
filterBarFilterQuery¶
Get Signature¶
▸ getter
This method returns the filter query options based on filter bar selections
Example¶
// Access filter bar sections from a FilterBarProxy
const tableSectionProxy = context;
const filterBarProxy = tableSectionProxy.getFilterBar();
const filterQuery = filterBarProxy.filterBarFilterQuery;
console.log(`Currently applied query option for filter bar: ${filterQuery}`);
Returns¶
string
Implementation of IFilterBarProxy.filterBarFilterQuery
filterBarSorterQuery¶
Get Signature¶
▸ getter
This method returns the sorter query options based on filter bar selections
Example¶
// Access filter bar sections from a FilterBarProxy
const tableSectionProxy = context;
const filterBarProxy = tableSectionProxy.getFilterBar();
const filters = filterBarProxy.filters;
const sorterQuery = filterBarProxy.filterBarSorterQuery;
console.log(`Currently applied sorter option for filter bar: ${sorterQuery}`);
Returns¶
string
Implementation of IFilterBarProxy.filterBarSorterQuery
filters¶
Get Signature¶
▸ getter
This method returns the filter selections based on filter bar selections
Example¶
// Access filter bar sections from a FilterBarProxy
const tableSectionProxy = context;
const filterBarProxy = tableSectionProxy.getFilterBar();
const filters = filterBarProxy.filters;
console.log(`Total controls with filter applied in the filter bar: ${filters.length}`);
Returns¶
Implementation of IFilterBarProxy.filters
Methods¶
getParent¶
▸ getParent(): IBindableSectionProxy
This method returns BindableSection proxy
Implementation of IFilterBarProxy.getParent Overrides ElementSectionRowProxy.getParent
Returns: IBindableSectionProxy
getSections¶
▸ getSections(): IFilterBarSectionProxy[]
This method returns array of filter bar sections proxy
Implementation of IFilterBarProxy.getSections
Returns: IFilterBarSectionProxy[]
setFilters¶
▸ setFilters(newFilters: FilterSelection[]): Promise<any>
This method sets and overrides the currently applied filters
Implementation of IFilterBarProxy.setFilters
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.