@emuanalytics/flow-rdf-core 4.0.0-preview.2 → 4.0.0-preview.3

package/dist/lib/map/plugins/index.cjs

@@ -17,6 +17,7 @@ const turfCircle = require('@turf/circle');
 const turfDistance = require('@turf/distance');
 const helpers = require('@turf/helpers');
 const mobx = require('mobx');
+const fileSaver = require('file-saver');
 require('@emuanalytics/maplibre-gl-style-spec');
 require('mobx-utils');
 require('parsimmon');
@@ -51,21 +52,21 @@ const maplibre__default = /*#__PURE__*/_interopDefaultCompat(maplibre);
 const turfCircle__default = /*#__PURE__*/_interopDefaultCompat(turfCircle);
 const turfDistance__default = /*#__PURE__*/_interopDefaultCompat(turfDistance);
 
-var __defProp$a = Object.defineProperty;
-var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$a = (obj, key, value) => {
-  __defNormalProp$a(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$c = Object.defineProperty;
+var __defNormalProp$c = (obj, key, value) => key in obj ? __defProp$c(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$c = (obj, key, value) => {
+  __defNormalProp$c(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class AnnotationEvent extends mapFeatureStream.MapEvent {
   constructor(type, map, data) {
     super(type, map);
-    __publicField$a(this, "mode");
-    __publicField$a(this, "canUndo");
-    __publicField$a(this, "canRedo");
-    __publicField$a(this, "activeFeatureId");
-    __publicField$a(this, "activeFeatureType");
-    __publicField$a(this, "features");
+    __publicField$c(this, "mode");
+    __publicField$c(this, "canUndo");
+    __publicField$c(this, "canRedo");
+    __publicField$c(this, "activeFeatureId");
+    __publicField$c(this, "activeFeatureType");
+    __publicField$c(this, "features");
     this.mode = data.mode;
     this.canUndo = data.canUndo;
     this.canRedo = data.canRedo;
@@ -75,17 +76,17 @@ class AnnotationEvent extends mapFeatureStream.MapEvent {
   }
 }
 
-var __defProp$9 = Object.defineProperty;
-var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$9 = (obj, key, value) => {
-  __defNormalProp$9(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$b = Object.defineProperty;
+var __defNormalProp$b = (obj, key, value) => key in obj ? __defProp$b(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$b = (obj, key, value) => {
+  __defNormalProp$b(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class MapPluginBase extends EventEmitter.EventEmitter {
   constructor(pluginManager, options) {
     super();
-    __publicField$9(this, "_pluginManager");
-    __publicField$9(this, "options");
+    __publicField$b(this, "_pluginManager");
+    __publicField$b(this, "options");
     this._pluginManager = pluginManager;
     this.options = options ?? {};
   }
@@ -101,10 +102,10 @@ function isFeatureWithId(f) {
   return stringUtils.isDefined(f) && stringUtils.isDefined(f.source) && stringUtils.isDefined(f.id);
 }
 
-var __defProp$8 = Object.defineProperty;
-var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$8 = (obj, key, value) => {
-  __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$a = Object.defineProperty;
+var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$a = (obj, key, value) => {
+  __defNormalProp$a(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 Debug__default("flow:map-popup");
@@ -121,12 +122,12 @@ class MapPopup extends EventEmitter__default {
     super();
     this.map = map;
     this.options = options;
-    __publicField$8(this, "_feature");
-    __publicField$8(this, "_contentContainer");
-    __publicField$8(this, "_featureStream", null);
+    __publicField$a(this, "_feature");
+    __publicField$a(this, "_contentContainer");
+    __publicField$a(this, "_featureStream", null);
     //private _featureStreamSubscription: ISubscription | null = null;
-    __publicField$8(this, "_maplibrePopup", null);
-    __publicField$8(this, "_featureStreamDisposer");
+    __publicField$a(this, "_maplibrePopup", null);
+    __publicField$a(this, "_featureStreamDisposer");
     this.options = {
       // Defaults
       closeButton: true,
@@ -251,18 +252,18 @@ class MapPopup extends EventEmitter__default {
   }
 }
 
-var __defProp$7 = Object.defineProperty;
-var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$7 = (obj, key, value) => {
-  __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$9 = Object.defineProperty;
+var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$9 = (obj, key, value) => {
+  __defNormalProp$9(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class PopupPlugin extends MapPluginBase {
   constructor(pluginManager) {
     super(pluginManager);
-    __publicField$7(this, "_popupTemplates", /* @__PURE__ */ new Map());
-    __publicField$7(this, "_popups", /* @__PURE__ */ new Set());
-    __publicField$7(this, "name", "PopupPlugin");
+    __publicField$9(this, "_popupTemplates", /* @__PURE__ */ new Map());
+    __publicField$9(this, "_popups", /* @__PURE__ */ new Set());
+    __publicField$9(this, "name", "PopupPlugin");
   }
   registerPopup(id, options) {
     this._popupTemplates.set(id, options);
@@ -299,40 +300,40 @@ class PopupPlugin extends MapPluginBase {
   }
 }
 
-var __defProp$6 = Object.defineProperty;
-var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$6 = (obj, key, value) => {
-  __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$8 = Object.defineProperty;
+var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$8 = (obj, key, value) => {
+  __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class SelectionEvent extends mapFeatureStream.MapEvent {
   constructor(type, map, sourceIdentifier, features) {
     super(type, map);
-    __publicField$6(this, "source");
-    __publicField$6(this, "sourceLayer");
-    __publicField$6(this, "features");
+    __publicField$8(this, "source");
+    __publicField$8(this, "sourceLayer");
+    __publicField$8(this, "features");
     this.source = sourceIdentifier.source;
     this.sourceLayer = sourceIdentifier.sourceLayer;
     this.features = features;
   }
 }
 
-var __defProp$5 = Object.defineProperty;
-var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$5 = (obj, key, value) => {
-  __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$7 = Object.defineProperty;
+var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$7 = (obj, key, value) => {
+  __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class SourceSelection {
   constructor(plugin, source, options) {
-    __publicField$5(this, "_featureStream");
-    __publicField$5(this, "_map");
-    __publicField$5(this, "_options");
-    __publicField$5(this, "_plugin");
-    __publicField$5(this, "_popups", /* @__PURE__ */ new Map());
-    __publicField$5(this, "_selectedFeatureIds", /* @__PURE__ */ new Set());
-    __publicField$5(this, "_sourceId");
-    __publicField$5(this, "_stateSubscription", null);
+    __publicField$7(this, "_featureStream");
+    __publicField$7(this, "_map");
+    __publicField$7(this, "_options");
+    __publicField$7(this, "_plugin");
+    __publicField$7(this, "_popups", /* @__PURE__ */ new Map());
+    __publicField$7(this, "_selectedFeatureIds", /* @__PURE__ */ new Set());
+    __publicField$7(this, "_sourceId");
+    __publicField$7(this, "_stateSubscription", null);
     this._plugin = plugin;
     this._map = plugin.map;
     this._options = options;
@@ -465,18 +466,18 @@ class SourceSelection {
   }
 }
 
-var __defProp$4 = Object.defineProperty;
-var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$4 = (obj, key, value) => {
-  __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$6 = Object.defineProperty;
+var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$6 = (obj, key, value) => {
+  __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class SelectionPlugin extends MapPluginBase {
   constructor(pluginManager) {
     super(pluginManager);
-    __publicField$4(this, "_sourceSelections", /* @__PURE__ */ new Map());
-    __publicField$4(this, "_enablePopups", true);
-    __publicField$4(this, "name", "SelectionPlugin");
+    __publicField$6(this, "_sourceSelections", /* @__PURE__ */ new Map());
+    __publicField$6(this, "_enablePopups", true);
+    __publicField$6(this, "name", "SelectionPlugin");
   }
   clearSelection(source) {
     const sourceSelection = this._sourceSelections.get(source);
@@ -899,31 +900,31 @@ DragCircleMode.toDisplayFeatures = function(state, geojson, display) {
 };
 const DragCircleMode$1 = DragCircleMode;
 
-var __defProp$3 = Object.defineProperty;
-var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$3 = (obj, key, value) => {
-  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$5 = Object.defineProperty;
+var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$5 = (obj, key, value) => {
+  __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 Debug__default("flow:annotation-plugin");
 const _AnnotationPlugin = class _AnnotationPlugin extends MapPluginBase {
   constructor(pluginManager, options) {
     super(pluginManager, options);
-    __publicField$3(this, "name", "AnnotationPlugin");
+    __publicField$5(this, "name", "AnnotationPlugin");
     // Feature data model
-    __publicField$3(this, "_features", /* @__PURE__ */ new Map());
-    __publicField$3(this, "_featureIds", []);
+    __publicField$5(this, "_features", /* @__PURE__ */ new Map());
+    __publicField$5(this, "_featureIds", []);
     // Undo/redo stacks
-    __publicField$3(this, "_undoStack", []);
-    __publicField$3(this, "_redoStack", []);
+    __publicField$5(this, "_undoStack", []);
+    __publicField$5(this, "_redoStack", []);
     // Editing state
-    __publicField$3(this, "_mode", "idle");
-    __publicField$3(this, "_activeFeatureId", null);
-    __publicField$3(this, "_activeFeatureType", null);
-    __publicField$3(this, "_onCommitCleanup", []);
-    __publicField$3(this, "_annotationDataSource");
-    __publicField$3(this, "_drawControl", null);
-    __publicField$3(this, "_removeKeyboardShortcuts", null);
+    __publicField$5(this, "_mode", "idle");
+    __publicField$5(this, "_activeFeatureId", null);
+    __publicField$5(this, "_activeFeatureType", null);
+    __publicField$5(this, "_onCommitCleanup", []);
+    __publicField$5(this, "_annotationDataSource");
+    __publicField$5(this, "_drawControl", null);
+    __publicField$5(this, "_removeKeyboardShortcuts", null);
     this.options = { ..._AnnotationPlugin._defaultOptions, ...options };
     this.options.defaultStyle = { ..._AnnotationPlugin._defaultOptions.defaultStyle, ...options?.defaultStyle };
   }
@@ -1356,7 +1357,7 @@ const _AnnotationPlugin = class _AnnotationPlugin extends MapPluginBase {
     this.emit("annotationStateChanged", new AnnotationEvent("annotationStateChanged", this.map, eventData));
   }
 };
-__publicField$3(_AnnotationPlugin, "_defaultOptions", {
+__publicField$5(_AnnotationPlugin, "_defaultOptions", {
   interactive: true,
   defaultStyle: {
     labelSize: 10,
@@ -1378,10 +1379,10 @@ __publicField$3(_AnnotationPlugin, "_defaultOptions", {
 });
 let AnnotationPlugin = _AnnotationPlugin;
 
-var __defProp$2 = Object.defineProperty;
-var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$2 = (obj, key, value) => {
-  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$4 = Object.defineProperty;
+var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$4 = (obj, key, value) => {
+  __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 const debug$1 = Debug__default("flow:data-join-map-plugin");
@@ -1389,10 +1390,10 @@ const _DataJoin = class _DataJoin {
   constructor(id, map, options) {
     this.id = id;
     this.map = map;
-    __publicField$2(this, "autorunDisposer", null);
-    __publicField$2(this, "dataExpression", null);
-    __publicField$2(this, "options");
-    __publicField$2(this, "parameterExpressions", {});
+    __publicField$4(this, "autorunDisposer", null);
+    __publicField$4(this, "dataExpression", null);
+    __publicField$4(this, "options");
+    __publicField$4(this, "parameterExpressions", {});
     this.options = {
       ..._DataJoin.defaultOptions,
       ...options
@@ -1499,7 +1500,7 @@ const _DataJoin = class _DataJoin {
     }
   }
 };
-__publicField$2(_DataJoin, "defaultOptions", {
+__publicField$4(_DataJoin, "defaultOptions", {
   clear: false,
   parameters: []
 });
@@ -1507,8 +1508,8 @@ let DataJoin = _DataJoin;
 class DataJoinPlugin extends MapPluginBase {
   constructor(pluginManager) {
     super(pluginManager);
-    __publicField$2(this, "_joins", /* @__PURE__ */ new Map());
-    __publicField$2(this, "name", "DataJoinPlugin");
+    __publicField$4(this, "_joins", /* @__PURE__ */ new Map());
+    __publicField$4(this, "name", "DataJoinPlugin");
   }
   addDataJoin(id, options) {
     const dataJoin = new DataJoin(id, this.map, options);
@@ -1541,6 +1542,194 @@ class DataJoinPlugin extends MapPluginBase {
   }
 }
 
+var __defProp$3 = Object.defineProperty;
+var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$3 = (obj, key, value) => {
+  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+const _MapExporter = class _MapExporter {
+  constructor(map) {
+    this.map = map;
+    __publicField$3(this, "nativePixelRatio", window.devicePixelRatio);
+  }
+  async export(options) {
+    options = { ..._MapExporter.defaultOptions, ...options };
+    const [container, mapCopy] = await this.createMapCopy(options);
+    return new Promise((resolve, reject) => {
+      const fileName = `${options.name}.${options.format}`;
+      const mapCanvas = mapCopy.getCanvas();
+      const exportCanvas = this.createExportCanvas(container, mapCanvas);
+      const exportContext = exportCanvas.getContext("2d");
+      if (!exportContext) {
+        this.destroyMapCopy(container, mapCopy);
+        reject(new Error("Failed to create export canvas context"));
+        return;
+      }
+      const drawOverlayCallback = (err) => {
+        if (err) {
+          this.destroyMapCopy(container, mapCopy);
+          reject(err);
+        } else {
+          switch (options.format) {
+            case "png":
+              exportCanvas.toBlob((blob) => {
+                blob && fileSaver.saveAs(blob, fileName);
+              });
+              break;
+            case "pdf":
+              throw new Error("Export to PDF is not currently supported");
+          }
+          this.destroyMapCopy(container, mapCopy);
+          resolve(fileName);
+        }
+      };
+      const mapImage = new Image();
+      mapImage.onload = () => {
+        exportContext.drawImage(mapImage, 0, 0);
+        if (stringUtils.isFunction(options.drawOverlayFn)) {
+          options.drawOverlayFn(
+            exportContext,
+            exportCanvas.width,
+            exportCanvas.height,
+            options.dpmm,
+            drawOverlayCallback
+          );
+        } else {
+          drawOverlayCallback(null);
+        }
+      };
+      mapImage.src = mapCopy.getCanvas().toDataURL();
+    });
+  }
+  createMapCopy(options) {
+    const geoBounds = options.bounds || this.map.maplibreMap.getBounds().toArray().flat();
+    const geoBottomLeft = [geoBounds[0], geoBounds[1]];
+    const geoTopRight = [geoBounds[2], geoBounds[3]];
+    const geoCenter = [
+      (geoBottomLeft[0] + geoTopRight[0]) / 2,
+      (geoBottomLeft[1] + geoTopRight[1]) / 2
+    ];
+    const pxBottomLeft = this.map.maplibreMap.project(geoBottomLeft);
+    const pxTopRight = this.map.maplibreMap.project(geoTopRight);
+    const pxWidth = pxTopRight.x - pxBottomLeft.x;
+    const pxHeight = pxBottomLeft.y - pxTopRight.y;
+    const exportWidth = options.width * options.dpmm;
+    const exportHeight = options.height * options.dpmm;
+    const aspectRatios = {
+      width: pxWidth / exportWidth,
+      height: pxHeight / exportHeight
+    };
+    const coverRatio = Math.max(aspectRatios.width, aspectRatios.height);
+    const copyWidth = exportWidth * coverRatio;
+    const copyHeight = exportHeight * coverRatio;
+    const pixelRatio = exportWidth / copyWidth;
+    this.setDevicePixelRatio(pixelRatio);
+    const container = document.createElement("div");
+    container.id = mapFeatureStream.randomId("export");
+    container.classList.add("maplibregl-export-container");
+    container.style.width = `${copyWidth}px`;
+    container.style.height = `${copyHeight}px`;
+    this.map.container.insertBefore(container, this.map.container.firstChild);
+    const mapCopy = new maplibre__default.Map({
+      container,
+      center: geoCenter,
+      zoom: this.map.maplibreMap.getZoom(),
+      style: { ...this.map.maplibreMap.getStyle(), transition: { delay: 0, duration: 0 } },
+      bearing: this.map.maplibreMap.getBearing(),
+      pitch: this.map.maplibreMap.getPitch(),
+      interactive: false,
+      attributionControl: false,
+      fadeDuration: 0,
+      preserveDrawingBuffer: true,
+      transformRequest: this.transformMapRequest.bind(this)
+    });
+    mapCopy.on("styleimagemissing", this.handleMissingImage.bind(this));
+    return new Promise((resolve) => {
+      mapCopy.once("load", () => {
+        Object.keys(this.map.maplibreMap.style.sourceCaches).forEach((sourceId) => {
+          mapCopy.style.sourceCaches[sourceId]._state.stateChanges = this.map.maplibreMap.style.sourceCaches[sourceId]._state.state;
+        });
+        mapCopy._update();
+        setTimeout(() => resolve([container, mapCopy]), 500);
+      });
+    });
+  }
+  destroyMapCopy(container, map) {
+    this.setDevicePixelRatio(this.nativePixelRatio);
+    map.remove();
+    container.parentNode.removeChild(container);
+  }
+  createExportCanvas(container, mapCanvas) {
+    const canvasContainer = container.getElementsByClassName("maplibregl-canvas-container")[0];
+    const overlayCanvas = document.createElement("canvas");
+    overlayCanvas.id = mapFeatureStream.randomId("overlay");
+    overlayCanvas.width = mapCanvas.width;
+    overlayCanvas.height = mapCanvas.height;
+    overlayCanvas.style.position = "absolute";
+    overlayCanvas.style.width = mapCanvas.style.width;
+    overlayCanvas.style.height = mapCanvas.style.height;
+    canvasContainer.appendChild(overlayCanvas);
+    return overlayCanvas;
+  }
+  setDevicePixelRatio(pixelRatio) {
+    Object.defineProperty(window, "devicePixelRatio", {
+      get: () => pixelRatio
+    });
+  }
+  async handleMissingImage(e) {
+    const imageInfo = this.map.imageRegistry.getImage(e.id);
+    if (imageInfo === this.map.imageRegistry.unknownImage) {
+      console.error(`Map ${this.map.id}: Image '${e.id}' not registered`);
+    }
+    if (!imageInfo.image.complete) {
+      imageInfo.image.onload = () => {
+        this.map.maplibreMap.updateImage(e.id, imageInfo.image);
+        this.map.maplibreMap.redraw();
+      };
+    }
+    this.map.maplibreMap.addImage(e.id, imageInfo.image, {
+      pixelRatio: imageInfo.pixelDensity,
+      sdf: imageInfo.recolor
+    });
+  }
+  transformMapRequest(url, _resourceType) {
+    if (this.map.context.flowClient.accessToken && url.startsWith(this.map.context.flowClient.baseUrl)) {
+      return {
+        url,
+        headers: { Authorization: `Bearer ${this.map.context.flowClient.accessToken}` }
+      };
+    } else {
+      return { url };
+    }
+  }
+};
+__publicField$3(_MapExporter, "defaultOptions", {
+  name: "map",
+  width: 297,
+  height: 210,
+  dpmm: 12,
+  format: "png"
+});
+let MapExporter = _MapExporter;
+
+var __defProp$2 = Object.defineProperty;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$2 = (obj, key, value) => {
+  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class ExportPlugin extends MapPluginBase {
+  constructor(pluginManager) {
+    super(pluginManager);
+    __publicField$2(this, "name", "ExportPlugin");
+  }
+  exportMap(options) {
+    const mapExporter = new MapExporter(this.map);
+    return mapExporter.export(options);
+  }
+}
+
 var __defProp$1 = Object.defineProperty;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$1 = (obj, key, value) => {
@@ -1650,6 +1839,7 @@ exports.AnnotationEvent = AnnotationEvent;
 exports.AnnotationPlugin = AnnotationPlugin;
 exports.DataJoin = DataJoin;
 exports.DataJoinPlugin = DataJoinPlugin;
+exports.ExportPlugin = ExportPlugin;
 exports.HoverEffectPlugin = HoverEffectPlugin;
 exports.MapPluginBase = MapPluginBase;
 exports.PopupPlugin = PopupPlugin;

package/dist/lib/map/plugins/index.d.cts

@@ -1,5 +1,5 @@
-import { Y as MapEvent, y as FlowMap, w as MapSourceIdentifier, Z as MapFeatureId, _ as MapPluginBase, $ as PluginManager, a0 as MapSourceEvent, a1 as MapMouseEvent, a2 as MapFeatureStream, a3 as PartialBy, r as MapAnimationOptions, a4 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, u as MapFeatureIdentifier, t as MapFeature } from '../../../shared/flow-rdf-core.42d7cda4.cjs';
-export { a8 as EventHandlers, a7 as PluginConstructor, a6 as PluginEventsType, a5 as PluginOptionsType } from '../../../shared/flow-rdf-core.42d7cda4.cjs';
+import { Z as MapEvent, y as FlowMap, w as MapSourceIdentifier, _ as MapFeatureId, $ as MapPluginBase, a0 as PluginManager, a1 as MapSourceEvent, a2 as MapMouseEvent, a3 as MapFeatureStream, a4 as PartialBy, r as MapAnimationOptions, a5 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, u as MapFeatureIdentifier, t as MapFeature } from '../../../shared/flow-rdf-core.2f79285b.cjs';
+export { a9 as EventHandlers, a8 as PluginConstructor, a7 as PluginEventsType, a6 as PluginOptionsType } from '../../../shared/flow-rdf-core.2f79285b.cjs';
 import { F as Func } from '../../../shared/flow-rdf-core.08975378.cjs';
 import EventEmitter from 'eventemitter3';
 import * as lit from 'lit-html';
@@ -206,6 +206,42 @@ declare class DataJoinPlugin extends MapPluginBase {
     removeDataJoin(id: string): void;
 }
 
+/** Callback function to indicate map export overlay drawing has finished. */
+type DrawOverlayCallback = (error: Error) => void;
+/** Function to draw an overlay on an exported map. */
+type DrawOverlayFn = (ctx: CanvasRenderingContext2D, width: number, height: number, dpmm: number, callback: DrawOverlayCallback) => void;
+/**
+ * Options for [[FlowCoreMap.export]].
+ */
+interface FlowMapExportOptions {
+    /** Name of exported file. */
+    name: string;
+    /** Width of exported map in millimeters. */
+    width: number;
+    /** Height of exported map in millimeters. */
+    height: number;
+    /** Resolution of exported map. Dots/mm. */
+    dpmm: number;
+    /** Format of exported map. */
+    format: 'png' | 'pdf';
+    /**
+     * Geographic bounds of area to export ([left, bottom, right top]).
+     *
+     * This should be a subregion of the full map area.
+     */
+    bounds?: number[];
+    /** Function called to draw overlay on exported map. */
+    drawOverlayFn?: DrawOverlayFn;
+}
+
+interface ExportPluginOptions {
+}
+declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
+    readonly name = "ExportPlugin";
+    constructor(pluginManager: PluginManager);
+    exportMap(options: FlowMapExportOptions): Promise<string>;
+}
+
 declare class HoverEffectPlugin extends MapPluginBase {
     private hoveredFeature;
     readonly name = "HoverEffectPlugin";
@@ -306,4 +342,4 @@ declare class UrlSyncPlugin extends MapPluginBase {
     private hashToMapState;
 }
 
-export { AnnotationEvent, AnnotationEventData, AnnotationEventType, AnnotationEventTypes, AnnotationFeature, AnnotationFeatureProps, AnnotationFeatureType, AnnotationMode, AnnotationOperation, AnnotationPlugin, AnnotationPluginOptions, AnnotationStyle, AnnotationsServiceConfig, DataJoin, DataJoinOptions, DataJoinPlugin, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, SelectionEventType, SelectionEventTypes, SelectionMode, SelectionOptions, SelectionPlugin, UrlSyncPlugin };
+export { AnnotationEvent, AnnotationEventData, AnnotationEventType, AnnotationEventTypes, AnnotationFeature, AnnotationFeatureProps, AnnotationFeatureType, AnnotationMode, AnnotationOperation, AnnotationPlugin, AnnotationPluginOptions, AnnotationStyle, AnnotationsServiceConfig, DataJoin, DataJoinOptions, DataJoinPlugin, DrawOverlayCallback, DrawOverlayFn, ExportPlugin, ExportPluginOptions, FlowMapExportOptions, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, SelectionEventType, SelectionEventTypes, SelectionMode, SelectionOptions, SelectionPlugin, UrlSyncPlugin };

package/dist/lib/map/plugins/index.d.mts

@@ -1,5 +1,5 @@
-import { Y as MapEvent, y as FlowMap, w as MapSourceIdentifier, Z as MapFeatureId, _ as MapPluginBase, $ as PluginManager, a0 as MapSourceEvent, a1 as MapMouseEvent, a2 as MapFeatureStream, a3 as PartialBy, r as MapAnimationOptions, a4 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, u as MapFeatureIdentifier, t as MapFeature } from '../../../shared/flow-rdf-core.42d7cda4.mjs';
-export { a8 as EventHandlers, a7 as PluginConstructor, a6 as PluginEventsType, a5 as PluginOptionsType } from '../../../shared/flow-rdf-core.42d7cda4.mjs';
+import { Z as MapEvent, y as FlowMap, w as MapSourceIdentifier, _ as MapFeatureId, $ as MapPluginBase, a0 as PluginManager, a1 as MapSourceEvent, a2 as MapMouseEvent, a3 as MapFeatureStream, a4 as PartialBy, r as MapAnimationOptions, a5 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, u as MapFeatureIdentifier, t as MapFeature } from '../../../shared/flow-rdf-core.2f79285b.mjs';
+export { a9 as EventHandlers, a8 as PluginConstructor, a7 as PluginEventsType, a6 as PluginOptionsType } from '../../../shared/flow-rdf-core.2f79285b.mjs';
 import { F as Func } from '../../../shared/flow-rdf-core.08975378.mjs';
 import EventEmitter from 'eventemitter3';
 import * as lit from 'lit-html';
@@ -206,6 +206,42 @@ declare class DataJoinPlugin extends MapPluginBase {
     removeDataJoin(id: string): void;
 }
 
+/** Callback function to indicate map export overlay drawing has finished. */
+type DrawOverlayCallback = (error: Error) => void;
+/** Function to draw an overlay on an exported map. */
+type DrawOverlayFn = (ctx: CanvasRenderingContext2D, width: number, height: number, dpmm: number, callback: DrawOverlayCallback) => void;
+/**
+ * Options for [[FlowCoreMap.export]].
+ */
+interface FlowMapExportOptions {
+    /** Name of exported file. */
+    name: string;
+    /** Width of exported map in millimeters. */
+    width: number;
+    /** Height of exported map in millimeters. */
+    height: number;
+    /** Resolution of exported map. Dots/mm. */
+    dpmm: number;
+    /** Format of exported map. */
+    format: 'png' | 'pdf';
+    /**
+     * Geographic bounds of area to export ([left, bottom, right top]).
+     *
+     * This should be a subregion of the full map area.
+     */
+    bounds?: number[];
+    /** Function called to draw overlay on exported map. */
+    drawOverlayFn?: DrawOverlayFn;
+}
+
+interface ExportPluginOptions {
+}
+declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
+    readonly name = "ExportPlugin";
+    constructor(pluginManager: PluginManager);
+    exportMap(options: FlowMapExportOptions): Promise<string>;
+}
+
 declare class HoverEffectPlugin extends MapPluginBase {
     private hoveredFeature;
     readonly name = "HoverEffectPlugin";
@@ -306,4 +342,4 @@ declare class UrlSyncPlugin extends MapPluginBase {
     private hashToMapState;
 }
 
-export { AnnotationEvent, AnnotationEventData, AnnotationEventType, AnnotationEventTypes, AnnotationFeature, AnnotationFeatureProps, AnnotationFeatureType, AnnotationMode, AnnotationOperation, AnnotationPlugin, AnnotationPluginOptions, AnnotationStyle, AnnotationsServiceConfig, DataJoin, DataJoinOptions, DataJoinPlugin, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, SelectionEventType, SelectionEventTypes, SelectionMode, SelectionOptions, SelectionPlugin, UrlSyncPlugin };
+export { AnnotationEvent, AnnotationEventData, AnnotationEventType, AnnotationEventTypes, AnnotationFeature, AnnotationFeatureProps, AnnotationFeatureType, AnnotationMode, AnnotationOperation, AnnotationPlugin, AnnotationPluginOptions, AnnotationStyle, AnnotationsServiceConfig, DataJoin, DataJoinOptions, DataJoinPlugin, DrawOverlayCallback, DrawOverlayFn, ExportPlugin, ExportPluginOptions, FlowMapExportOptions, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, SelectionEventType, SelectionEventTypes, SelectionMode, SelectionOptions, SelectionPlugin, UrlSyncPlugin };