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

ViewportPlugin

interface ViewportPlugin : MapPlugin

The Viewport plugin allows to track objects on a map.

It 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)

Adds ViewportStatusObserver to observe the status change.

cleanup

open fun cleanup()

Called when the map is destroyed.

equals

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

hashCode

open fun hashCode(): Int

idle

abstract fun idle()

Immediately goes to IDLE state canceling all ongoing transitions.

initialize

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 default ViewportTransition instance with provided DefaultViewportTransitionOptions.

makeFollowPuckViewportState

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

Create a FollowPuckViewportState instance with provided FollowPuckViewportStateOptions.

makeImmediateViewportTransition

abstract fun makeImmediateViewportTransition(): ViewportTransition

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

makeOverviewViewportState

abstract fun makeOverviewViewportState(options: OverviewViewportStateOptions): OverviewViewportState

Create an OverviewViewportState instance with provided OverviewViewportStateOptions.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

removeStatusObserver

abstract fun removeStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Removes ViewportStatusObserver.

toString

open fun toString(): String

transitionTo

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

Executes a transition to requested state.

Properties

defaultTransition

abstract var defaultTransition: ViewportTransition

DefaultViewportTransition with default options.

options

abstract var options: ViewportOptions

Options that impact the ViewportPlugin.

status

abstract val status: ViewportStatus

Returns current ViewportStatus.

Inheritors

ViewportPluginImpl