Interface IMovableSelection

Manages a selection of IMovables.

interface IMovableSelection {
    addListeners(
        listeners: IMovableSelection.IListeners,
        options?: IListener.Options,
    ): Remove;
    getMovableSelection(): readonly IMovable[];
    selectMovables(
        movables: readonly IMovable[],
        addToSelection?: boolean,
    ): this;
    unselectMovables(movables: IMovable[]): this;
}

Hierarchy (View Summary)

ISource<IMovableSelection>
- IMovableSelection
  - ISheetView

Index

Methods

addListeners getMovableSelection selectMovables unselectMovables

Methods

addListeners

addListeners(
listeners: IMovableSelection.IListeners,
options?: IListener.Options,
): Remove
Add Listeners.
Parameters
- listeners: IMovableSelection.IListeners
- Optionaloptions: IListener.Options
Returns Remove

See
IListener.ISource.addListeners

Overrides ISource.addListeners

getMovableSelection

getMovableSelection(): readonly IMovable[]

The movable selection.

Returns readonly IMovable[]

selectMovables

selectMovables(movables: readonly IMovable[], addToSelection?: boolean): this
Select a movable object.
Parameters
- movables: readonly IMovable[]
- OptionaladdToSelection: boolean
Returns this

unselectMovables

unselectMovables(movables: IMovable[]): this
Returns the movable from the selection.
Parameters
- movables: IMovable[]
Returns this