Interface: ISectionProxy¶
Hierarchy¶
-
ISectionProxy
Implemented by¶
- BindableSectionProxy
- CalendarSectionProxy
- DataTableSectionProxy
- ObjectCardCollectionSectionProxy
- ResetableSectionProxy
- SectionProxy
- SelectableSectionProxy
Summary¶
Properties¶
Class Properties¶
Inherited Properties¶
Currently none inherited from the parent class(es).
Methods¶
Class Methods¶
- getControl
- getControls
- getExtensions
- getLoadedItemsCount
- getName
- getPageProxy
- getProperty
- getType
- getVisible
- isStaticSection
- redraw
- setIndicatorState
- setVisible
Inherited Methods¶
Currently none inherited from the parent class(es).
Properties¶
dataSubscriptions¶
• dataSubscriptions: string[]
searchString¶
• searchString: string
Methods¶
getControl¶
▸ getControl(name
: string): IControlProxy
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[]
Returns: IControlProxy[]
The controls for this container
getExtensions¶
▸ getExtensions(): IView[]
Returns: IView[]
getLoadedItemsCount¶
▸ getLoadedItemsCount(): number
Returns: number
getName¶
▸ getName(): string
Returns: string
getPageProxy¶
▸ getPageProxy(): IPageProxy
Returns: IPageProxy
getProperty¶
▸ getProperty(): string
Returns: string
getType¶
▸ getType(): string
Returns: string
getVisible¶
▸ getVisible(): boolean
Returns: boolean
isStaticSection¶
▸ isStaticSection(): boolean
Returns: boolean
redraw¶
▸ redraw(fullSection
: boolean): Promise‹any›
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
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›
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›