Class Selection<T>

Takes a list of items and handles selection for them.

Type Parameters

  • T

Constructors

constructor

Properties

deselected indeterminate items onChange onDeselect onDeselectAll onSelect onSelectAll pkField selected selection

Accessors

selectedItems selectedItemsIds

Methods

count deselect deselectAll getItemPK reset select selectAll selectDeselectAll selectPks toggle

Constructors

constructor

  • new Selection<T>(
        items: T[],
        pkField?: keyof T,
        pksSelected?: PK[],
    ): Selection<T>

    Type Parameters

    • T

    Parameters

    • items: T[]

      List of original items to set up selection for.

    • pkField: keyof T = ...

      Item unique property key to store selection by.

    • pksSelected: PK[] = []

      List of item PKs that are selected.

    Returns Selection<T>

Properties

deselected

deselected: number = 0

Number of deselected items.

indeterminate

indeterminate: boolean = false

Is selection indeterminate?

items

items: T[]

List of original items to set up selection for.

ReadonlyonChange

onChange: EventEmitter<void> = ...

Triggers whenever any selection change happen.

ReadonlyonDeselect

onDeselect: EventEmitter<T> = ...

Triggers when an item is deselected.

ReadonlyonDeselectAll

onDeselectAll: EventEmitter<T> = ...

Triggers when all items are deselected. Only when Selection.deselectAll is called.

ReadonlyonSelect

onSelect: EventEmitter<T> = ...

Triggers when an item is selected.

ReadonlyonSelectAll

onSelectAll: EventEmitter<T> = ...

Triggers when all items are selected. Only when Selection.selectAll is called.

ReadonlypkField

pkField: keyof T = ...

Item unique property key to store selection by.

selected

selected: number = 0

Number of selected items.

selection

selection: Record<PK, boolean> = {}

Selection dict.

This is where we keep which item is selected (value true) and which item is not (value not true).

Accessors

selectedItems

  • get selectedItems(): T[]

    Returns T[]

    List of original items that are selected

selectedItemsIds

Methods

count

  • count(): void

    Update selected and deselected numbers. Also update indeterminate status.

    Returns void

deselect

  • deselect(item: T, count?: boolean): void

    Deselect an item.

    Parameters

    • item: T

      to deselect.

    • count: boolean = true

      Whether to generate counts (default is true).

    Returns void

deselectAll

  • deselectAll(): void

    Deselect all items.

    Returns void

PrivategetItemPK

  • getItemPK(item: T): PK

    Parameters

    • item: T

    Returns PK

    the PK of the given item.

reset

  • reset(): void

    Reset all selection and update the count.

    Returns void

select

  • select(item: T, count?: boolean): void

    Select an item.

    Parameters

    • item: T

      to select.

    • count: boolean = true

      Whether to generate counts (default is true).

    Returns void

selectAll

  • selectAll(): void

    Select all items.

    Returns void

selectDeselectAll

  • selectDeselectAll(): void

    Select all if selection is indeterminate or no item is selected otherwise deselect all.

    Returns void

selectPks

  • selectPks(pks: PK[]): void

    Select the given items PKs

    Parameters

    • pks: PK[]

      to select.

    Returns void

toggle

  • toggle(item: T, count?: boolean): void

    Toggle an item selection status.

    Parameters

    • item: T

      to toggle selection.

    • count: boolean = true

      Whether to generate counts (default is true).

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR