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

ViewportPlugin

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

androidJvm

abstract fun addStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Subscribes ViewportStatusObserver to observe the ViewportStatus change.

cleanup

androidJvm

open fun cleanup()

Called when the map is destroyed.

equals

androidJvm

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

hashCode

androidJvm

open fun hashCode(): Int

idle

androidJvm

abstract fun idle()

Sets ViewportPlugin.status to ViewportStatus.Idle synchronously.

initialize

androidJvm

open fun initialize()

Called when the plugin is first added to the map.

makeDefaultViewportTransition

androidJvm

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

Create a new DefaultViewportTransition instance with provided DefaultViewportTransitionOptions.

makeFollowPuckViewportState

androidJvm

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

Create a new FollowPuckViewportState instance with provided FollowPuckViewportStateOptions.

makeImmediateViewportTransition

androidJvm

abstract fun makeImmediateViewportTransition(): ViewportTransition

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

makeOverviewViewportState

androidJvm

abstract fun makeOverviewViewportState(options: OverviewViewportStateOptions): OverviewViewportState

Create a new OverviewViewportState instance with provided OverviewViewportStateOptions.

onDelegateProvider

androidJvm

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

removeStatusObserver

androidJvm

abstract fun removeStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Unsubscribes ViewportStatusObserver from ViewportPlugin.status changes.

toString

androidJvm

open fun toString(): String

transitionTo

androidJvm

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

Executes a transition to requested state.

Properties

defaultTransition

androidJvm

abstract var defaultTransition: ViewportTransition

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

options

androidJvm

abstract var options: ViewportOptions

Configuration options that impact the ViewportPlugin.

status

androidJvm

abstract val status: ViewportStatus

Returns current ViewportStatus.

Inheritors

ViewportPluginImpl