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

AttributionPlugin

interface AttributionPlugin : ViewPlugin, LifecyclePlugin, AttributionSettingsInterface

Presenter interface for the attribution.

Functions

Link copied to clipboard
abstract fun bind(mapView: FrameLayout, attrs: AttributeSet?, pixelRatio: Float): View

Bind a view instance

Link copied to clipboard
open fun cleanup()

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

Link copied to clipboard
abstract fun getMapAttributionDelegate(): MapAttributionDelegate

Get the instance of MapAttributionDelegate

Link copied to clipboard
abstract fun getSettings(): AttributionSettings

Get current attribution configuration.

Link copied to clipboard
open fun initialize()

Called when the plugin is first added to the map.

Link copied to clipboard
open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

Link copied to clipboard
open fun onPluginView(view: View)

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

Link copied to clipboard
open fun onStart()

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

Link copied to clipboard
open fun onStop()

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

Link copied to clipboard
abstract fun setCustomAttributionDialogManager(dialogManager: AttributionDialogManager)

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

Link copied to clipboard
abstract fun updateSettings(block: AttributionSettings.Builder.() -> Unit)

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

Properties

Link copied to clipboard
abstract var clickable: Boolean

Whether the attribution can be clicked and click events can be registered. Default value: true.

Link copied to clipboard
abstract var enabled: Boolean

Whether the attribution icon is visible on the map. Default value: true.

Link copied to clipboard
abstract var iconColor: Int

Defines text color of the attribution icon. Default value: "#FF1E8CAB".

Link copied to clipboard
abstract var marginBottom: Float

Defines the margin to the bottom that the attribution icon honors. Default value: 4.

Link copied to clipboard
abstract var marginLeft: Float

Defines the margin to the left that the attribution icon honors. Default value: 92.

Link copied to clipboard
abstract var marginRight: Float

Defines the margin to the right that the attribution icon honors. Default value: 4.

Link copied to clipboard
abstract var marginTop: Float

Defines the margin to the top that the attribution icon honors. Default value: 4.

Link copied to clipboard
abstract var position: Int

Defines where the attribution icon is positioned on the map Default value: "bottom-left".