Georeferencing API
    Preparing search index...

    Interface EditorSnapshot

    Subscription snapshot combining a frozen document with transient UI and processing state. Read without mutation; persist only document.

    interface EditorSnapshot {
        canRedo: boolean;
        canUndo: boolean;
        detailImageUrl: string | null;
        dirty: boolean;
        document: Document;
        error: string | null;
        errorDetail:
            | {
                code: string;
                message: string;
                operationId?: string;
                recoverable: boolean;
            }
            | null;
        exportFormats: readonly ExportFormat[];
        exporting: Status;
        fit: Fit
        | null;
        fitRevision: number | null;
        fitting: Status;
        imageUrl: string | null;
        imageView: [number, number, number, number] | null;
        linkedNavigation: "off" | "image-to-map" | "map-to-image";
        loading: Status;
        mode: "align" | "draw";
        opacity: number;
        pendingImagePoint: XY | null;
        preview: Raster | null;
        previewMode: PreviewMode;
        progress: number;
        references: Record<string, ReferenceStatus>;
        savedRevision: number | null;
        saving: Status;
        tool: Tool;
        visible: boolean;
    }
    Index
    canRedo canUndo detailImageUrl dirty document error errorDetail exportFormats exporting fit fitRevision fitting imageUrl imageView linkedNavigation loading mode opacity pendingImagePoint preview previewMode progress references savedRevision saving tool visible
    canRedo: boolean

    Whether document edit history has a redo entry.

    canUndo: boolean

    Whether document edit history has an undo entry.

    detailImageUrl: string | null

    Controller-owned full-resolution, orientation-normalized display image URL, or null until requestDetailImage completes. Do not persist or revoke it in host code.

    dirty: boolean

    Whether image-dependent work is newer than both draft and accepted-feature save acknowledgements.

    document: Document

    Authoritative frozen serializable document.

    error: string | null

    Most recent displayable error message, or null.

    errorDetail:
        | {
            code: string;
            message: string;
            operationId?: string;
            recoverable: boolean;
        }
        | null

    Structured details for host-localized errors, or null.

    Type Declaration

    • { code: string; message: string; operationId?: string; recoverable: boolean }
      • code: string

        Machine-readable error category.

      • message: string

        Default human-readable message.

      • OptionaloperationId?: string

        Worker operation ID when available.

      • recoverable: boolean

        Whether the user may correct input and retry.

    • null
    exportFormats: readonly ExportFormat[]

    Configured lazy export descriptors; transient configuration, never session data.

    exporting: Status

    Raster or world-file export state.

    fit: Fit | null

    Current fit, or null while invalid, absent or recalculating.

    fitRevision: number | null

    Alignment revision represented by the fit, or null.

    fitting: Status

    Fit and preview generation state.

    imageUrl: string | null

    Controller-owned normalized preview object URL. Do not persist or revoke it in host code.

    imageView: [number, number, number, number] | null

    Image viewport [x, y, width, height] in canonical pixels; distinct from a min/max extent.

    linkedNavigation: "off" | "image-to-map" | "map-to-image"

    Optional one-way viewport synchronization; off keeps navigation independent.

    loading: Status

    Image inspection/replacement state.

    mode: "align" | "draw"

    Alignment editing or confirmed drawing stage.

    opacity: number

    Transient overlay opacity from 0 to 1.

    pendingImagePoint: XY | null

    Canonical image endpoint awaiting a paired map coordinate, or null.

    preview: Raster | null

    Reduced-resolution warped raster in the working CRS, or null.

    previewMode: PreviewMode

    Transient preview policy; changed through setPreviewMode, not persisted in sessions.

    progress: number

    Export progress fraction from 0 to 1.

    references: Record<string, ReferenceStatus>

    Provider statuses indexed by configured provider ID.

    savedRevision: number | null

    Latest acknowledged accepted-feature revision; draft saves do not set this value.

    saving: Status

    Host persistence state; edits may continue during saving.

    tool: Tool

    Active package interaction.

    visible: boolean

    Whether the transformed overlay is displayed.

    Settings
    Member Visibility

    On This Page
    Properties