Create a controller and validate any initial session. Matching image bytes are restored separately.
Host engine, CRS, lifecycle and persistence callbacks.
Commit an enabled pair with a stable ID and a target coordinate snapshot. Invalidates confirmation/review and schedules fitting.
Canonical original-resolution pixels.
Coordinate in crs.
Target CRS; defaults to working CRS.
Optionalreference: { featureId?: string; sourceId: string }
Optional snapping provenance.
OptionalfeatureId?: stringProvider feature identifier when available.
Identifier of the reference provider used for snapping.
Abort the active export and immediately expose its cancelled state.
Cancel the unfinished pair and return to navigation.
Check image bytes, current fit, confirmation, review and accepted geometry validity.
Handler availability and drawing bounds are additionally checked by save.
Confirm exactly the current valid alignment. Enters drawing mode if enabled; existing drawings still require explicit review. Confirmation is not an undoable edit: undo cannot revoke it, and any later alignment edit invalidates it.
Remove a document feature and its provenance by ID. Requires drawing mode.
Suspend and release retained bytes, previews, history and subscriptions. The host separately disposes its engine when no other editor uses it.
Run an explicitly configured lazy exporter against a frozen revision snapshot. No format is enabled by default. Lazy-load failures are retryable. Cancellation is observable while loading as well as processing, and stale results are ignored.
Registered format ID.
Artifacts for the submitted revision, or null on cancelled/stale/failed processing. Missing configuration, ineligible input and concurrent export reject.
Convenience alias for export("geotiff"). Requires an explicitly registered GeoTIFF plugin; importing core alone never enables or loads an encoder.
Convenience alias for export("world-file"); requires that optional plugin.
Return an eligibility explanation, or null when a configured format can run.
Accepted-geometry errors of the current drawings, computed once per feature revision. Cheap to call during rendering; an empty list means the drawings can be accepted.
Read the stable external-store snapshot without mutating document, fit, raster or UI state.
Inspect and select local bytes, guarding unsaved work before replacement. Accepted replacement creates a new document, cancels old jobs and preserves the host map view.
True on completion; false on cancellation, supersession or load failure. Errors appear in the snapshot.
Navigate bounded image-view history: -1 goes back, 1 goes forward.
Redo an edit while advancing revisions and preserving confirmation rules.
Cancel the previous fit, fit the current alignment and render its preview. Stale results are discarded; failures update snapshot state rather than reject this promise.
Delete a pair and schedule fitting. Requires alignment mode.
Guard unsaved work and clear the image, releasing image-dependent resources. Returns false if cancelled or superseded.
Replace all pairs as one undoable alignment edit, for example after .points import.
Input is cloned.
GeoreferenceError For invalid or duplicate points, or more points than the engine budget.
Expose an error through the snapshot and host callback. AbortError is ignored.
Load a full-resolution display image for precise control-point placement, typically once the image view is zoomed beyond the preview resolution. Idempotent while loading or loaded. Unrotated PNG, JPEG and WebP files are displayed directly; other inputs are normalized by the engine within its budgets. Failures are reported but never block editing, and are not retried for the same image.
Restore a validated session using matching original bytes. SHA-256, dimensions and orientation must match; current unsaved work is guarded.
Whether restoration completed. Invalid JSON/schema rejects before replacement; image mismatch appears in the snapshot.
Leave drawing mode. Later alignment edits invalidate confirmation/review without moving drawings.
Mark current drawings reviewed against the confirmed fit. Does not move or save them. Like confirmation, review is not an undoable edit.
Submit a frozen revision snapshot to the host.
A call for the same document, revision and kind as the in-flight save shares its promise; any other call waits for the in-flight save to settle and then submits its own snapshot. Retries for the same document/revision/kind reuse the request ID. Older request success acknowledges only that revision, leaving newer edits dirty. Draft saves can preserve unconfirmed work; accepted-feature saves require current confirmation, review and valid geometry.
features (default) or draft, selecting the host callback.
GeoreferenceError For missing handlers or ineligible features. Host rejections propagate and retain the draft.
Change transient overlay opacity/visibility without document history.
Optionalopacity?: numberOverlay opacity from 0 to 1.
Optionalvisible?: booleanWhether the overlay is shown.
Replace the explicitly enabled formats without changing session data. Cancels pending export/loading work so a removed format cannot deliver a late result.
Replace geographic drawings as one undoable edit in drawing mode. Requires stable string IDs and JSON properties; topology errors remain editable but block accepted saving.
Install or clear the unsaved-work guard. The ready-made editor installs its own dialog guard while mounted.
Set a canonical-pixel [x, y, width, height] viewport with positive dimensions.
Debounced view history is separate from document undo.
Configure one-way image/map navigation without modifying alignment.
Select the exact model and invalidate confirmation/review. Requires alignment mode.
Replace output settings as one undoable edit. Resampling/no-data changes regenerate preview; output bounds/resolution apply to final export.
Set or cancel the image endpoint of an unfinished pair. Requires image bytes and alignment mode.
Change preview policy without editing the document. Switching to manual cancels an in-flight preview; switching to automatic fits the current complete pairs when the selected model has enough enabled points. Full rank/domain validation remains in the worker. Valid existing results are retained.
Set or remove a provider status without changing the document.
Activate a package tool. Drawing tools require opt-in digitizing and a valid fit in the drawing stage.
Change fitting CRS while preserving GCP target CRSs and geographic drawings. Requires alignment mode.
Resume after suspension, recreating the image URL and restarting fitting if needed. Safe for Strict Mode effect setup.
Subscribe to snapshot changes; returns an unsubscribe function suitable for React
useSyncExternalStore.
Cancel image/fit/export work and revoke the preview and detail URLs, retaining document and source bytes for remount. Pending host saves are not cancelled.
Undo an edit while advancing revisions; historical confirmation cannot revive stale alignment.
Edit either endpoint, target CRS or enabled state by ID. Requires alignment mode and invalidates the fit; unknown IDs are ignored.
GeoreferenceError For nonfinite coordinates or an empty CRS.
Replace host-defined JSON properties, preserving identity and geometry. Unknown IDs are ignored.
Authoritative editor store with revision-safe processing, edit history and host persistence.
Construction is SSR-safe and creates no maps or workers. The host supplies the engine, subscribes to stable snapshots and owns final disposal. Files, object URLs and abort controllers remain outside the serializable document.