@honua/sdk-js
    Preparing search index...

    Interface CreateTerraDrawSketchOptions<T>Experimental

    interface CreateTerraDrawSketchOptions<T = Record<string, unknown>> {
        applyGeometry?: (
            tool: EditSketchTool,
            geometry: Record<string, unknown> | null,
        ) => boolean;
        featureFilter?: (
            id: TerraDrawSketchFeatureId,
            feature: TerraDrawSketchFeature,
        ) => boolean;
        model: EditSketchWorkflowModel<T>;
        onDelete?: (featureId: TerraDrawSketchFeatureId) => void;
        onDeselect?: (featureId: TerraDrawSketchFeatureId) => void;
        onFinish?: (event: TerraDrawSketchFinishEvent) => void;
        onSelect?: (featureId: TerraDrawSketchFeatureId) => void;
        restoreGeometry?: (
            geometry: Record<string, unknown>,
        ) => Record<string, unknown>;
        snapping?: CreateTerraDrawSnappingOptions<T>;
        toolForMode?: (mode: string) => EditSketchTool | undefined;
        transformGeometry?: (
            geometry: Record<string, unknown>,
        ) => Record<string, unknown>;
    }

    Type Parameters

    • T = Record<string, unknown>

    Hierarchy

    Index

    Properties

    applyGeometry? featureFilter? model onDelete? onDeselect? onFinish? onSelect? restoreGeometry? snapping? toolForMode? transformGeometry?

    Properties

    applyGeometry?: (
        tool: EditSketchTool,
        geometry: Record<string, unknown> | null,
    ) => boolean

    Type Declaration

      • (tool: EditSketchTool, geometry: Record<string, unknown> | null): boolean

      • Optional owning-workflow writer; replaces the model write, preserving one undo entry.

        Parameters

        Returns boolean

    featureFilter?: (
        id: TerraDrawSketchFeatureId,
        feature: TerraDrawSketchFeature,
    ) => boolean

    Type Declaration

    model: EditSketchWorkflowModel<T>

    Sketch workflow that receives finished geometries.

    onDelete?: (featureId: TerraDrawSketchFeatureId) => void

    Type Declaration

    onDeselect?: (featureId: TerraDrawSketchFeatureId) => void
    onFinish?: (event: TerraDrawSketchFinishEvent) => void

    Type Declaration

    onSelect?: (featureId: TerraDrawSketchFeatureId) => void
    restoreGeometry?: (geometry: Record<string, unknown>) => Record<string, unknown>

    Type Declaration

      • (geometry: Record<string, unknown>): Record<string, unknown>

      • Inverse of BindTerraDrawSketchOptions.transformGeometry, used when pushing model geometry back into terra-draw after undo/redo.

        Parameters

        • geometry: Record<string, unknown>

        Returns Record<string, unknown>

    snapping?: CreateTerraDrawSnappingOptions<T>

    Wire SDK snapping into the linestring/polygon modes' toCustom hook.

    toolForMode?: (mode: string) => EditSketchTool | undefined

    Type Declaration

      • (mode: string): EditSketchTool | undefined

      • Override the terra-draw mode → sketch tool mapping.

        Parameters

        • mode: string

        Returns EditSketchTool | undefined

    transformGeometry?: (
        geometry: Record<string, unknown>,
    ) => Record<string, unknown>

    Type Declaration

      • (geometry: Record<string, unknown>): Record<string, unknown>

      • Transform a completed terra-draw geometry (always EPSG:4326 GeoJSON) before it reaches the model — e.g. (g) => toWebMercator(g, 4326) from @honua/sdk-js/geometry when the edit source stores Web Mercator.

        Parameters

        • geometry: Record<string, unknown>

        Returns Record<string, unknown>

    Settings

    Member Visibility

    On This Page

    Properties