Skip to content

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

Inherited Properties

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

constructor

+ new SectionProxy(context: IContext): SectionProxy

Overrides ClientAPI.constructor

Parameters:

Name Type
context IContext

Returns: SectionProxy

Properties

Accessors

dataSubscriptions

get dataSubscriptions(): string[]

Get the section dataSubscription array

Returns: string[]

set dataSubscriptions(dataSubscriptions: string[]): void

Set the section dataSubscriptions

Parameters:

Name Type
dataSubscriptions string[]

Returns: void


searchString

get searchString(): string

get the search string

Returns: string

Methods

Protected _getExecuteSource

_getExecuteSource(): ExecuteSource

Overrides ClientAPI._getExecuteSource

Returns: ExecuteSource


getControl

getControl(name: string): IControlProxy

Implementation of ISectionProxy

Find a control based on the name. It returns FormCell controls in section.

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[]

Implementation of ISectionProxy

Get the list of controls in the Section if it is a FormCell Section.

Returns: IControlProxy[]


getExtensions

getExtensions(): IView[]

Implementation of ISectionProxy

Returns the extensions the section is using.

Returns: IView[]


getLoadedItemsCount

getLoadedItemsCount(): number

Implementation of ISectionProxy

This method returns the number of loaded items in the section.

Returns: number


getName

getName(): string

Implementation of ISectionProxy

Get the section name

Returns: string


getPageProxy

getPageProxy(): IPageProxy

Implementation of ISectionProxy

Return the page proxy, which the SectionedTable belongs to

Returns: IPageProxy


getProperty

getProperty(): string

Implementation of ISectionProxy

Get the property name being bound, one of the property names in a section definition

Returns: string


getType

getType(): string

Implementation of ISectionProxy

Get the section type

Returns: string


getVisible

getVisible(): boolean

Implementation of ISectionProxy

Get the section visible property

Returns: boolean


isStaticSection

isStaticSection(): boolean

Implementation of ISectionProxy

The bound object type, if true binding object is definition

Returns: boolean


redraw

redraw(fullSection: boolean): Promise‹any›

Implementation of ISectionProxy

Redraw the section

Parameters:

Name Type Default 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

Implementation of ISectionProxy

Set the interacting object cell indicator's state in the section

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): Promise‹any›

Implementation of ISectionProxy

Sets the section's visible state with / without redraw

Parameters:

Name Type Default Description
value boolean - visible state
redraw boolean true true whether redraw the section after setting the visible state

Returns: Promise‹any›