Improve doc for stopEvent and insertFirst options

This commit is contained in:
Bruno Binet
2013-10-11 17:00:23 +02:00
committed by Éric Lemoine
parent 4e602fdb8d
commit d7c696fc76

View File

@@ -80,8 +80,12 @@
* @property {ol.OverlayPositioning|undefined} positioning Positioning.
* @property {boolean|undefined} stopEvent Whether event propagation to the map
* should be stopped. Default is `false`.
* If `stopEvent` is `true`, the overlay is placed in the same container as
* that of the controls (`ol-overlaycontainer-stopevent`).
* @property {boolean|undefined} insertFirst Whether the overlay is inserted
* first in the container div, or appended. Default is `false`.
* This is usually used in conjunction with `stopEvent: true` so the
* overlay is below controls.
* @todo stability experimental
*/