Class Selection

Index

Constructors

Properties

list transformer

Accessors

isDisabled isVisible shapes

Methods

add addFilter delete deselect deselectAll find getTransformer group moveX moveY multi removeFilter reselect selectAll toggle

Constructors

constructor

new Selection(board): Selection
Parameters
- board: Board
Returns Selection

Properties

list

list: ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>[] = []

Represents list of the selected shapes

transformer

transformer: Transformer

Represents the selections transformer object

Accessors

isDisabled

get isDisabled(): boolean
Determines whether the selection has been disabled by another component

Returns boolean
the disabled status which is true or false

isVisible

get isVisible(): boolean
Checks whether the selection transformer is visible or not

Returns boolean

shapes

get shapes(): ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>[]
Returns list of selected shapes

Returns ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>[]
array of [[ShapeModel]]

Methods

add

add(shape): void
Adds a [[ShapeModel | shape ]] to the selections list
Parameters
- shape: ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>
  The [[ShapeModel]]
Returns void

addFilter

addFilter(filters): void
Adds filter or filters to the selected shapes
Parameters
- filters: Filters | Filters[]
  The [[Filters]]
Returns void

delete

delete(): void
Deletes all selected shapes

Returns void

deselect

deselect(shape): void
Deselects a shape
Parameters
- shape: ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>
  The [[ShapeModel]]
Returns void

deselectAll

deselectAll(): void
Deselects all shapes in the board

Returns void
Example
```
editor.board.selection.deselectAll()
```

find

find(selector): void
Finds and selects multiple shapes
Parameters
- selector: ((shape) => boolean)
  The selector function
  - - (shape): boolean
    - Parameters
      shape: ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>
      Returns boolean
Returns void
Example
```
editor.board.selection.find(shape => shape.node.getType() === 'Rect')
```
Example
```
editor.board.selection.find(shape => shape.node.getId() === '<id>')
```

getTransformer

getTransformer(): Transformer
Returns selection transformer object

Returns Transformer

group

group(groupName): void
Creates a group of the selected shapes
Parameters
- groupName: string
  The group name
Returns void

moveX

moveX(value): Promise<unknown>
Moves the selected shape horizontally
Parameters
- value: number
  The value number
Returns Promise<unknown>

moveY

moveY(value): Promise<unknown>
Moves the selected shape vertically
Parameters
- value: number
  The value number
Returns Promise<unknown>

multi

multi(shapes): void
Selects one or multiple shapes
Parameters
- shapes: ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>[]
  The array of [[ShapeModel]]
Returns void

removeFilter

removeFilter(filters): void
Removes a filter or list of filters from the selected shapes
Parameters
- filters: FilterFunctions | FilterFunctions[]
  The filter names
Returns void

reselect

reselect(): void
Reselects all selected shapes

Returns void
Example
```
editor.board.selection.reselectAll()
```

selectAll

selectAll(): void
Selects all shapes in the board

Returns void
Example
```
editor.board.selection.selectAll()
```

toggle

toggle(shape): void
Toggles a [[ShapeModel | shape]]
Parameters
- shape: ShapeModel<Shape<ShapeConfig> | Group, ShapeConfig>
  The [[ShapeModel]]
Returns void