Interface: ISelectableSectionProxy¶
Hierarchy¶
-
ISelectableSectionProxy
Implemented by¶
Summary¶
Properties¶
Class Properties¶
None in this class.
Inherited Properties¶
Methods¶
Class Methods¶
- deselectAllItems
- getSelectedItems
- getSelectedItemsCount
- getSelectionChangedItem
- getSelectionMode
- selectAllItems
- setSelectionMode
Inherited Methods¶
Methods¶
deselectAllItems¶
▸ deselectAllItems(): void
Deselect all items of the section if it is in multiple selection mode.
Returns: void
getSelectedItems¶
▸ getSelectedItems(): [SelectedItem]
Get the current section selected items when selection mode is active. Otherwise an empty array will be returned.
Returns: [SelectedItem]
getSelectedItemsCount¶
▸ getSelectedItemsCount(): number
Get the number of loaded items of section.
Returns: number
getSelectionChangedItem¶
▸ getSelectionChangedItem(): ChangedItem
Get the last selected or deselected item.
Returns: ChangedItem
getSelectionMode¶
▸ getSelectionMode(): string
Get selection mode for the current section. The return value is None or Multiple
Returns: string
selectAllItems¶
▸ selectAllItems(): void
Select all items of the section if it is in multiple selection mode. Only items that are loaded and rendered will be selected. Items that are subsequently loaded via data paging will not be selected.
Returns: void
setSelectionMode¶
▸ setSelectionMode(mode: string): any
Set the section selection mode
Parameters:
| Name | Type |
|---|---|
mode |
string |
Returns: any