doc: add note that MapBoxZoomEvent originalEvent can be a click #8693

mapbox · Sep 9, 2019 · 2772364 · 2772364
1 parent 07587b5
commit 2772364
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/ui/events.js b/src/ui/events.js
@@ -214,6 +214,9 @@ export class MapWheelEvent extends Event {
 }
 
 /**
+ * A `MapBoxZoomEvent` is the event type for boxzoom-related map events.
+ * `originalEvent` can be a {@link Map.event:click} when the zoom is triggered by a UI event.
+ *
  * @typedef {Object} MapBoxZoomEvent
  * @property {MouseEvent} originalEvent
  */