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(options)

Name Type Description
className string (defaults to 'ol-attribution')

CSS class name.

target HTMLElement | 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 not specified, sources control this behavior with their attributionsCollapsible setting.

collapsed boolean (defaults to true)

Specify if attributions should be collapsed at startup.

tipLabel string (defaults to 'Attributions')

Text label to use for the button tip.

label string | HTMLElement (defaults to 'i')

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

expandClassName string (defaults to className + '-expand')

CSS class name for the collapsed attributions button.

collapseLabel string | HTMLElement (defaults to '›')

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

collapseClassName string (defaults to className + '-collapse')

CSS class name for the expanded attributions button.

render function | undefined

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

Fires:

Extends

Methods

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

dispatchEvent(event){boolean | undefined} inherited

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 BaseEvent | string

Event object.

Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getCollapsed(){boolean}

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

Returns:
True if the widget is collapsed.

getCollapsible(){boolean}

Return true if the attribution is collapsible, false otherwise.

Returns:
True if the widget is collapsible.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

Get the map associated with this control.

Returns:
Map.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

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

Returns:
Revision.

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

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){EventsKey | Array<EventsKey>} inherited

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.

Update the attribution element.

Name Type Description
mapEvent MapEvent

Map event.

set(key, value, silent) inherited

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean | undefined

Update without triggering an event.

setCollapsed(collapsed)

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)

Set whether the attribution should be collapsible.

Name Type Description
collapsible boolean

True if the widget is collapsible.

Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.

Name Type Description
map Map | null

Map.

setProperties(values, silent) inherited

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 | undefined

Update without triggering an event.

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.

un(type, listener) inherited

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

Unsets a property.

Name Type Description
key string

Key name.

silent boolean | undefined

Unset without triggering an event.