OpenLayers

Class: Attribution

ol.control.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 ol.control.Attribution(opt_options)

src/ol/control/attribution.js, line 28
Name Type Description
options

Attribution options.

Name Type Description
className string | undefined

CSS class name. Default is ol-attribution.
target Element | string | undefined

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

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 — Default is true.
collapsed boolean | undefined

Specify if attributions should be collapsed at startup. Default is true.
tipLabel string | undefined

Text label to use for the button tip. Default is Attributions
label string | Node | undefined

Text label to use for the collapsed attributions button. Default is i. Instead of text, also a Node (e.g. a span element) can be used.
collapseLabel string | Node | undefined

Text label to use for the expanded attributions button. Default is ». Instead of text, also a Node (e.g. a span element) can be used.
render function | undefined

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

Extends

Methods

ol.control.Attribution.render(mapEvent)

src/ol/control/attribution.js, line 210

Update the attribution element.

This:
Name Type Description
mapEvent ol.MapEvent

Map event.

changed() inherited

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited

src/ol/observable.js, line 75

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 Object | ol.events.Event | string

Event object.

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getCollapsed(){boolean}

src/ol/control/attribution.js, line 379

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

Returns:
True if the widget is collapsed.

getCollapsible(){boolean}

src/ol/control/attribution.js, line 336

Return true if the attribution is collapsible, false otherwise.

Returns:
True if the widget is collapsible.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:
List of property names.

getMap(){ol.PluggableMap} inherited

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

Get the map associated with this control.

Returns:
Map.

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

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

src/ol/observable.js, line 84

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

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. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

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. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setCollapsed(collapsed)

src/ol/control/attribution.js, line 365

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)

src/ol/control/attribution.js, line 346

Set whether the attribution should be collapsible.

Name Type Description
collapsible boolean

True if the widget is collapsible.

setMap(map) inherited

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

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.PluggableMap

Map.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

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

Update without triggering an event.

setTarget(target) inherited

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

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 147

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.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.