kilua-leaflet/dev.kilua.externals.leaflet.control/Attribution

Attribution

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

Constructors

Attribution

constructor(options: Attribution.AttributionOptions = definedExternally)

Types

AttributionOptions

interface AttributionOptions : Control.ControlOptions

Functions

addAttribution

open fun addAttribution(text: String): Attribution

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

addInitHook

fun addInitHook(initHookFn: () -> Unit): JsAny

Adds a constructor hook to the class.

fun addInitHook(methodName: String, vararg args: JsAny): JsAny

addTo

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

Adds the control to the given map.

getContainer

open fun getContainer(): HTMLElement?

Returns the HTMLElement that contains the control.

getPosition

open fun getPosition(): PositionsUnion

Returns the position of the control.

include

fun include(props: JsAny): JsAny

Includes a mixin into the current class.

mergeOptions

fun mergeOptions(props: JsAny): JsAny

Merges options into the defaults of the class.

onAdd

fun onAdd(map: LeafletMap): HTMLElement?

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

onRemove

fun onRemove(map: LeafletMap)

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

remove

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.

setPosition

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

Sets the position of the control.

setPrefix

open fun setPrefix(prefix: Boolean): Attribution

open fun setPrefix(prefix: String): Attribution

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