Module: ol/control/OverviewMap

Classes

OverviewMap

Methods

module:ol/control/OverviewMap.render(mapEvent)

control/OverviewMap.js, line 577

Update the overview map element.

This:

• {module:ol/control/OverviewMap~OverviewMap}

Name	Type	Description
mapEvent	module:ol/MapEvent~MapEvent	Map event.

Type Definitions

Options{Object}

Properties:

Name	Type	Argument	Default	Description
className	string	<optional>	'ol-overviewmap'	CSS class name.
collapsed	boolean	<optional>	true	Whether the control should start collapsed or not (expanded).
collapseLabel	string | HTMLElement	<optional>	'«'	Text label to use for the expanded overviewmap button. Instead of text, also an element (e.g. a span element) can be used.
collapsible	boolean	<optional>	true	Whether the control can be collapsed or not.
label	string | HTMLElement	<optional>	'»'	Text label to use for the collapsed overviewmap button. Instead of text, also an element (e.g. a span element) can be used.
layers	Array.<module:ol/layer/Layer~Layer> | module:ol/Collection~Collection.<module:ol/layer/Layer~Layer>	<optional>		Layers for the overview map. If not set, then all main map layers are used instead.
render	function	<optional>		Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
target	HTMLElement | string	<optional>		Specify a target if you want the control to be rendered outside of the map's viewport.
tipLabel	string	<optional>	'Overview map'	Text label to use for the button tip.
view	module:ol/View~View	<optional>		Custom view for the overview map. If not provided, a default view with an EPSG:3857 projection will be used.