Class SelectMode

Abstract base class for all drawing modes. Each mode handles touch events and optionally draws an in-progress overlay.

Hierarchy (View Summary)

DrawingMode
- SelectMode

Index

Constructors

Properties

Accessors

Methods

activate deactivate drawOverlay onLayerRemoved onSnapShotRestored onTouchCancel onTouchEnd onTouchMove onTouchStart setSelectedShape

Constructors

constructor

new SelectMode(canvas: DrawingCanvas): SelectMode
Parameters
- canvas: DrawingCanvas
Returns SelectMode
Inherited from DrawingMode.constructor
- Defined in packages/ui-drawingcanvas/modes/DrawingMode.d.ts:15

Properties

`Protected`canvas

canvas: DrawingCanvas

`Readonly`name

name: "select"

Accessors

selectedShape

get selectedShape(): DrawableShape
Returns DrawableShape
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:8

Methods

activate

activate(): void
Called when this mode becomes active

Returns void
Inherited from DrawingMode.activate
- Defined in packages/ui-drawingcanvas/modes/DrawingMode.d.ts:30

deactivate

deactivate(): void
Called when the SelectMode is switched away from. Commits any pending text edit and clears the selection.

Returns void
Overrides DrawingMode.deactivate
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:16

drawOverlay

drawOverlay(canvas: Canvas): void
Draw any in-progress overlay for this mode. Called during the DrawingCanvas onDraw pass after all layers.
Parameters
- canvas: Canvas
Returns void
Overrides DrawingMode.drawOverlay
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:17

onLayerRemoved

onLayerRemoved(shape: DrawableShape, index: number): void
Parameters
- shape: DrawableShape
- index: number
Returns void
Overrides DrawingMode.onLayerRemoved
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:23

onSnapShotRestored

onSnapShotRestored(): void
Returns void
Overrides DrawingMode.onSnapShotRestored
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:22

onTouchCancel

onTouchCancel(_point: TouchPoint): void
Called when the touch is cancelled
Parameters
- _point: TouchPoint
Returns void
Overrides DrawingMode.onTouchCancel
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:14

onTouchEnd

onTouchEnd(_point: TouchPoint): void
Called when the touch ends
Parameters
- _point: TouchPoint
Returns void
Overrides DrawingMode.onTouchEnd
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:13

onTouchMove

onTouchMove(point: TouchPoint): void
Called as the touch moves
Parameters
- point: TouchPoint
Returns void
Overrides DrawingMode.onTouchMove
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:12

onTouchStart

onTouchStart(point: TouchPoint): void
Called when a touch begins
Parameters
- point: TouchPoint
Returns void
Overrides DrawingMode.onTouchStart
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:11

setSelectedShape

setSelectedShape(shape: DrawableShape): void
Programmatically set the selected shape (used by DrawingCanvas.selectShape)
Parameters
- shape: DrawableShape
Returns void
- Defined in packages/ui-drawingcanvas/modes/SelectMode.d.ts:10