Class Selection

Selection API. Allows selecting Entities, Assets etc.

Hierarchy

Events
- Selection

Index

Internal

Other

count enabled history item items _deferChangeEvt add clear has remove set toggle

Internal

constructor

new Selection(): Selection
Constructor

Returns Selection
Overrides Events.constructor
- Defined in editor-api/src/selection.js:80

Other

count

get count(): number
Gets the number of selected items

Returns number
- Defined in editor-api/src/selection.js:343

enabled

get enabled(): boolean
Returns boolean
- Defined in editor-api/src/selection.js:334
set enabled(value): void
Enables / disables the selection methods
Parameters
- value: boolean
Returns void
- Defined in editor-api/src/selection.js:330

history

get history(): SelectionHistory
Gets the selection history

Returns SelectionHistory
- Defined in editor-api/src/selection.js:352

item

get item(): any[]
Gets the first selected item. Short for this.items[0].

Returns any[]
- Defined in editor-api/src/selection.js:321

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;
```
- Defined in editor-api/src/selection.js:312

`Private` _deferChangeEvt

_deferChangeEvt(): void
Private
Fire 'change' event in timeout

Returns void
- Defined in editor-api/src/selection.js:94

add

add(item, options?): 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);
```
- Defined in editor-api/src/selection.js:114

clear

clear(options?): 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();
```
- Defined in editor-api/src/selection.js:235

has

has(item): 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);
```
- Defined in editor-api/src/selection.js:221

remove

remove(item, options?): 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);
```
- Defined in editor-api/src/selection.js:150

set

set(items, options?): 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]);
```
- Defined in editor-api/src/selection.js:278

toggle

toggle(item, options?): 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);
```
- Defined in editor-api/src/selection.js:185