Interface Drawing

interface Drawing {
    createdAt?: number;
    id: string;
    locked?: boolean;
    paneIndex: number;
    points: DrawingPoint[];
    props?: Record<string, unknown>;
    style: DrawingStyle;
    text?: DrawingText;
    tool: string;
    visible?: boolean;
    zIndex: number;
}

Properties

createdAt? id locked? paneIndex points props? style text? tool visible? zIndex

Properties

OptionalcreatedAt

createdAt?: number

Epoch ms, set by the controller when the drawing is added.

id

id: string

Optionallocked

locked?: boolean

Locked drawings render but cannot be selected or dragged.

paneIndex

paneIndex: number

points

points: DrawingPoint[]

Optionalprops

props?: Record<string, unknown>

Per-tool extras that do not belong on every drawing (a table's cells, a callout's tail side). Keeps the base shape closed while a tool stays free to carry what it needs. Must be JSON-safe: it is persisted verbatim.

style

style: DrawingStyle

Optionaltext

text?: DrawingText

The label (or, for the text tool, the whole content).

tool

tool: string

Registered tool id.

Optionalvisible

visible?: boolean

Default true.

zIndex

zIndex: number

Paint order. Below zero paints under the series, at or above zero paints over it. Ties break by array order, so two drawings at 0 paint in the order they sit in the list.

Settings

Member Visibility

On This Page

Properties