Better docs for handleMapBrowserEvent

This commit is contained in:
Éric Lemoine
2014-11-09 22:08:29 +01:00
parent c4d6e04e4b
commit f32c550dbe
2 changed files with 7 additions and 2 deletions

View File

@@ -77,10 +77,15 @@ ol.interaction.Interaction.prototype.getMap = function() {
/**
* Method called by the map to notify the interaction that a browser
* event was dispatched on the map. If the interaction wants to handle
* that event it can return `false` to prevent the propagation of the
* event to other interactions in the map's interactions chain.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} Whether the map browser event should continue
* through the chain of interactions. false means stop, true
* through the chain of interactions. `false` means stop, `true`
* means continue.
* @function
* @api
*/
ol.interaction.Interaction.prototype.handleMapBrowserEvent =