Class EditorCore

constructor

• new EditorCore(
      engine: DotloomEngine,
      viewport: ViewportLike,
      options?: EditorCoreOptions,
  ): EditorCore

  Parameters

  • engine: DotloomEngine
  • viewport: ViewportLike
  • options: EditorCoreOptions = {}

  Returns EditorCore

Readonlyengine

Readonlypointer

Readonlystate

Readonlyviewport

hasClipboard

• get hasClipboard(): boolean

  Whether something can be pasted.

  Returns boolean

pressed

• get pressed(): boolean

  Whether a pointer button is held (for capture-loss handling).

  Returns boolean

tool

• get tool(): Tool | null

  Returns Tool | null

typedUnitScale

• get typedUnitScale(): number

  Returns number

addSnapProvider

• addSnapProvider(p: SnapProvider): () => void

  Add a snap provider (plugins); returns a remover.

  Parameters

  • p: SnapProvider

  Returns () => void

apply

• apply(tx: Transaction): Promise<CommitReport | null>

  Apply a transaction, tracking busy/error state. Returns null on failure. New entities without a layer go to the active layer.

  Parameters

  • tx: Transaction

  Returns Promise<CommitReport | null>

applyOrThrow

• applyOrThrow(tx: Transaction): Promise<CommitReport>

  Like apply, but failures are thrown to the caller (e.g. a form field that shows the error next to itself) instead of being reported in the state.

  Parameters

  • tx: Transaction

  Returns Promise<CommitReport>

cancel

• cancel(reason: CancelReason): Promise<void>

  Pointer capture lost, window blurred, … — abort any in-progress gesture.

  Parameters

  • reason: CancelReason

  Returns Promise<void>

cancelSolve

• cancelSolve(): void

  Cancel the running solve (the document stays unchanged).

  Returns void

clearError

• clearError(): void

  Clear the reported error.

  Returns void

copy

• copy(): Promise<void>

  Returns Promise<void>

deleteSelection

• deleteSelection(): Promise<void>

  Returns Promise<void>

dispose

• dispose(): void

  Stop processing input and remove listeners.

  Returns void

doubleClick

• doubleClick(p: InputPointer): Promise<void>

  Parameters

  • p: InputPointer

  Returns Promise<void>

idle

• idle(): Promise<void>

  Resolves when all queued input has been processed (tests, scripted input).

  Returns Promise<void>

keyDown

• keyDown(k: InputKey): boolean

  Handle a key from a focused editor. Returns true if it was consumed.

  Parameters

  • k: InputKey

  Returns boolean

listTools

• listTools(): Tool[]

  Registered tools.

  Returns Tool[]

paste

• paste(): Promise<void>

  Returns Promise<void>

pointerDown

• pointerDown(p: InputPointer): Promise<void>

  Parameters

  • p: InputPointer

  Returns Promise<void>

pointerLeave

• pointerLeave(): void

  Pointer left the canvas: clear hover and snap feedback.

  Returns void

pointerMove

• pointerMove(p: InputPointer): Promise<void>

  Parameters

  • p: InputPointer

  Returns Promise<void>

pointerUp

• pointerUp(p: InputPointer): Promise<void>

  Parameters

  • p: InputPointer

  Returns Promise<void>

redo

• redo(): Promise<void>

  Returns Promise<void>

registerTool

• registerTool(tool: Tool): () => void

  Register a tool; returns an unregister function. Duplicate IDs throw.

  Parameters

  • tool: Tool

  Returns () => void

report

• report(err: unknown): void

  Report an error in the editor state.

  Parameters

  • err: unknown

  Returns void

run

• run(action: ShortcutAction, k?: InputKey): Promise<void>

  Run a shortcut action.

  Parameters

  • action: ShortcutAction
  • Optionalk: InputKey

  Returns Promise<void>

selectAll

• selectAll(): Promise<void>

  Returns Promise<void>

setActiveLayer

• setActiveLayer(layer: number | null): void

  Layer for new entities (null = the engine's default layer).

  Parameters

  • layer: number | null

  Returns void

setGridVisible

• setGridVisible(visible: boolean): void

  Show or hide the grid (kept in the state for UIs).

  Parameters

  • visible: boolean

  Returns void

setMarkers

• setMarkers(markers: { at: Point; kind: MarkerKind }[] | undefined): void

  Extra overlay markers (e.g. selection grips from the select tool).

  Parameters

  • markers: { at: Point; kind: MarkerKind }[] | undefined

  Returns void

setTool

• setTool(id: string): void

  Switch tools (the current operation is cancelled).

  Parameters

  • id: string

  Returns void

setUnitScale

• setUnitScale(scale: number): void

  Model units per typed display unit (e.g. 1000 for metres).

  Parameters

  • scale: number

  Returns void

start

• start(): void

  Activate the initial tool once built-in tools are registered.

  Returns void

undo

• undo(): Promise<void>

  Returns Promise<void>

wheel

• wheel(x: number, y: number, deltaY: number, deltaMode: number): void

  Wheel zoom at a CSS position.

  Parameters

  • x: number
  • y: number
  • deltaY: number
  • deltaMode: number

  Returns void