interface
Source: selectionHandler.ts ↗
ISingleSelectionHandler
Handles simple selection of at most one item.
export interface ISingleSelectionHandler<T>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Registers a callback that will be fired when the selection changes. Returns unsubscribe function, that will unregister it, once called. Multiple callbacks can be registered by this function. |
Methods
Method | Description |
|---|---|
Change the selection. | |
Returns the current selection. |
Property details
ISingleSelectionHandler.onSelectionChangedproperty
Registers a callback that will be fired when the selection changes. Returns unsubscribe function, that will unregister it, once called.
Multiple callbacks can be registered by this function.
onSelectionChanged: CallbackRegistration<OnSelectionChangedCallbackPayload<T>>;
Method details
ISingleSelectionHandler.changeSelection()method
Change the selection.
changeSelection(selection: T): void;
Parameters
Parameter | Type | Description |
|---|---|---|
selection | T | new selection |
Returns
void
ISingleSelectionHandler.getSelection()method
Returns the current selection.
getSelection(): T;
Returns
T