Class SelectionModel<T>

constructor

• new SelectionModel<T>(
      _multiple?: boolean,
      initiallySelectedValues?: T[],
      _emitChanges?: boolean,
      compareWith?: (o1: T, o2: T) => boolean,
  ): SelectionModel<T>

  Type Parameters

  • T

  Parameters

  • _multiple: boolean = false
  • OptionalinitiallySelectedValues: T[]
  • _emitChanges: boolean = true
  • OptionalcompareWith: (o1: T, o2: T) => boolean

  Returns SelectionModel<T>

Readonlychanged

OptionalcompareWith

selected

• get selected(): T[]

  Selected values.

  Returns T[]

clear

• clear(flushEvent?: boolean): boolean | void

  Clears all of the selected values.

  Parameters

  • flushEvent: boolean = true

    Whether to flush the changes in an event. If false, the changes to the selection will be flushed along with the next event.

  Returns boolean | void

  Whether the selection changed as a result of this call @breaking-change 16.0.0 make return type boolean

deselect

• deselect(...values: T[]): boolean | void

  Deselects a value or an array of values.

  Parameters

  • ...values: T[]

    The values to deselect

  Returns boolean | void

  Whether the selection changed as a result of this call @breaking-change 16.0.0 make return type boolean

hasValue

• hasValue(): boolean

  Determines whether the model has a value.

  Returns boolean

isEmpty

• isEmpty(): boolean

  Determines whether the model does not have a value.

  Returns boolean

isMultipleSelection

• isMultipleSelection(): boolean

  Gets whether multiple values can be selected.

  Returns boolean

isSelected

• isSelected(value: T): boolean

  Determines whether a value is selected.

  Parameters

  • value: T

  Returns boolean

select

• select(...values: T[]): boolean | void

  Selects a value or an array of values.

  Parameters

  • ...values: T[]

    The values to select

  Returns boolean | void

  Whether the selection changed as a result of this call @breaking-change 16.0.0 make return type boolean

setSelection

• setSelection(...values: T[]): boolean | void

  Sets the selected values

  Parameters

  • ...values: T[]

    The new selected values

  Returns boolean | void

  Whether the selection changed as a result of this call @breaking-change 16.0.0 make return type boolean

sort

• sort(predicate?: (a: T, b: T) => number): void

  Sorts the selected values based on a predicate function.

  Parameters

  • Optionalpredicate: (a: T, b: T) => number

  Returns void

toggle

• toggle(value: T): boolean | void

  Toggles a value between selected and deselected.

  Parameters

  • value: T

    The value to toggle

  Returns boolean | void

  Whether the selection changed as a result of this call @breaking-change 16.0.0 make return type boolean