Class Selection

Selection API. Allows selecting Entities, Assets etc.

Hierarchy

Events
- Selection

Index

Internal

Other

count enabled history item items add clear has remove set toggle

Internal

constructor

new Selection(): Selection
Constructor

Returns Selection
Overrides Events.constructor
- Defined in submodules/editor-api/src/selection.ts:94

Other

count

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

Returns number
- Defined in submodules/editor-api/src/selection.ts:334

enabled

get enabled(): boolean
Gets enabled state of the selection methods.

Returns boolean
- Defined in submodules/editor-api/src/selection.ts:327
set enabled(value: boolean): void
Sets enabled state of the selection methods.
Parameters
- value: boolean
Returns void
- Defined in submodules/editor-api/src/selection.ts:320

history

get history(): SelectionHistory
Gets the selection history

Returns SelectionHistory
- Defined in submodules/editor-api/src/selection.ts:341

item

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

Returns Entity | Asset
- Defined in submodules/editor-api/src/selection.ts:313

items

get items(): (Entity | Asset)[]
Gets the selected items. This creates a new array every time it is called.

Returns (Entity | Asset)[]
Example
```
editor.selection.items.add(editor.entities.root);
const selectedEntities = editor.selection.items;
```
- Defined in submodules/editor-api/src/selection.ts:306

add

add(item: any, options?: { history?: boolean }): void
Add item to selection
Parameters
- item: any
- options: { history?: boolean } = {}
Returns void
Example
```
// add root entity to selection
editor.selection.add(editor.entities.root);
```
- Defined in submodules/editor-api/src/selection.ts:123

clear

clear(options?: { history?: boolean }): void
Clears selection
Parameters
- options: { history?: boolean } = {}
Returns void
Example
```
editor.selection.clear();
```
- Defined in submodules/editor-api/src/selection.ts:234

has

has(item: any): boolean
Checks if item is in selection
Parameters
- item: any
Returns boolean
Example
```
const isRootSelected = editor.selection.has(editor.entities.root);
```
- Defined in submodules/editor-api/src/selection.ts:222

remove

remove(item: any, options?: { history?: boolean }): void
Remove item from selection
Parameters
- item: any
- options: { history?: boolean } = {}
Returns void
Example
```
// remove root entity from selection
editor.selection.remove(editor.entities.root);
```
- Defined in submodules/editor-api/src/selection.ts:156

set

set(items: any[], options?: { history?: boolean }): void
Sets current selection
Parameters
- items: any[]
- options: { history?: boolean } = {}
Returns void
Example
```
// select root entity
editor.selection.set([editor.entities.root]);
```
- Defined in submodules/editor-api/src/selection.ts:273

toggle

toggle(item: any, options?: { history?: boolean }): void
Toggle item selection
Parameters
- item: any
- options: { history?: boolean } = {}
Returns void
Example
```
// toggle root entity selection
editor.selection.toggle(editor.entities.root);
```
- Defined in submodules/editor-api/src/selection.ts:188