OverviewMap — OpenLayers API reference

new OverviewMap(options) control/OverviewMap.js, line 67

Name	Type	Description
`className`	string (defaults to 'ol-overviewmap')	CSS class name.
`collapsed`	boolean (defaults to true)	Whether the control should start collapsed or not (expanded).
`collapseLabel`	string \| HTMLElement (defaults to '‹')	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 (defaults to true)	Whether the control can be collapsed or not.
`label`	string \| HTMLElement (defaults to '›')	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<BaseLayer> \| Collection<BaseLayer> \| undefined	Layers for the overview map.
`render`	function \| undefined	Function called when the control should be re-rendered. This is called in a `requestAnimationFrame` callback.
`rotateWithView`	boolean (defaults to false)	Whether the control view should rotate with the main map view.
`target`	HTMLElement \| string \| undefined	Specify a target if you want the control to be rendered outside of the map's viewport.
`tipLabel`	string (defaults to 'Overview map')	Text label to use for the button tip.
`view`	View \| undefined	Custom view for the overview map (should use same projection as main map). If not provided, a default view with the same projection as the main map will be used.

Fires:

change (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
error (BaseEvent) - Generic error event. Triggered when an error occurs.
propertychange (ObjectEvent) - Triggered when a property is changed.

Extends

Control

Methods

changed() inherited Observable.js, line 72

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
`event`	BaseEvent \| string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited Object.js, line 136

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getCollapsed(){boolean} control/OverviewMap.js, line 677

Determine if the overview map is collapsed.

Returns:

The overview map is collapsed.

getCollapsible(){boolean} control/OverviewMap.js, line 634

Return true if the overview map is collapsible, false otherwise.

Returns:

True if the widget is collapsible.

getKeys(){Array.<string>} inherited Object.js, line 149

Get a list of object property names.

Returns:

List of property names.

getMap(){Map | null} inherited control/Control.js, line 104

Get the map associated with this control.

Returns:

Map.

getOverviewMap(){Map} control/OverviewMap.js, line 721

Return the overview map.

Returns:

Overview map.

getProperties(){NoInfer.<Properties>} inherited Object.js, line 158

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 83

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getRotateWithView(){boolean} control/OverviewMap.js, line 686

Return true if the overview map view can rotate, false otherwise.

Returns:

True if the control view can rotate.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 156

Listen for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 168

Listen once for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, silent) inherited Object.js, line 218

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean \| undefined	Update without triggering an event.

setCollapsed(collapsed) control/OverviewMap.js, line 665

Collapse or expand the overview map according to the passed parameter. Will not do anything if the overview map isn't collapsible or if the current collapsed state is already the one requested.

Name	Type	Description
`collapsed`	boolean	True if the widget is collapsed.

setCollapsible(collapsible) control/OverviewMap.js, line 643

Set whether the overview map should be collapsible.

Name	Type	Description
`collapsible`	boolean	True if the widget is collapsible.

setMap(map) control/OverviewMap.js, line 286

Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.

Name	Type	Description
`map`	Map \| null	Map.

setProperties(values, silent) inherited Object.js, line 241

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
`values`	Partial.<NoInfer.<Properties>>	Values.
`silent`	boolean \| undefined	Update without triggering an event.

setRotateWithView(rotateWithView) control/OverviewMap.js, line 695

Set whether the overview map view should rotate with the main map view.

Name	Type	Description
`rotateWithView`	boolean	True if the control view should rotate.

setTarget(target) inherited control/Control.js, line 162

This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

Name	Type	Description
`target`	HTMLElement \| string	Target.

un(type, listener) inherited Observable.js, line 177

Unlisten for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

unset(key, silent) inherited Object.js, line 265

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean \| undefined	Unset without triggering an event.