Class Selection

Wrapper over SPListProvider's selectedItems state, exposed to list custom scripts via TISA API. Uses getter functions to always access the latest React state values through refs.

Implements

ISelectionService

Index

Accessors

selectedItems selectedItemsData

Methods

deselect deselectAll isSelected select selectAll

Accessors

selectedItems

get selectedItems(): number[]
Array of selected item IDs. Setting replaces the entire selection.

Returns number[]
Implementation of TypeDocHidden_ISelectionService.selectedItems
set selectedItems(itemIds: number[]): void
Array of selected item IDs. Setting replaces the entire selection.
Parameters
- itemIds: number[]
Returns void
Implementation of TypeDocHidden_ISelectionService.selectedItems

selectedItemsData

get selectedItemsData(): ListItem[]
Full item data for all selected items

Returns ListItem[]
Implementation of TypeDocHidden_ISelectionService.selectedItemsData

Methods

deselect

deselect(itemIds: number | number[]): void
Removes the specified item(s) from the current selection.
Parameters
- itemIds: number | number[]
Returns void
Implementation of ISelectionService.deselect

deselectAll

deselectAll(): void
Clears the entire selection.

Returns void
Implementation of ISelectionService.deselectAll

isSelected

isSelected(itemId: number): boolean
Parameters
- itemId: number
Returns boolean
whether the specified item is currently selected

Implementation of ISelectionService.isSelected

select

select(itemIds: number | number[]): void
Adds the specified item(s) to the current selection.
Parameters
- itemIds: number | number[]
Returns void
Implementation of ISelectionService.select

selectAll

selectAll(): void
Selects all items in the list.

Returns void
Implementation of ISelectionService.selectAll