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

AttributionPlugin

interface AttributionPlugin : ViewPlugin, LifecyclePlugin, AttributionSettingsInterface

Presenter interface for the attribution.

Functions

bind

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

Bind a view instance

cleanup

open fun cleanup()

Called when the map is destroyed.

equals

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

getMapAttributionDelegate

abstract fun getMapAttributionDelegate(): MapAttributionDelegate

Get the instance of MapAttributionDelegate

getSettings

abstract fun getSettings(): AttributionSettings

Get current attribution configuration.

hashCode

open fun hashCode(): Int

initialize

open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onPluginView

open fun onPluginView(view: View)

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

onStart

open fun onStart()

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

onStop

open fun onStop()

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

setCustomAttributionDialogManager

abstract fun setCustomAttributionDialogManager(dialogManager: AttributionDialogManager)

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

toString

open fun toString(): String

updateSettings

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

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

Properties

clickable

abstract var clickable: Boolean

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

enabled

abstract var enabled: Boolean

Whether the attribution icon is visible on the map.

iconColor

abstract var iconColor: Int

Defines text color of the attribution icon.

marginBottom

abstract var marginBottom: Float

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

marginLeft

abstract var marginLeft: Float

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

marginRight

abstract var marginRight: Float

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

marginTop

abstract var marginTop: Float

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

position

abstract var position: Int

Defines where the attribution icon is positioned on the map

Inheritors

AttributionViewPlugin