AttributionControl
An AttributionControl control presents the map's attribution information. By default, the attribution control is expanded (regardless of map width).
Example
let map = new Map({attributionControl: false})
.addControl(new AttributionControl({
compact: true
}));
Implements
Constructors
new AttributionControl()
new AttributionControl(
options:AttributionControlOptions):AttributionControl
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
options |
AttributionControlOptions |
defaultAttributionControlOptions |
the attribution options |
Returns
Defined in
src/ui/control/attribution_control.ts:54
Methods
getDefaultPosition()
getDefaultPosition():
ControlPosition
Optionally provide a default position for this control. If this method
is implemented and Map#addControl is called without the position
parameter, the value returned by getDefaultPosition will be used as the
control's position.
Returns
a control position, one of the values valid in addControl.
Implementation of
Defined in
src/ui/control/attribution_control.ts:58
onAdd()
onAdd(
map:Map):HTMLElement
Register a control on the map and give it a chance to register event listeners and resources. This method is called by Map#addControl internally.
Parameters
| Parameter | Type | Description |
|---|---|---|
map |
Map |
the Map this control will be added to |
Returns
HTMLElement
The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.
Implementation of
Defined in
src/ui/control/attribution_control.ts:63
onRemove()
onRemove():
void
Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by Map#removeControl internally.
Returns
void