Interface SelectionService

Represents possible operations with selection model.

Default implementation in this library is DefaultSelectionService, but you can extend it or replace with your own implementation.

Hierarchy

SelectionService

Implemented by

DefaultSelectionService

Properties

items

items: any[]

Collection of elements for selection.

lastProcessedIndex

lastProcessedIndex: number

Index of last selected/deselected element in items collection.

Methods

checkSelection

checkSelection(): void

- Defined in contracts/selection-service.ts:29
Performs check that every selected element is actually selected.

Returns void

deselectAll

deselectAll(): void

- Defined in contracts/selection-service.ts:33
Deselects all elements in items collection.

Returns void

deselectIndex

deselectIndex(index: number): void

- Defined in contracts/selection-service.ts:97
Deselects element at specified index in items collection.

Parameters
- index: number
  
  index of element in items collection.
Returns void

destroy

destroy(): void

- Defined in contracts/selection-service.ts:117
Performs application-defined logic for service destroy.

Returns void

getItemIndex

getItemIndex(item: any): number

- Defined in contracts/selection-service.ts:78
Returns index of specified element in items collection.

see

trackByFn

Parameters
- item: any
  
  element to find.
Returns number

index of specified element in items collection. -1 if element not found.

getMaxSelectedIndex

getMaxSelectedIndex(): number

- Defined in contracts/selection-service.ts:71
Returns index of last selected element from items collection.

Returns number

index of last selected element. -1 if nothing is selected.

getMinSelectedIndex

getMinSelectedIndex(): number

- Defined in contracts/selection-service.ts:66
Returns index of first selected element from items collection.

Returns number

index of first selected element. -1 if nothing is selected.

getSelectedElements

getSelectedElements(): any[]

- Defined in contracts/selection-service.ts:108
Returns all elements from items collection which are marked as selected.

Returns any[]

collection of selected elements.

getSelectedIndexes

getSelectedIndexes(): number[]

- Defined in contracts/selection-service.ts:113
Returns indexes of all elements from items collection which are marked as selected.

Returns number[]

collection of selected elements indexes in items collection.

hasSelections

hasSelections(): boolean

- Defined in contracts/selection-service.ts:55
Checks that at least one element selected in items collection.

Returns boolean

true if anything is selected.

isIndexSelected

isIndexSelected(index: number): boolean

- Defined in contracts/selection-service.ts:61
Checks that element at specified index is selected.

Parameters
- index: number
  
  index of element in items collection to check.
Returns boolean

true if element is selected.

isRangeSelected

isRangeSelected(from: number, to: number): boolean

- Defined in contracts/selection-service.ts:50
Checks that all elements inside specified range are selected in items collection.

Parameters
- from: number
- to: number
Returns boolean

true if all elements inside specified range are selected.

selectAll

selectAll(): void

- Defined in contracts/selection-service.ts:37
Selects all elements in items collection.

Returns void

selectFirst

selectFirst(): void

- Defined in contracts/selection-service.ts:82
Selects first element in items collection.

Returns void

selectIndex

selectIndex(index: number, savePrevious?: boolean): void

- Defined in contracts/selection-service.ts:92
Selects element at specified index in items collection.

Parameters
- index: number
  
  index of element in items collection.
- Optional savePrevious: boolean
  
  true if previously selected elements must stay selected after current selection.
Returns void

selectLast

selectLast(): void

- Defined in contracts/selection-service.ts:86
Selects last element in items collection.

Returns void

selectRange

selectRange(fromIndex: number, toIndex: number): void

- Defined in contracts/selection-service.ts:43
Selects range of elements in items collection.

Parameters
- fromIndex: number
  
  index of element from which selection range begins.
- toIndex: number
  
  index of element on which selection range ends.
Returns void

toggleSelection

toggleSelection(index: number, savePrevious?: boolean): void

- Defined in contracts/selection-service.ts:103
Toggles selection of element at the specified index.

Parameters
- index: number
  
  index of element in items collection.
- Optional savePrevious: boolean
  
  true if previously selected elements must stay selected after current selection.
Returns void

trackByFn

trackByFn(index: number, item: any): any

- Defined in contracts/selection-service.ts:24
Optional function which can be used to compare items elements.

This function can be used by checkSelection.

Also it's reasonable to use this function for getItemIndex.

Parameters
- index: number
  
  index of element in items collection.
- item: any
Returns any

Generated using TypeDoc