Class: OverviewMap

ol/control/OverviewMap~OverviewMap 


import OverviewMap from 'ol/control/OverviewMap';

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

new OverviewMap(opt_options)

control/OverviewMap.js, line 73
Name Type Description
options

OverviewMap options.

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.<module:ol/layer/Base~BaseLayer> | module:ol/Collection~Collection.<module:ol/layer/Base~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 module:ol/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:

Extends

Methods

changed() inherited

Observable.js, line 68

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 module:ol/events/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 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getCollapsed(){boolean}

control/OverviewMap.js, line 627

Determine if the overview map is collapsed.

Returns:
The overview map is collapsed.

getCollapsible(){boolean}

control/OverviewMap.js, line 588

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

Returns:
True if the widget is collapsible.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getMap(){module:ol/PluggableMap~PluggableMap|null} inherited

control/Control.js, line 104

Get the map associated with this control.

Returns:
Map.

getOverviewMap(){module:ol/PluggableMap~PluggableMap}

control/OverviewMap.js, line 667

Return the overview map.

Returns:
Overview map.

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

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 79

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 636

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

Returns:
True if the control view can rotate.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 153

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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 165

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.

render(mapEvent) inherited

control/OverviewMap.js, line 676

Update the overview map element.

Name Type Description
mapEvent module:ol/MapEvent~MapEvent

Map event.

set(key, value, opt_silent) inherited

Object.js, line 207

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 615

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 597

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 275

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 module:ol/PluggableMap~PluggableMap | null

Map.

setProperties(values, opt_silent) inherited

Object.js, line 227

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.
silent boolean | undefined

Update without triggering an event.

setRotateWithView(rotateWithView)

control/OverviewMap.js, line 645

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 155

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 174

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, opt_silent) inherited

Object.js, line 251

Unsets a property.

Name Type Description
key string

Key name.
silent boolean | undefined

Unset without triggering an event.