OpenLayers 3

Class: OverviewMap

ol.control.OverviewMap

new ol.control.OverviewMap(opt_options) experimental

src/ol/control/overviewmapcontrol.js, line 35

Create a new control with a map acting as an overview map for an other defined map.

Name Type Description
options

OverviewMap options.

Name Type Description
collapsed boolean | undefined experimental

Whether the control should start collapsed or not (expanded). Default to true.
collapseLabel string | Node | undefined experimental

Text label to use for the expanded overviewmap button. Default is «. Instead of text, also a Node (e.g. a span element) can be used.
collapsible boolean | undefined experimental

Whether the control can be collapsed or not. Default to true.
label string | Node | undefined experimental

Text label to use for the collapsed overviewmap button. Default is ». Instead of text, also a Node (e.g. a span element) can be used.
layers !Array.<ol.layer.Layer> | ol.Collection | undefined experimental

Layers for the overview map. If not set, then all main map layers are used instead.
render function | undefined experimental

Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
target Element | undefined experimental

Specify a target if you want the control to be rendered outside of the map's viewport.
tipLabel string | undefined experimental

Text label to use for the button tip. Default is Overview map
Fires:

Extends

Methods

ol.control.OverviewMap.render(mapEvent) experimental

src/ol/control/overviewmapcontrol.js, line 247

Update the overview map element.

This:
Name Type Description
mapEvent ol.MapEvent

Map event.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:
  • change experimental

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getCollapsed(){boolean}

src/ol/control/overviewmapcontrol.js, line 523
Returns:
True if the widget is collapsed.

getCollapsible(){boolean}

src/ol/control/overviewmapcontrol.js, line 482

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

Returns:
True if the widget is collapsible.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:
List of property names.

getMap(){ol.Map} inherited

src/ol/control/control.js, line 114

Get the map associated with this control.

Returns:
Map.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62
Returns:
Revision.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 75

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.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 88

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.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

set(key, value) inherited

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setCollapsed(collapsed)

src/ol/control/overviewmapcontrol.js, line 511

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)

src/ol/control/overviewmapcontrol.js, line 492

Set whether the overview map should be collapsible.

Name Type Description
collapsible boolean

True if the widget is collapsible.

setMap(map){undefined}

src/ol/control/overviewmapcontrol.js, line 154

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

Name Type Description
map ol.Map

Map.
Returns:
Undefined.

setProperties(values) inherited

src/ol/object.js, line 216

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 Object.<string, *>

Values.

setTarget(target) inherited experimental

src/ol/control/control.js, line 157

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 Element | string

Target.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

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.
this Object

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name Type Description
key string

Key name.