mapbox-maps-android/com.mapbox.maps.plugin.viewport/ViewportPlugin

ViewportPlugin

interface ViewportPlugin : MapPlugin

The ViewportPlugin provides a structured approach to organizing camera management logic into states and transitions between them.

At any given time, the viewport is either:

idle (not updating the camera)
in a state (camera is being managed by a ViewportState)
transitioning (camera is being managed by a ViewportTransition)

Functions

addStatusObserver

abstract fun addStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Subscribes ViewportStatusObserver to observe the ViewportStatus change.

open fun cleanup()

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

abstract fun idle()

Sets ViewportPlugin.status to ViewportStatus.Idle synchronously.

open fun initialize()

Called when the plugin is first added to the map.

makeDefaultViewportTransition

abstract fun makeDefaultViewportTransition(options: DefaultViewportTransitionOptions = DefaultViewportTransitionOptions.Builder().build()): DefaultViewportTransition

Create a new DefaultViewportTransition instance with provided DefaultViewportTransitionOptions.

makeFollowPuckViewportState

abstract fun makeFollowPuckViewportState(options: FollowPuckViewportStateOptions = FollowPuckViewportStateOptions.Builder().build()): FollowPuckViewportState

Create a new FollowPuckViewportState instance with provided FollowPuckViewportStateOptions.

makeImmediateViewportTransition

abstract fun makeImmediateViewportTransition(): ViewportTransition

Create a new ViewportTransition instance that transition to the target ViewportState immediately.

makeOverviewViewportState

abstract fun makeOverviewViewportState(options: OverviewViewportStateOptions): OverviewViewportState

Create a new OverviewViewportState instance with provided OverviewViewportStateOptions.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

removeStatusObserver

abstract fun removeStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Unsubscribes ViewportStatusObserver from ViewportPlugin.status changes.

abstract fun transitionTo(targetState: ViewportState, transition: ViewportTransition? = null, completionListener: CompletionListener? = null)

Executes a transition to requested state.

Properties

defaultTransition

abstract var defaultTransition: ViewportTransition

ViewportPlugin.transitionTo uses this transition unless some non-null value is passed to its transition argument.

abstract var options: ViewportOptions

Configuration options that impact the ViewportPlugin.

abstract val status: ViewportStatus

Returns current ViewportStatus.