Module: ol/Overlay

ol/Overlay

Classes

Overlay

Members

Property{string}

Properties:

Name	Type	Default	Description
`ELEMENT`	string	element
`MAP`	string	map
`OFFSET`	string	offset
`POSITION`	string	position
`POSITIONING`	string	positioning

Type Definitions

Options{Object}

Properties:

Name	Type	Argument	Default	Description
`id`	number \| string	<optional>		Set the overlay id. The overlay id can be used with the `module:ol/Map~Map#getOverlayById` method.
`element`	HTMLElement	<optional>		The overlay element.
`offset`	Array.<number>	<optional>	[0, 0]	Offsets in pixels used when positioning the overlay. The first 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.
`position`	module:ol/coordinate~Coordinate	<optional>		The overlay position in map projection.
`positioning`	module:ol/OverlayPositioning	<optional>	'top-left'	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'`.
`stopEvent`	boolean	<optional>	true	Whether event propagation to the map viewport should be stopped. If `true` the overlay is placed in the same container as that of the controls (CSS class name `ol-overlaycontainer-stopevent`); if `false` it is placed in the container with CSS class name specified by the `className` property.
`insertFirst`	boolean	<optional>	true	Whether the overlay is inserted first in the overlay container, or appended. 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.
`autoPan`	boolean	<optional>	false	If set to `true` the map is panned when calling `setPosition`, so that the overlay is entirely visible in the current viewport.
`autoPanAnimation`	PanOptions	<optional>		The animation options used to pan the overlay into view. This animation is only used when `autoPan` is enabled. A `duration` and `easing` may be provided to customize the animation.
`autoPanMargin`	number	<optional>	20	The margin (in pixels) between the overlay and the borders of the map when autopanning.
`className`	string	<optional>	'ol-overlay-container ol-selectable'	CSS class name.

PanOptions{Object}

Properties:

Name	Type	Argument	Default	Description
`duration`	number	<optional>	1000	The duration of the animation in milliseconds.
`easing`	function	<optional>		The easing function to use. Can be one from `module:ol/easing` or a custom function. Default is `module:ol/easing~inAndOut`.