Georeferencing API
    Preparing search index...

    Interface LeafletOptions

    Options of the Leaflet adapter. Keep this object stable: it is read when attaching. WFS references must return GeoJSON (responseFormat: "geojson").

    interface LeafletOptions {
        datumGrids?: DatumGrids;
        debounceMs?: number;
        definitions?: Definitions;
        digitizingSnapping?: { drafts?: boolean; references?: boolean };
        initialView?: { crs: string; extent: Extent };
        lib: __module;
        onReferenceStatus?: (id: string, status: ReferenceLoadStatus) => void;
        references?: readonly ReferenceSource[];
    }

    Hierarchy (View Summary)

    Index
    datumGrids? debounceMs? definitions? digitizingSnapping? initialView? lib 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

    Host projection definitions for maps, references and control-point targets.

    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

    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.

    lib: __module

    The Leaflet module, for example import L from "leaflet". It is passed in rather than imported, so this package stays importable during server-side rendering and works with a Leaflet loaded as a global.

    onReferenceStatus?: (id: string, status: ReferenceLoadStatus) => void

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

    references?: readonly ReferenceSource[]

    Reference providers with unique IDs, displayed and optionally used for snapping.

    Settings
    Member Visibility

    On This Page
    Properties