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

    Interface BindEditSketchSnappingOptions<T>

    interface BindEditSketchSnappingOptions<T = Record<string, unknown>> {
        config?: Partial<SnappingConfig>;
        index: SnapIndex;
        indicator?: boolean | EditSketchSnapIndicatorOptions;
        model?: EditSketchWorkflowModel<T>;
        pointerEvent?: string;
        onSnap?(resolution: SnapResolution): void;
        onUnsnap?(previous: SnapCandidate): void;
    }

    Type Parameters

    • T = Record<string, unknown>

    Hierarchy (View Summary)

    Index

    Properties

    config?: Partial<SnappingConfig>

    Snapping configuration when no model is bound (or overrides for one-off use).

    index: SnapIndex

    Snap index over the loaded snap-source features.

    indicator?: boolean | EditSketchSnapIndicatorOptions

    Default snap indicator; false disables it.

    Sketch workflow whose snapping config drives resolution and that receives snapped geometry via EditSketchSnappingHandle.applySketchGeometry. When omitted, pass config and consume snaps through events / current.

    pointerEvent?: string

    Pointer event name to listen for.

    "mousemove"
    

    Methods