new ol.control.Attribution(opt_options)
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Attribution options.
|
Fires:
-
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
Methods
-
ol.control.Attribution.render(mapEvent) experimental
src/ol/control/attributioncontrol.js, line 218 -
Update the attribution element.
This:
Name Type Description mapEvent
ol.MapEvent Map event.
-
changed() inherited experimental
src/ol/observable.js, line 52 -
Increases the revision counter and dispatches a 'change' event.
Fires:
-
change
experimental
-
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getCollapsed(){boolean}
src/ol/control/attributioncontrol.js, line 416 -
Return
true
when the attribution is currently collapsed orfalse
otherwise.Returns:
True if the widget is collapsed.
-
getCollapsible(){boolean}
src/ol/control/attributioncontrol.js, line 373 -
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 164 -
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
src/ol/object.js, line 174 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 62 -
Returns:
Revision.
-
on(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 75 -
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
inlistener
.Returns:
Unique key for the listener.
-
once(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 88 -
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
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setCollapsed(collapsed)
src/ol/control/attributioncontrol.js, line 402 -
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/attributioncontrol.js, line 383 -
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 126 -
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.Map Map.
-
setProperties(values) inherited
src/ol/object.js, line 216 -
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.
-
setTarget(target) inherited experimental
src/ol/control/control.js, line 157 -
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 notarget
is set in the options passed to the control constructor and ifsetTarget
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 101 -
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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.