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

Attribution

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

Constructors

Link copied to clipboard
constructor(options: Attribution.AttributionOptions = definedExternally)

Types

Link copied to clipboard

Properties

Link copied to clipboard
open val onAdd: (map: LeafletMap) -> <Error class: unknown class>?

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

Link copied to clipboard
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

Link copied to clipboard
open fun addAttribution(text: String): Attribution

Adds an attribution text (e.g. Vector data &copy; Mapbox).

Link copied to clipboard
open fun addTo(map: LeafletMap): Control<Attribution.AttributionOptions>

Adds the control to the given map.

Link copied to clipboard
open fun getContainer(): <Error class: unknown class>?

Returns the HTMLElement that contains the control.

Link copied to clipboard
open fun getPosition(): PositionsUnion

Returns the position of the control.

Link copied to clipboard
open fun remove(): Control<Attribution.AttributionOptions>

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

Link copied to clipboard
open fun removeAttribution(text: String): Attribution

Removes an attribution text.

Link copied to clipboard
open fun setPosition(position: PositionsUnion): Control<Attribution.AttributionOptions>

Sets the position of the control.

Link copied to clipboard
open fun setPrefix(prefix: Boolean): Attribution
open fun setPrefix(prefix: String): Attribution

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