supervision-js
    Preparing search index...

    Interface DraftUndoAnnotationEditingEngine

    The built-in editing engine guarantees multi-click draft Undo.

    interface DraftUndoAnnotationEditingEngine {
        getState(): AnnotationEditingState;
        setCreationTool(tool: AnnotationCreationTool | null): void;
        pointerDown(
            input: AnnotationPointerInput,
            pick?: DetectionPickResult | null,
        ): void;
        pointerMove(input: AnnotationPointerInput): void;
        pointerUp(input: AnnotationPointerInput): void;
        keyDown(key: string): void;
        beginHandleDrag(
            detection: Detection,
            handle: AnnotationHandleDefinition,
            input: AnnotationPointerInput,
        ): void;
        deleteVertex(detection: Detection, vertexIndex: number): Detection | null;
        cancel(): void;
        hasCreationTool(): boolean;
        subscribe(listener: (state: AnnotationEditingState) => void): () => void;
        subscribeFastTranslate(
            listener: (id: string | number, dx: number, dy: number) => void,
        ): () => void;
        undoCreation(): boolean;
    }

    Hierarchy (View Summary)

    Index
    getState setCreationTool pointerDown pointerMove pointerUp keyDown beginHandleDrag deleteVertex cancel hasCreationTool subscribe subscribeFastTranslate undoCreation

    • Parameters

      • key: string

      Returns void

    • Parameters

      • listener: (id: string | number, dx: number, dy: number) => void

      Returns () => void

    • Remove the last multi-click draft vertex. Returns false when no path is active. Consumes the final vertex by cancelling the draft, without committing it.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Methods