Rename AnnounceMovement handler to PanZoom / meaningfulPanZoom handler

kevinkim31 · Mar 30, 2023 · c557804 · c557804
1 parent 3e29319
commit c557804
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 17 deletions.
diff --git a/src/mapml-viewer.js b/src/mapml-viewer.js
@@ -278,7 +278,7 @@ export class MapViewer extends HTMLElement {
         projection: this.projection,
         query: true,
         contextMenu: true,
-        announceMovement: M.options.announceMovement,
+        meaningfulPanZoom: true,
         featureIndex: true,
         mapEl: this,
         crs: M[this.projection],

diff --git a/src/mapml/handlers/AnnounceMovement.js → src/mapml/handlers/PanZoom.js b/src/mapml/handlers/AnnounceMovement.js → src/mapml/handlers/PanZoom.js
@@ -1,8 +1,8 @@
-export var AnnounceMovement = L.Handler.extend({
+export var PanZoomHandler = L.Handler.extend({
     addHooks: function () {
         this._map.on({
             layeradd: this.totalBounds,
-            layerremove: this.totalBounds,
+            layerremove: this.totalBounds
         });
 
         this._map.options.mapEl.addEventListener('moveend', this.announceBounds);
@@ -12,7 +12,7 @@ export var AnnounceMovement = L.Handler.extend({
     removeHooks: function () {
         this._map.off({
             layeradd: this.totalBounds,
-            layerremove: this.totalBounds,
+            layerremove: this.totalBounds
         });
 
         this._map.options.mapEl.removeEventListener('moveend', this.announceBounds);
@@ -127,4 +127,4 @@ export var AnnounceMovement = L.Handler.extend({
         this.wasDragged = true;
     }
 
-});
+});
diff --git a/src/mapml/index.js b/src/mapml/index.js
@@ -54,13 +54,13 @@ import { Util } from './utils/Util';
 import { ReloadButton, reloadButton } from './control/ReloadButton';
 import { ScaleBar, scaleBar } from './control/ScaleBar';
 import { FullscreenButton, fullscreenButton } from './control/FullscreenButton';
-import {attributionControl} from "./control/AttributionControl";
+import { attributionControl } from "./control/AttributionControl";
 import { Crosshair, crosshair } from "./layers/Crosshair";
 import { Feature, feature } from "./features/feature";
 import { FeatureRenderer, featureRenderer } from './features/featureRenderer';
 import { FeatureGroup, featureGroup} from './features/featureGroup';
-import {AnnounceMovement} from "./handlers/AnnounceMovement";
-import {AnnounceScale,announceScale} from "./control/AnnounceScale";
+import { PanZoomHandler } from "./handlers/PanZoom";
+import { AnnounceScale,announceScale } from "./control/AnnounceScale";
 import { FeatureIndex } from "./handlers/FeatureIndex";
 import { Options } from "./options";
 import "./keyboard";
@@ -620,15 +620,15 @@ M.mapml2geojson = Util.mapml2geojson;
 
 M.QueryHandler = QueryHandler;
 M.ContextMenu = ContextMenu;
-M.AnnounceMovement = AnnounceMovement;
+M.PanZoomHandler = PanZoomHandler;
 M.announceScale = announceScale;
 M.AnnounceScale = AnnounceScale;
 M.FeatureIndex = FeatureIndex;
 
 // see https://leafletjs.com/examples/extending/extending-3-controls.html#handlers
 L.Map.addInitHook('addHandler', 'query', M.QueryHandler);
 L.Map.addInitHook('addHandler', 'contextMenu', M.ContextMenu);
-L.Map.addInitHook('addHandler', 'announceMovement', M.AnnounceMovement);
+L.Map.addInitHook('addHandler', 'meaningfulPanZoom', M.PanZoomHandler);
 L.Map.addInitHook('addHandler', 'featureIndex', M.FeatureIndex);
 
 M.MapMLLayer = MapMLLayer;

diff --git a/src/mapml/options.js b/src/mapml/options.js
@@ -1,6 +1,5 @@
 export var Options = {
   featureIndexOverlayOption: false,
-  announceMovement: false,
   announceScale: {"metric": true, "imperial": false},
   defaultExtCoor: 'pcrs',
   defaultLocCoor: 'gcrs',
@@ -47,4 +46,4 @@ export var Options = {
     kbdNextFeature: "Next feature",
     dfLayer: "Layer",
   }
-};
+};
diff --git a/src/web-map.js b/src/web-map.js
@@ -289,7 +289,7 @@ export class WebMap extends HTMLMapElement {
         projection: this.projection,
         query: true,
         contextMenu: true,
-        announceMovement: M.options.announceMovement,
+        meaningfulPanZoom: true,
         featureIndex: true,
         mapEl: this,
         crs: M[this.projection],

diff --git a/test/e2e/core/announceMovement.test.js → test/e2e/core/meaningfulPanZoom.test.js b/test/e2e/core/announceMovement.test.js → test/e2e/core/meaningfulPanZoom.test.js
diff --git a/test/e2e/mapml-viewer/mapml-viewer.html b/test/e2e/mapml-viewer/mapml-viewer.html
@@ -6,7 +6,7 @@
   <meta charset="UTF-8">
   <script>
     let options = document.createElement("map-options");
-    options.innerHTML = '{"announceMovement":true}';
+    options.innerHTML = '{"announceZoom":true}';
     document.head.appendChild(options);
   </script>
   <script type="module" src="mapml-viewer.js"></script>

diff --git a/test/e2e/web-map/map.html b/test/e2e/web-map/map.html
@@ -6,7 +6,7 @@
   <meta charset="UTF-8">
   <script>
     let options = document.createElement("map-options");
-    options.innerHTML = '{"announceMovement":true}';
+    options.innerHTML = '{"announceZoom":true}';
     document.head.appendChild(options);
   </script>
   <script type="module" src="web-map.js"></script>

diff --git a/test/utils/options.spec.js b/test/utils/options.spec.js
@@ -1,5 +1,5 @@
 describe("M.Options Tests", () => {
-  test("M.options.announceMovement default set", async () => {
-    await expect(M.options.announceMovement).toEqual(false);
+  test("M.options.announceZoom default set", async () => {
+    await expect(M.options.announceZoom).toEqual(false);
   });
 });