Class: SectionProxy¶
SectionProxy is a developer-facing class that provides access to a section within sectioned table for application specific customizations.
Hierarchy¶
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
- _getExecuteSource
- getControl
- getControls
- getExtensions
- getGroupHeader
- getHeader
- getLoadedItemsCount
- getName
- getPageProxy
- getParent
- getProperty
- getType
- getVisible
- isStaticSection
- redraw
- setIndicatorState
- setVisible
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
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTheme
- getUseInAppCamera
- getVersionInfo
- initializeLogger
- isAppInMultiUserMode
- isCrashReportingEnabled
- isCurrentCrashConsentAllowed
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setLanguage
- setMdkWindows
- setRegion
- setTheme
- setUseInAppCamera
- showActivityIndicator
- showCrashConsentDialog
- updateProgressBanner
Constructors¶
Constructor¶
+ new SectionProxy(context: IContext): SectionProxy
Overrides ClientAPI.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: SectionProxy
Accessors¶
dataSubscriptions¶
Get Signature¶
▸ getter
Get the section dataSubscription array
Returns¶
string[]
Set Signature¶
▸ setter
Set the section dataSubscriptions
Parameters¶
dataSubscriptions¶
string[]
Returns¶
void
Get or set the dataSubscriptions property for this section. The dataSubScriptions array contains entitySets names or services names
Implementation of ISectionProxy.dataSubscriptions
searchString¶
Get Signature¶
▸ getter
get the search string
Returns¶
string
Get the searchString property for this section.
Implementation of ISectionProxy.searchString
Methods¶
Protected _getExecuteSource¶
▸ _getExecuteSource(): ExecuteSource
Overrides ClientAPI._getExecuteSource
Returns: ExecuteSource
getControl¶
▸ getControl(name: string): IControlProxy
Find a control based on the name. It returns FormCell controls in section.
Implementation of ISectionProxy.getControl
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | the name of the control to match |
Returns: IControlProxy
ControlProxy instance or undefined if not found
getControls¶
▸ getControls(): IControlProxy[]
Get the list of controls in the Section if it is a FormCell Section.
Implementation of ISectionProxy.getControls
Returns: IControlProxy[]
getExtensions¶
▸ getExtensions(): IView[]
Returns the extensions the section is using. Deprecated and will always return an empty array.
Implementation of ISectionProxy.getExtensions
Returns: IView[]
getGroupHeader¶
▸ getGroupHeader(): IGroupHeaderProxy
This method returns the group header in this section if it is ObjectTable section
Implementation of ISectionProxy.getGroupHeader
Returns: IGroupHeaderProxy
The group header for this container
getHeader¶
▸ getHeader(): ISectionHeaderProxy
Get the section header proxy of associated section
Implementation of ISectionProxy.getHeader
Returns: ISectionHeaderProxy
Returns the section header proxy of associated section
getLoadedItemsCount¶
▸ getLoadedItemsCount(): number
This method returns the number of loaded items in the section.
Implementation of ISectionProxy.getLoadedItemsCount
Returns: number
getName¶
▸ getName(): string
Get the section name
Implementation of ISectionProxy.getName
Returns: string
getPageProxy¶
▸ getPageProxy(): IPageProxy
Return the page proxy, which the SectionedTable belongs to
Implementation of ISectionProxy.getPageProxy
Returns: IPageProxy
getParent¶
▸ getParent(): IPageProxy
Return the page proxy, which the SectionedTable belongs to
Returns: IPageProxy
getProperty¶
▸ getProperty(): string
Get the property name being bound, one of the property names in a section definition
Implementation of ISectionProxy.getProperty
Returns: string
getType¶
▸ getType(): string
Get the section type
Implementation of ISectionProxy.getType
Returns: string
getVisible¶
▸ getVisible(): boolean
Get the section visible property
Implementation of ISectionProxy.getVisible
Returns: boolean
isStaticSection¶
▸ isStaticSection(): boolean
The bound object type, if true binding object is definition
Implementation of ISectionProxy.isStaticSection
Returns: boolean
redraw¶
▸ redraw(fullSection?: boolean = false): Promise<any>
Redraw the section
Implementation of ISectionProxy.redraw
Parameters:
| Name | Type | Description |
|---|---|---|
| fullSection? | boolean = false | false whether redraw full section or redraw on update items only |
Returns: Promise<any>
setIndicatorState¶
▸ setIndicatorState(newState: string, pressedItem: PressedItem): any
Set the interacting object cell indicator's state in the section
Implementation of ISectionProxy.setIndicatorState
Parameters:
| Name | Type | Description |
|---|---|---|
| newState | string | the new state of the indicator (possible values: toDownload, inProgress, open) |
| pressedItem | PressedItem | the pressed object cell in the section |
Returns: any
setVisible¶
▸ setVisible(value: boolean, redraw?: boolean = true): Promise<any>
Sets the section's visible state with / without redraw
Implementation of ISectionProxy.setVisible
Parameters:
| Name | Type | Description |
|---|---|---|
| value | boolean | visible state |
| redraw? | boolean = true | true whether redraw the section after setting the visible state |
Returns: Promise<any>