OpenLayers

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

Specify if attributions can be collapsed. If not specified, sources control this behavior with their attributionsCollapsible setting.
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.
Fires:

Extends

Methods

getCollapsed(){boolean}

control/Attribution.js, line 320

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

Returns:
True if the widget is collapsed.

getCollapsible(){boolean}

control/Attribution.js, line 280

Return true if the attribution is collapsible, false otherwise.

Returns:
True if the widget is collapsible.

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

control/Control.js, line 105

Get the map associated with this control.

Returns:
Map.

setCollapsed(collapsed)

control/Attribution.js, line 307

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 289

Set whether the attribution should be collapsible.

Name Type Description
collapsible boolean

True if the widget is collapsible.

setMap(map) inherited

control/Control.js, line 116

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

Map.

setTarget(target) inherited

control/Control.js, line 146

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.