charton API / @chart-on/core / index / DrawingEvents
Interface: DrawingEvents
Defined in: packages/core/src/drawing/manager.ts:86
Events emitted by the drawing manager, by name: tool, magnet and access changes, selection and clicks, drawings created, edited or removed, and undo history.
Extended by
Properties
access:change
access:change:
object
Defined in: packages/core/src/drawing/manager.ts:92
setAccess() changed which tools are allowed; allow is the new rule, null for all.
allow
allow:
AccessRule|null
drawing:bounds
drawing:bounds:
object
Defined in: packages/core/src/drawing/manager.ts:108
The selected drawing's on-screen box (plot-space css px) changed while rendering; rect is null when it is out of view or nothing is selected.
id
id:
string|null
rect
rect:
Rect|null
drawing:click
drawing:click:
object
Defined in: packages/core/src/drawing/manager.ts:128
A press and release on a drawing without dragging it.
id
id:
string
drawing:create
drawing:create:
object
Defined in: packages/core/src/drawing/manager.ts:116
A drawing was added, by the user, add(), clone(), undo or redo.
drawing
drawing:
Drawing
drawing:dblclick
drawing:dblclick:
object
Defined in: packages/core/src/drawing/manager.ts:129
id
id:
string
drawing:remove
drawing:remove:
object
Defined in: packages/core/src/drawing/manager.ts:126
A drawing was removed, by the user, remove(), clear(), undo, redo or removing its pane.
id
id:
string
drawing:select
drawing:select:
object
Defined in: packages/core/src/drawing/manager.ts:103
The selection changed: ids in the order they were selected, id the last of them (the one selected returns), or null when nothing is.
id
id:
string|null
ids
ids:
string[]
drawing:update
drawing:update:
object
Defined in: packages/core/src/drawing/manager.ts:118
A drawing changed; changes lists every kind of change, change is the first.
change
change:
DrawingChange
changes
changes:
DrawingChange[]
drawing
drawing:
Drawing
drawing:update-progress
drawing:update-progress:
object
Defined in: packages/core/src/drawing/manager.ts:124
A drawing changed on screen but the change is not committed yet: the user is dragging it, an anchor or a handle, or preview() was called. Fires on every step; the drawing:update at the end commits.
id
id:
string
drawings:change
drawings:change:
object
Defined in: packages/core/src/drawing/manager.ts:110
Any create/update/remove — persist on this.
drawings
drawings:
Drawing[]
drawings:invalid
drawings:invalid:
object
Defined in: packages/core/src/drawing/manager.ts:114
load() skipped saved drawings that were malformed; the valid ones loaded.
errors
errors:
DrawingLoadError[]
drawings:visibility
drawings:visibility:
object
Defined in: packages/core/src/drawing/manager.ts:112
setHidden() hid or showed every drawing; hidden is the new drawings.hidden.
hidden
hidden:
boolean
history:change
history:change:
object
Defined in: packages/core/src/drawing/manager.ts:131
The undo/redo history changed — refresh undo/redo buttons on this.
canRedo
canRedo:
boolean
canUndo
canUndo:
boolean
magnet:change
magnet:change:
object
Defined in: packages/core/src/drawing/manager.ts:90
setMagnetMode() or setMagnet() changed the magnet; mode is the new magnetMode.
mode
mode:
MagnetMode
tool:change
tool:change:
object
Defined in: packages/core/src/drawing/manager.ts:88
The active tool changed (null = cursor); kept is toolKept.
kept
kept:
boolean
tool
tool:
string|null
tool:defaults-change
tool:defaults-change:
object
Defined in: packages/core/src/drawing/manager.ts:137
The style new drawings of tool start with changed, through setToolDefaults, loadToolDefaults or a remembered style edit. defaults is the new toolDefaults(tool).
defaults
defaults:
DrawingStyle
tool
tool:
string
tool:refuse
tool:refuse:
object
Defined in: packages/core/src/drawing/manager.ts:98
setTool() refused a tool setAccess() denies, e.g. a press on a disabled rail button. The call throws after this fires; apps show an upgrade prompt or a notice here.
tool
tool:
string