Overlay stopEvent and insertFirst default to true

This commit is contained in:
Éric Lemoine
2013-10-30 09:49:38 +01:00
parent d7c696fc76
commit 16b817b830
6 changed files with 18 additions and 20 deletions

View File

@@ -79,13 +79,14 @@
* projection.
* @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`).
* viewport should be stopped. Default is `true`. If `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.
* first in the overlay container, or appended. Default is `true`. If the
* overlay is placed in the same container as that of the controls (see
* the `stopEvent` option) you will probably set `insertFirst` to `true`
* so the overlay is displayed below the controls.
* @todo stability experimental
*/