Class Selection

Selection API. Allows selecting Entities, Assets etc.

Hierarchy

  • Events
    • Selection

Internal

constructor

Other

count enabled history item items add clear has remove set toggle

Internal

constructor

Other

count

enabled

history

item

items

  • get items(): any[]

  • Gets the selected items. This creates a new array every time it is called.

    Returns any[]

    Example

    editor.selection.items.add(editor.entities.root);
    const selectedEntities = editor.selection.items;

add

  • add(item: any, options?: { history: boolean }): void

  • Add item to selection

    Parameters

    • item: any

      The item

    • options: { history: boolean } = {}

      Options

      • history: boolean

        Whether to record a history action. Defaults to true.

    Returns void

    Example

    // add root entity to selection
    editor.selection.add(editor.entities.root);

clear

  • clear(options?: { history: boolean }): void

  • Clears selection

    Parameters

    • options: { history: boolean } = {}

      Options

      • history: boolean

        Whether to record a history action. Defaults to true.

    Returns void

    Example

    editor.selection.clear();

has

  • has(item: any): boolean

  • Checks if item is in selection

    Parameters

    • item: any

      The item

    Returns boolean

    If item is in selection

    Example

    const isRootSelected = editor.selection.has(editor.entities.root);

remove

  • remove(item: any, options?: { history: boolean }): void

  • Remove item from selection

    Parameters

    • item: any

      The item

    • options: { history: boolean } = {}

      Options

      • history: boolean

        Whether to record a history action. Defaults to true.

    Returns void

    Example

    // remove root entity from selection
    editor.selection.remove(editor.entities.root);

set

  • set(items: any[], options?: { history: boolean }): void

  • Sets current selection

    Parameters

    • items: any[]

      The items to select

    • options: { history: boolean } = {}

      Options

      • history: boolean

        Whether to record a history action. Defaults to true.

    Returns void

    Example

    // select root entity
    editor.selection.set([editor.entities.root]);

toggle

  • toggle(item: any, options?: { history: boolean }): void

  • Toggle item selection

    Parameters

    • item: any

      The item

    • options: { history: boolean } = {}

      Options

      • history: boolean

        Whether to record a history action. Defaults to true.

    Returns void

    Example

    // toggle root entity selection
    editor.selection.toggle(editor.entities.root);

Settings

Member Visibility

On This Page

Internal
Other