Interface: ISectionProxy¶

A designer-facing interface that provides access to a section in a sectioned table

It is passed to rules to provide access to a section for application specific customizations.

Hierarchy¶

Implemented by¶

Summary¶

Properties¶

Methods¶

Properties¶

dataSubscriptions¶

• dataSubscriptions: string[]

Get or set the dataSubscriptions property for this section. The dataSubScriptions array contains entitySets names or services names

searchString¶

• searchString: string

Get the searchString property for this section.

Methods¶

getControl¶

▸ getControl(name: string): IControlProxy

Gets the associated control by name. This searches controls in this section if it is a FormCell section.

Parameters:

Name	Type	Description
`name`	string	The control name specified by the _Name definition property.

Returns: IControlProxy

The control assocated with the name parameter

getControls¶

▸ getControls(): IControlProxy[]

This method returns the controls in this section if it is FormCell section

Returns: IControlProxy[]

The controls for this container

getExtensions¶

▸ getExtensions(): IView[]

Returns the extensions the section is using.

Returns: IView[]

getLoadedItemsCount¶

▸ getLoadedItemsCount(): number

This method returns the number of items in the section

Returns: number

getName¶

▸ getName(): string

Get the section name

Returns: string

getPageProxy¶

▸ getPageProxy(): IPageProxy

Get the PageClientAPI associated with this section.

Returns: IPageProxy

getProperty¶

▸ getProperty(): string

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

Returns: string

getType¶

▸ getType(): string

Get the section type

Returns: string

getVisible¶

▸ getVisible(): boolean

Get the section visible property

Returns: boolean

isStaticSection¶

▸ isStaticSection(): boolean

The bound object type, if true binding object is definition

Returns: boolean

redraw¶

▸ redraw(fullSection: boolean): Promise‹any›

Redraw the section

Parameters:

Name	Type	Description
`fullSection`	boolean	false whether redraw full section or redraw on update items only

Returns: Promise‹any›

setIndicatorState¶

▸ setIndicatorState(newState: string, pressedItem: PressedItem): any

Sets the interacte 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›

Sets the section's visible state with / without redraw

Parameters:

Name	Type	Description
`value`	boolean	visible state
`redraw?`	boolean	whether redraw after setting the visible state, the default value is true.

Returns: Promise‹any›