Class: BindableSectionProxy¶
A BindableSectionProxy can get/set the section's target.
It is passed to rules to provide access to a section's target for application specific customizations.
Hierarchy¶
-
BindableSectionProxy
- ObjectCardCollectionProxy
- DataTableProxy
- ExtensionSectionProxy
- ObjectCollectionProxy
- ObjectHeaderProxy
- CardCollectionProxy
- SimplePropertyCollectionProxy
- KeyValueCollectionProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
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
- 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 BindableSectionProxy(context: IContext): BindableSectionProxy
Overrides SectionProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: BindableSectionProxy
Accessors¶
filterBarFilterQuery¶
Get Signature¶
▸ getter
This method returns the filter query options based on filter bar selections
Example¶
// Access filter bar sections from a table section proxy
const filterQuery = tableSectionProxy.filterBarFilterQuery;
console.log(`Currently applied query option for filter bar: ${filterQuery}`);
Returns¶
string
Implementation of IBindableSectionProxy.filterBarFilterQuery
filterBarSorterQuery¶
Get Signature¶
▸ getter
This method returns the sorter query options based on filter bar selections
Example¶
// Access filter bar sections from a table section proxy
const sorterQuery = tableSectionProxy.filterBarSorterQuery;
console.log(`Currently applied sorter option for filter bar: ${sorterQuery}`);
Returns¶
string
Implementation of IBindableSectionProxy.filterBarSorterQuery
filters¶
Get Signature¶
▸ getter
This method returns the filter selections based on filter bar selections
Example¶
// Access filter bar sections from a table section proxy
const filters = tableSectionProxy.filters;
console.log(`Total controls with filter applied in the filter bar: ${filters.length}`);
Returns¶
Implementation of IBindableSectionProxy.filters
Methods¶
getFilterBar¶
▸ getFilterBar(): IFilterBarProxy
Get a filter bar from this section
Implementation of IBindableSectionProxy.getFilterBar
Returns: IFilterBarProxy
getTargetSpecifier¶
▸ getTargetSpecifier(): ITargetProxy
Get a target specifier from this section
Implementation of IBindableSectionProxy.getTargetSpecifier
Returns: ITargetProxy
setFilters¶
▸ setFilters(newFilters: FilterSelection[]): Promise<any>
This method sets and overrides the currently applied filters
Implementation of IBindableSectionProxy.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>
setTargetSpecifier¶
▸ setTargetSpecifier(specifier: ITargetProxy, redraw?: boolean = true): Promise<any>
Set the section target specifier
Implementation of IBindableSectionProxy.setTargetSpecifier
Parameters:
| Name | Type | Description |
|---|---|---|
| specifier | ITargetProxy | target specifier for the section |
| redraw? | boolean = true | whether to redraw the section |
Returns: Promise<any>