Georeferencing API
    Preparing search index...

    Interface BindingOptions

    Attachment configuration for a host-owned OpenLayers map. Keep this object stable when used as a React prop to avoid unnecessary reattachment.

    interface BindingOptions {
        datumGrids?: DatumGrids;
        debounceMs?: number;
        definitions?: Definitions;
        digitizingSnapping?: { drafts?: boolean; references?: boolean };
        geometryTolerancePx?: number;
        initialView?: { crs: string; extent: Extent };
        onReferenceStatus?: (
            id: string,
            status: {
                message?: string;
                partial?: boolean;
                state: "loading" | "ready" | "error";
            },
        ) => void;
        references?: Reference[];
    }
    Index
    datumGrids? debounceMs? definitions? digitizingSnapping? geometryTolerancePx? initialView? onReferenceStatus? references?
    datumGrids?: DatumGrids

    Host-supplied NTv2 buffers registered in this realm; also supply them to the worker engine.

    debounceMs?: number

    Delay before refreshing network references after map navigation, in milliseconds.

    150

    definitions?: Definitions

    Projection definitions registered with proj4 and OpenLayers for map/reference conversion.

    digitizingSnapping?: { drafts?: boolean; references?: boolean }

    Opt-in snapping for drawing/modify tools, independently of GCP reference snapping.

    Type Declaration

    • Optionaldrafts?: boolean

      Snap drawings to the editor's other draft features.

      false

    • Optionalreferences?: boolean

      Snap drawings to providers with snapping configured.

      false

    geometryTolerancePx?: number

    Screen-pixel tolerance used when densifying map geometry into longitude/latitude.

    0.25

    initialView?: { crs: string; extent: Extent }

    Optional map framing applied on attachment. It does not georeference the image or constrain queries, drawings or output.

    Type Declaration

    • crs: string

      CRS of the framing extent.

    • extent: Extent

      Initial map framing bounds.

    onReferenceStatus?: (
        id: string,
        status: {
            message?: string;
            partial?: boolean;
            state: "loading" | "ready" | "error";
        },
    ) => void

    Observe provider loading/error/completeness feedback; statuses also appear in the controller snapshot.

    references?: Reference[]

    Distinct provider configurations; borrowed layers remain entirely host-owned.

    Settings
    Member Visibility

    On This Page
    Properties