Namespaces
Type Definitions
-
olx.OverlayOptions{Object}
-
Object literal with config options for the overlay.
Properties:
Name Type Argument Description element
Element | undefined <optional>
The overlay element.
offset
Array.<number> | undefined <optional>
Offsets in pixels used when positioning the overlay. The fist element in the array is the horizontal offset. A positive value shifts the overlay right. The second element in the array is the vertical offset. A positive value shifts the overlay down. Default is
[0, 0]
.position
ol.Coordinate | undefined <optional>
The overlay position in map projection.
positioning
ol.OverlayPositioning | string | undefined <optional>
Defines how the overlay is actually positioned with respect to its
position
property. Possible values are'bottom-left'
,'bottom-center'
,'bottom-right'
,'center-left'
,'center-center'
,'center-right'
,'top-left'
,'top-center'
, and'top-right'
. Default is'top-left'
.stopEvent
boolean | undefined <optional>
Whether event propagation to the map viewport should be stopped. Default is
true
. Iftrue
the overlay is placed in the same container as that of the controls (CSS class nameol-overlaycontainer-stopevent
); iffalse
it is placed in the container with CSS class nameol-overlaycontainer
.insertFirst
boolean | undefined <optional>
Whether the overlay is inserted 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 thestopEvent
option) you will probably setinsertFirst
totrue
so the overlay is displayed below the controls.