Merge pull request #4276 from fredj/platformModifierKeyOnly_doc

Better ol.events.condition.platformModifierKeyOnly documentation
This commit is contained in:
Frédéric Junod
2015-10-15 13:34:45 +02:00

View File

@@ -140,8 +140,9 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
/**
* Return `true` if only the platform-modifier-key (e.g. the windows-key) is
* pressed, `false` otherwise (e.g. when additionally the shift-key is pressed).
* Return `true` if only the platform-modifier-key (the meta-key on Mac,
* ctrl-key otherwise) is pressed, `false` otherwise (e.g. when additionally
* the shift-key is pressed).
*
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the platform modifier key is pressed.