mapbox-maps-android/com.mapbox.maps.plugin.attribution/AttributionPlugin

AttributionPlugin

Presenter interface for the attribution.

interface AttributionPlugin : ViewPlugin, LifecyclePlugin, AttributionSettingsInterface

Functions

bind

Bind a view instance

abstract override fun bind(mapView: FrameLayout, attrs: AttributeSet?, pixelRatio: Float): View

cleanup

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

open override fun cleanup()

equals

open operator override fun equals(other: Any?): Boolean

getMapAttributionDelegate

Get the instance of MapAttributionDelegate

abstract fun getMapAttributionDelegate(): MapAttributionDelegate

getSettings

Get current attribution configuration.

abstract override fun getSettings(): AttributionSettings

hashCode

open override fun hashCode(): Int

initialize

Called when the plugin is first added to the map.

open override fun initialize()

onDelegateProvider

Provides all map delegate instances.

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

onPluginView

Provides a view instances returned in inflate after it's been added to the MapView.

open override fun onPluginView(view: View)

onStart

Called whenever activity's/fragment's lifecycle is entering a "started" state.

open override fun onStart()

onStop

Called whenever activity's/fragment's lifecycle is entering a "stopped" state.

open override fun onStop()

setCustomAttributionDialogManager

Set a custom AttributionDialogManager that is invoked when the attribution view is clicked.

abstract fun setCustomAttributionDialogManager(dialogManager: AttributionDialogManager)

toString

open override fun toString(): String

updateSettings

Update attribution configuration, the update will be applied to the plugin automatically.

abstract override fun updateSettings(block: AttributionSettings.() -> Unit)

Properties

clickable

Whether the attribution can be clicked and click events can be registered.

abstract override var clickable: Boolean

enabled

Whether the attribution icon is visible on the map.

abstract override var enabled: Boolean

iconColor

Defines text color of the attribution icon.

abstract override var iconColor: Int

marginBottom

Defines the margin to the bottom that the attribution icon honors.

abstract override var marginBottom: Float

marginLeft

Defines the margin to the left that the attribution icon honors.

abstract override var marginLeft: Float

marginRight

Defines the margin to the right that the attribution icon honors.

abstract override var marginRight: Float

marginTop

Defines the margin to the top that the attribution icon honors.

abstract override var marginTop: Float

position

Defines where the attribution icon is positioned on the map

abstract override var position: Int

Inheritors

AttributionViewPlugin