Interface Selection<ItemType>

Represents a selection state.

interface Selection<ItemType> {
    add(value: ItemType): this;
    addAll(value: Iterable<ItemType>): this;
    clear(): void;
    delete(value: ItemType): boolean;
    deleteAll(value: Iterable<ItemType>): boolean;
    has(value: ItemType): boolean;
    on<Name extends "changed">(
        name: Name,
        callBack: EventCallback<SelectionEvents<ItemType>[Name]>,
    ): Handle;
    size: number;
}

Type Parameters

  • ItemType

Hierarchy

Properties

size

Methods

add addAll clear delete deleteAll has on

Properties

Readonlysize

size: number

Number of items in the selection.

Methods

add

  • add(value: ItemType): this

  • Adds a value to the selection.

    Parameters

    Returns this

addAll

  • addAll(value: Iterable<ItemType>): this

  • Adds all values to the selection.

    Parameters

    • value: Iterable<ItemType>

      iterable of values.

    Returns this

clear

  • clear(): void

  • Clears the selection.

    Returns void

delete

  • delete(value: ItemType): boolean

  • Removes the value.

    Parameters

    Returns boolean

    Returns true if the value existed and has been removed, or false if it does not exist.

deleteAll

  • deleteAll(value: Iterable<ItemType>): boolean

  • Removes the values.

    Parameters

    Returns boolean

    Returns true if the all values existed and are removed, or false if a value does not exist.

has

  • has(value: ItemType): boolean

  • Parameters

    Returns boolean

    a boolean indicating whether an object exists or not.

on

  • on<Name extends "changed">(
        name: Name,
        callBack: EventCallback<SelectionEvents<ItemType>[Name]>,
    ): Handle

  • Registers event listener.

    Type Parameters

    • Name extends "changed"

    Parameters

    Returns Handle

Settings

Member Visibility

On This Page

Properties
Methods