Georeference images in the browser against an existing OpenLayers map: load a local image, pair image points with map locations, fit one of seven QGIS-style transformations, export a GeoTIFF and optionally draw features that your application persists. Decoding, fitting and warping run in browser workers; no backend is required.
| Package | Responsibility |
|---|---|
| @georeferencing/core | Documents, controller, transforms, projections, worker processing, reference data and the OpenLayers map binding |
| @georeferencing/plugins | Opt-in GeoTIFF, JPEG, PDF and data exports, each loaded only when used |
| @georeferencing/react | Ready-made editor, composable panels, subscription hook and scoped styles |
Install the same version of every @georeferencing/* package. Plugins and React
declare core as a peer dependency, so they share your application's copy. Core enables
no output formats by default; add only the plugins your host needs.
For an end-to-end host application, begin with the integration guide.
| Guide | What it covers |
|---|---|
| Capabilities and limits | Models, formats, resource budgets and integration boundaries |
| Getting started | Installation, version alignment, a typed host-map integration and composable UI |
| Optional export plugins | Format configuration, results and custom exporters |
| Coordinates and raster output | Pixel conventions, CRS spaces, models, residual formulas, resampling and output limits |
| Reference data | WFS axes/paging/authentication, borrowed layers, custom loaders, snapping and incomplete results |
| Lifecycle and saving | Image replacement, guards, confirmation, review, immutable saves and resource ownership |
| Workers, packaging and deployment | Lazy assets, budgets, cancellation, npm packaging, CSP and static hosting |
The navigation is organized by package, then by import path. Each entry point's page lists its classes, interfaces, functions and types.
| Import | Purpose |
|---|---|
@georeferencing/core (also /core) |
Serializable documents, controller, transforms, projections, geometry and interchange |
| @georeferencing/core/engine | Lazy processing workers, raster helpers and scheduler |
| @georeferencing/core/openlayers | Host-map integration, reference providers and WFS discovery |
| @georeferencing/core/encoder-worker | Protocol for custom raster codec workers |
@georeferencing/core/worker |
Bundled processing-worker script |
| @georeferencing/plugins | All lazy format factories; prefer the per-format entries below |
| /geotiff, /jpeg, /pdf, /data | One export format family each |
| @georeferencing/plugins/tiff | Low-level TIFF encoding and validation |
| @georeferencing/plugins/report | Low-level PDF creation and optional map capture |
| @georeferencing/plugins/serializers | Pure QGIS points, world-file and accuracy-report serializers |
@georeferencing/plugins/geotiff-worker, /jpeg-worker |
Bundled codec-worker scripts |
| @georeferencing/react | Ready-made editor, panels, types and subscription hook |
@georeferencing/react/styles.css |
Optional scoped editor styles |
Worker script entries have no API of their own: load them as workers (the deployment guide shows how), not as ordinary or SSR imports. API signatures and guides keep source pixels, reference/working/map CRSs, raster output and geographic features separate. The packages and this documentation are MIT licensed; redistributing the library workers also requires their bundled notices.