map.apps Bundle APIs 4.20.0
    Preparing search index...

    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

    Index

    Properties

    size: number

    Number of items in the selection.

    Methods

    • Adds a value to the selection.

      Parameters

      Returns this

    • Adds all values to the selection.

      Parameters

      • value: Iterable<ItemType>

        iterable of values.

      Returns this

    • Clears the selection.

      Returns void

    • Removes the value.

      Parameters

      Returns boolean

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

    • Removes the values.

      Parameters

      Returns boolean

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

    • Parameters

      Returns boolean

      a boolean indicating whether an object exists or not.

    • Registers event listener.

      Type Parameters

      • Name extends "changed"

      Parameters

      Returns Handle