Module: ol/control/OverviewMap

ol/control/OverviewMap


Classes

OverviewMap

Type Definitions

Options{Object}

Properties:
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.