AttributionPlugin

interface AttributionPlugin : ViewPlugin, LifecyclePlugin, AttributionSettingsInterface
Content copied to clipboard

Presenter interface for the attribution.

Functions

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

Bind a view instance

cleanup
Link copied to clipboard
open fun cleanup()
Content copied to clipboard

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

getMapAttributionDelegate
Link copied to clipboard
abstract fun getMapAttributionDelegate(): MapAttributionDelegate
Content copied to clipboard

Get the instance of MapAttributionDelegate

getSettings
Link copied to clipboard
abstract fun getSettings(): AttributionSettings
Content copied to clipboard

Get current attribution configuration.

initialize
Link copied to clipboard
open fun initialize()
Content copied to clipboard

Called when the plugin is first added to the map.

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

Provides all map delegate instances.

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

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

onStart
Link copied to clipboard
open fun onStart()
Content copied to clipboard

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

onStop
Link copied to clipboard
open fun onStop()
Content copied to clipboard

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

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

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

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

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

Properties

clickable
Link copied to clipboard
abstract var clickable: Boolean
Content copied to clipboard

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

enabled
Link copied to clipboard
abstract var enabled: Boolean
Content copied to clipboard

Whether the attribution icon is visible on the map.

iconColor
Link copied to clipboard
abstract var iconColor: Int
Content copied to clipboard

Defines text color of the attribution icon.

marginBottom
Link copied to clipboard
abstract var marginBottom: Float
Content copied to clipboard

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

marginLeft
Link copied to clipboard
abstract var marginLeft: Float
Content copied to clipboard

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

marginRight
Link copied to clipboard
abstract var marginRight: Float
Content copied to clipboard

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

marginTop
Link copied to clipboard
abstract var marginTop: Float
Content copied to clipboard

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

position
Link copied to clipboard
abstract var position: Int
Content copied to clipboard

Defines where the attribution icon is positioned on the map

Inheritors

AttributionViewPlugin
Link copied to clipboard