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 50
Name Type Description
options

Attribution options.

Name Type Default Description
className string 'ol-attribution'

CSS class name.

target Element | 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 | Element '»'

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

changed() inherited

Observable.js, line 59

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

dispatchEvent(event) inherited

Observable.js, line 76

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 | module:ol/events/Event~Event | string

Event object.

get(key){*} inherited

Object.js, line 136

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getCollapsed(){boolean}

control/Attribution.js, line 330

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

Returns:
True if the widget is collapsed.

getCollapsible(){boolean}

control/Attribution.js, line 287

Return true if the attribution is collapsible, false otherwise.

Returns:
True if the widget is collapsible.

getKeys(){Array.<string>} inherited

Object.js, line 150

Get a list of object property names.

Returns:
List of property names.

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

control/Control.js, line 108

Get the map associated with this control.

Returns:
Map.

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

Object.js, line 160

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 85

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

Returns:
Revision.

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

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.

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 122

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.

set(key, value, opt_silent) inherited

Object.js, line 185

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setCollapsed(collapsed)

control/Attribution.js, line 316

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 297

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 120

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.

setProperties(values, opt_silent) inherited

Object.js, line 205

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

control/Control.js, line 151

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

Observable.js, line 142

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 218

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.