Skip to content

Class: SectionProxy

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

Currently none in this class.

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

Accessors

dataSubscriptions

dataSubscriptions:

Implementation of ISectionProxy.dataSubscriptions


searchString

searchString:

Implementation of ISectionProxy.searchString

Methods

Protected _getExecuteSource

_getExecuteSource(): ExecuteSource

Overrides ClientAPI._getExecuteSource

Returns: ExecuteSource


getControl

getControl(name: string): IControlProxy

Implementation of ISectionProxy

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

Returns: IControlProxy[]


getExtensions

getExtensions(): IView[]

Implementation of ISectionProxy

Returns: IView[]


getLoadedItemsCount

getLoadedItemsCount(): number

Implementation of ISectionProxy

Returns: number


getName

getName(): string

Implementation of ISectionProxy

Returns: string


getPageProxy

getPageProxy(): IPageProxy

Implementation of ISectionProxy

Returns: IPageProxy


getProperty

getProperty(): string

Implementation of ISectionProxy

Returns: string


getType

getType(): string

Implementation of ISectionProxy

Returns: string


getVisible

getVisible(): boolean

Implementation of ISectionProxy

Returns: boolean


isStaticSection

isStaticSection(): boolean

Implementation of ISectionProxy

Returns: boolean


redraw

redraw(fullSection: boolean): Promise‹any›

Implementation of ISectionProxy

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

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

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›