Georeferencing API
    Preparing search index...

    Interface Document

    Versioned, JSON-serializable editor document. Use controller methods to change its frozen snapshots; files, map objects and buffers are kept separately.

    interface Document {
        alignmentRevision: number;
        confirmedAlignmentRevision: number | null;
        documentRevision: number;
        featureRevision: number;
        features: Features;
        featuresReviewedAgainstAlignmentRevision: number | null;
        gcps: Gcp[];
        id: string;
        model: Model;
        output: OutputSettings;
        provenanceByFeatureId: Record<
            string,
            {
                createdAgainstAlignmentRevision: number;
                lastReviewedAgainstAlignmentRevision: number
                | null;
                sourceImageId: string;
            },
        >;
        schemaVersion: 1;
        sourceImage: ImageMetadata
        | null;
        workingCrs: string;
    }
    Index
    alignmentRevision confirmedAlignmentRevision documentRevision featureRevision features featuresReviewedAgainstAlignmentRevision gcps id model output provenanceByFeatureId schemaVersion sourceImage workingCrs
    alignmentRevision: number

    Revision advanced by GCP, model or working-CRS changes.

    confirmedAlignmentRevision: number | null

    Exactly the alignment revision explicitly confirmed by the user, or null when unconfirmed.

    documentRevision: number

    Monotonically increasing revision for all committed edits, including undo and redo.

    featureRevision: number

    Revision of the geographic feature draft.

    features: Features

    Geographic drafts in longitude/latitude; re-alignment never moves these coordinates.

    featuresReviewedAgainstAlignmentRevision: number | null

    Alignment revision against which the geographic drawings were reviewed, or null when review is required.

    gcps: Gcp[]

    Control-point pairs, including disabled pairs retained for editing and interchange.

    id: string

    Stable document ID and the scope for host feature replacement/deletions.

    model: Model

    Selected transformation model; invalid fits never fall back to another model.

    output: OutputSettings

    Settings for raster export; no raster export is required to persist features.

    provenanceByFeatureId: Record<
        string,
        {
            createdAgainstAlignmentRevision: number;
            lastReviewedAgainstAlignmentRevision: number
            | null;
            sourceImageId: string;
        },
    >

    Source image and alignment provenance indexed by the corresponding feature ID.

    schemaVersion: 1

    Session format version; unknown versions are rejected by parseSession.

    sourceImage: ImageMetadata | null

    Source identity, or null when no image is selected.

    workingCrs: string

    CRS used for fitting, residuals and overlay preview; does not imply the map-view or output CRS.

    Settings
    Member Visibility

    On This Page
    Properties