SDK JS
    Preparing search index...

    Interface DrawState

    The draw-interaction state machine.

    interface DrawState {
        hover: DrawVertex | null;
        mode: "polyline" | "polygon";
        phase: "idle" | "done" | "drawing";
        vertices: readonly DrawVertex[];
    }
    Index

    Properties

    hover mode phase vertices

    Properties

    hover: DrawVertex | null

    The live cursor preview vertex while drawing, else null.

    mode: "polyline" | "polygon"

    'polyline' (distance / profile) or 'polygon' (area).

    phase: "idle" | "done" | "drawing"

    'idle' (not drawing) → 'drawing' (click adds vertices) → 'done' (shape finished).

    vertices: readonly DrawVertex[]

    The placed vertices, in click order.

    Settings

    Member Visibility

    On This Page

    Properties