Georeferencing API
    Preparing search index...

    Interface ApplyCandidateOptions

    Explicit application policy and coordinate conversion supplied by the host.

    interface ApplyCandidateOptions {
        configurationRevision: string;
        definitions?: Definitions;
        maxPoints?: number;
        mode?: "replace" | "merge";
        model?: "keep" | "candidate";
        pixelToMap?: (point: XY) => XY;
    }
    Index
    configurationRevision definitions? maxPoints? mode? model? pixelToMap?
    configurationRevision: string

    Current host configuration revision; must equal the captured token's value.

    definitions?: Definitions

    Additional definitions used by core when converting snapshot/point CRS to the working CRS.

    maxPoints?: number

    Maximum proposed, spatially distributed points; default 16, further capped by free core slots.

    mode?: "replace" | "merge"

    Preserve manual points with merge (default); use replace only after explicit user choice.

    model?: "keep" | "candidate"

    Fit model after application. keep retains the document's model; candidate switches to the matched model (similarity, affine or projective). Defaults to keep when merging into existing points, so a manual fit such as a thin-plate spline is never silently replaced, and to candidate otherwise.

    pixelToMap?: (point: XY) => XY

    Optional exact nonlinear mapping from reference pixel edges to snapshot.crs. Defaults to the snapshot's matrix. This host callback is never sent to workers; use the same mapping when drawing candidate footprints in your application.

    Settings
    Member Visibility

    On This Page
    Properties