Class: Attribution

ol/control/Attribution~Attribution


import Attribution from 'ol/control/Attribution';

Control to show all the attributions associated with the layer sources in the map. This control is one of the default controls included in maps. By default it will show in the bottom right portion of the map, but this can be changed by using a css selector for .ol-attribution.

new Attribution(opt_options)

control/Attribution.js, line 46
Name Type Description
options

Attribution options.

Name Type Default Description
className string 'ol-attribution'

CSS class name.

target HTMLElement | string

Specify a target if you want the control to be rendered outside of the map's viewport.

collapsible boolean true

Specify if attributions can be collapsed. If you use an OSM source, should be set to false — see href="http://www.openstreetmap.org/copyright">www.openstreetmap.org/copyright OSM Copyright —

collapsed boolean true

Specify if attributions should be collapsed at startup.

tipLabel string 'Attributions'

Text label to use for the button tip.

label string 'i'

Text label to use for the collapsed attributions button. Instead of text, also an element (e.g. a span element) can be used.

collapseLabel string | HTMLElement '»'

Text label to use for the expanded attributions button. Instead of text, also an element (e.g. a span element) can be used.

render function

Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.

Methods

getCollapsed(){boolean}

control/Attribution.js, line 310

Return true when the attribution is currently collapsed or false otherwise.

Returns:
True if the widget is collapsed.

getCollapsible(){boolean}

control/Attribution.js, line 270

Return true if the attribution is collapsible, false otherwise.

Returns:
True if the widget is collapsible.

setCollapsed(collapsed)

control/Attribution.js, line 297

Collapse or expand the attribution according to the passed parameter. Will not do anything if the attribution 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/Attribution.js, line 279

Set whether the attribution should be collapsible.

Name Type Description
collapsible boolean

True if the widget is collapsible.