8.2.0

kvision-maps/io.kvision.maps.externals.leaflet.control/Attribution

Attribution

open external class Attribution(options: Attribution.AttributionOptions = definedExternally) : Control<Attribution.AttributionOptions> (source)

Constructors

constructor(options: Attribution.AttributionOptions = definedExternally)

Types

AttributionOptions

interface AttributionOptions : Control.ControlOptions

Properties

open val onAdd: (map: LeafletMap) -> HTMLElement?

Should return the container DOM element for the control and add listeners on relevant map events. Called on addTo

open val onRemove: (map: LeafletMap) -> Unit?

Optional method. Should contain all clean up code that removes the listeners previously added in onAdd. Called on remove.

Functions

open fun addAttribution(text: String): Attribution

Adds an attribution text (e.g. Vector data © Mapbox).

open fun addTo(map: LeafletMap): Control<Attribution.AttributionOptions>

Adds the control to the given map.

open fun getContainer(): HTMLElement?

Returns the HTMLElement that contains the control.

open fun getPosition(): PositionsUnion

Returns the position of the control.

open fun remove(): Control<Attribution.AttributionOptions>

Removes the control from the map it is currently active on.

removeAttribution

open fun removeAttribution(text: String): Attribution

Removes an attribution text.

open fun setPosition(position: PositionsUnion): Control<Attribution.AttributionOptions>

Sets the position of the control.

open fun setPrefix(prefix: Boolean): Attribution

open fun setPrefix(prefix: String): Attribution

The HTML text shown before the attributions. Pass false to disable.