Class LineTool

Line: click start, click end; continues from the end until Escape/right-click.

Implements

Tool

Index

Constructors

Properties

cursor id label shortcut

Methods

activate cancel pointerDown pointerMove value

Constructors

constructor

new LineTool(): LineTool

Returns LineTool

Properties

`Readonly`cursor

cursor: "crosshair" = 'crosshair'

`Readonly`id

id: "line" = 'line'

`Readonly`label

label: "tool.line" = 'tool.line'

i18n key or plain label.

`Readonly`shortcut

shortcut: "l" = 'l'

Single-key shortcut (e.g. l).

Methods

activate

activate(ctx: ToolContext): void
Parameters
- ctx: ToolContext
Returns void
Implementation of Tool.activate
- Defined in packages/sdk/src/editor/tools/draw.ts:34

cancel

cancel(ctx: ToolContext): void
Abort the current operation and return to idle.
Parameters
- ctx: ToolContext
Returns void
Implementation of Tool.cancel
- Defined in packages/sdk/src/editor/tools/draw.ts:74

pointerDown

pointerDown(ctx: ToolContext, p: ToolPointer): Promise<void>
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns Promise<void>
Implementation of Tool.pointerDown
- Defined in packages/sdk/src/editor/tools/draw.ts:38

pointerMove

pointerMove(ctx: ToolContext, p: ToolPointer): void
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void
Implementation of Tool.pointerMove
- Defined in packages/sdk/src/editor/tools/draw.ts:59

value

value(ctx: ToolContext, text: string): Promise<boolean>
Typed value (numbers like 1200 or 600,400), submitted with Enter. Return true if accepted.
Parameters
- ctx: ToolContext
- text: string
Returns Promise<boolean>
Implementation of Tool.value
- Defined in packages/sdk/src/editor/tools/draw.ts:65