Skip to content

Commit

Permalink
[docsprint] Cleanup doc for MapBoxZoomEvent (#9564)
Browse files Browse the repository at this point in the history
  • Loading branch information
Asheem Mamoowala authored Apr 20, 2020
1 parent e5954f2 commit 6b419c2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/ui/events.js
Original file line number Diff line number Diff line change
Expand Up @@ -218,17 +218,18 @@ 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.
* A `MapBoxZoomEvent` is the event type for the boxzoom-related map events emitted by the {@link BoxZoomHandler}.
*
* @typedef {Object} MapBoxZoomEvent
* @property {MouseEvent} originalEvent
* @property {MouseEvent?} originalEvent The DOM event that triggered the box zoom event. Can be a `MouseEvent` or `KeyboardEvent`
* @property {string} type The type of box zoom event. One of `boxzoomstart`, `boxzoomend` or `boxzoomcancel`
* @property {Map} target The `map` instance that triggerred the event
*/
export type MapBoxZoomEvent = {
type: 'boxzoomstart'
| 'boxzoomend'
| 'boxzoomcancel',
map: Map,
target: Map,
originalEvent: MouseEvent
};

Expand Down

0 comments on commit 6b419c2

Please sign in to comment.