Georeferencing API
    Preparing search index...
    • Attach package-owned overlay, GCP, residual and draft layers/interactions to an existing OpenLayers map.

      Call only in a browser after map creation. Borrowed layers are read without taking ownership. Detach removes owned resources and aborts reference requests while preserving the host map, layers and view. Do not combine this with the ready-made Georeferencer on the same controller/map: that component attaches its own binding.

      Invalid projection definitions or datum grids throw before any resource is attached. Later failures, such as an unknown map projection or a control point that cannot be projected, are reported through the controller error state instead of throwing.

      Parameters

      • map: Map

        Host-owned initialized map.

      • controller: GeoreferencerController

        Authoritative editor store.

      • options: BindingOptions = {}

        Providers, projections, snapping and optional initial framing.

      Returns {
          layers: {
              drafts: VectorLayer<
                  VectorSource<Feature<Geometry, { [x: string]: any }>>,
                  Feature<Geometry, { [x: string]: any }>,
              >;
              gcps: VectorLayer<
                  VectorSource<Feature<Geometry, { [x: string]: any }>>,
                  Feature<Geometry, { [x: string]: any }>,
              >;
              preview: ImageLayer<ImageSource>;
          };
          cancelDrawing(): void;
          detach(): void;
          finishDrawing(): void;
          fitOverlay(): void;
          navigateHistory(direction: -1 | 1): void;
      }

      Binding controls and an idempotent detach method.

      • layers: {
            drafts: VectorLayer<
                VectorSource<Feature<Geometry, { [x: string]: any }>>,
                Feature<Geometry, { [x: string]: any }>,
            >;
            gcps: VectorLayer<
                VectorSource<Feature<Geometry, { [x: string]: any }>>,
                Feature<Geometry, { [x: string]: any }>,
            >;
            preview: ImageLayer<ImageSource>;
        }

        Package-owned layers exposed for display integration; do not persist them or dispose them independently.

        • drafts: VectorLayer<
              VectorSource<Feature<Geometry, { [x: string]: any }>>,
              Feature<Geometry, { [x: string]: any }>,
          >

          Geographic user-drawing display layer.

        • gcps: VectorLayer<
              VectorSource<Feature<Geometry, { [x: string]: any }>>,
              Feature<Geometry, { [x: string]: any }>,
          >

          Target control-point display layer.

        • preview: ImageLayer<ImageSource>

          Transformed raster preview layer.

      • cancelDrawing: function
      • detach: function
        • Idempotently remove only package-owned layers, sources, interactions, listeners and reference jobs. Does not dispose the host map or controller.

          Returns void

      • finishDrawing: function
      • fitOverlay: function
      • navigateHistory: function
        • Navigate map view history: -1 for back, 1 for forward. History resets when the host replaces the view.

          Parameters

          • direction: -1 | 1

          Returns void