Javascript API 7.x

Class: Attribution

bu.control. Attribution

Control to show all the attributions associated with a viewer. By default it will show in the bottom right portion of the map, but this can be changed by using a css selector for .bu-attribution.

new Attribution( [opt_options])

Parameters:
Name Type Argument Description
opt_options bu.control.AttributionOptions <optional>

Options.
Source:
bu/controls/attribution.js

Extends

Members

controldefs :Array.<bu.ControlDefinition>

Array of control definitions this control contains.

Type:
Inherited From:
Source:
bu/controls/control.js

<nullable> element :Element

This is the HTML element where the control is drawn. Do not modify this property directly. Use only in the constructor.

Type:
  • Element
Inherited From:
Source:
bu/controls/control.js

<nullable> target :Element

This is the HTML element where the control is appended. Do not modify this property directly. Use constructor or setTarget to set this value.

Type:
  • Element
Inherited From:
Source:
bu/controls/control.js

Methods

addControlDefinition(controldef)

Adds a control definition to the control. By default the control in the control definition is changed its target to the element of this control. Override this behaviour in inherited classes to change the target to another one.

Parameters:
Name Type Description
controldef *

Control definition.
Inherited From:
Source:
bu/controls/control.js

addControlDefinitions(controldefs)

Adds an array of control definitions to the control. Controls in the control definition array shouldn't have a target set.

Parameters:
Name Type Description
controldefs Array.<bu.control.ControlDefinition>

Array of control definitions to add.
Inherited From:
Source:
bu/controls/control.js

containsControlDefinition(controldef)

Checks if a control definition is already added.

Parameters:
Name Type Description
controldef bu.ControlDefinition

Control definition to check.
Inherited From:
Source:
bu/controls/control.js
Returns:

True if it is added.

Type
boolean

getCollapsed()

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

Source:
bu/controls/attribution.js
Returns:

True if the widget is collapsed.

Type
boolean

getCollapsible()

Return true if the attribution is collapsible, false otherwise.

Source:
bu/controls/attribution.js
Returns:

True if the widget is collapsible.

Type
boolean

getControlDefinitions()

Return the array of control definitions this control has inside.

Inherited From:
Source:
bu/controls/control.js
Returns:
Type
Array.<bu.ControlDefinition>

isTool()

Returns true if this control is a tool. A tool is a control that contains one or several options in a list (for example a bu.control.Switcher) that are linked to a viewer and only one of them can be active at a time. Tools are usually related to interactions in a way that only one interaction can be active at a time in a viewer.

Inherited From:
Source:
bu/controls/control.js
Returns:
Type
boolean

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.

Parameters:
Name Type Description
collapsed boolean

True if the widget is collapsed.
Source:
bu/controls/attribution.js

setCollapsible(collapsible)

Set whether the attribution should be collapsible.

Parameters:
Name Type Description
collapsible boolean

True if the widget is collapsible.
Source:
bu/controls/attribution.js

setTarget(target)

This function is used to set a target element for the control.

Parameters:
Name Type Description
target Element | string | bu.Viewer

Target.
Inherited From:
Source:
bu/controls/control.js

<abstract> unselectTool()

If this control is a tool the unselects the tool.

Inherited From:
Source:
bu/controls/control.js

update(attributions)

Updates the control with an array of attributions.

Parameters:
Name Type Description
attributions Array.<Object.<string, ol.Attribution>>

The attributions.
Source:
bu/controls/attribution.js

updateLanguage()

Updates the control for the current language in the bu.Globalization singleton.

Inherited From:
Overrides:
Source:
bu/controls/control.js