mapbox-maps-android/com.mapbox.maps/MapView

MapView

open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable

A MapView provides an embeddable map interface. You use this class to display map information and to manipulate the map contents from your application. You can center the map on a given coordinate, specify the size of the area you want to display, and style the features of the map to fit your application's use case.

Use of MapView requires a Mapbox API access token. Obtain an access token on the Mapbox account page.

<strong>Warning:</strong> Please note that you are responsible for getting permission to use the map data, and for ensuring your use adheres to the relevant terms of use.

Constructors

MapView

@JvmOverloads()

fun MapView(context: Context, mapInitOptions: MapInitOptions = MapInitOptions(context))

Build a MapView with Context and MapInitOptions objects.

MapView

fun MapView(context: Context, attrs: AttributeSet?)

Build a MapView with Context and AttributeSet objects.

MapView

fun MapView(context: Context, attrs: AttributeSet?, defStyleAttr: Int)

Build a MapView with a Context object, a AttributeSet object, and an Int which represents a style resource file.

Types

Companion

object Companion

Static variables and methods.

OnSnapshotReady

fun fun interface OnSnapshotReady

Interface for getting snapshot result Bitmap.

Functions

addChildrenForAccessibility

open override fun addChildrenForAccessibility(p0: ArrayList<View>)

addExtraDataToAccessibilityNodeInfo

open override fun addExtraDataToAccessibilityNodeInfo(p0: AccessibilityNodeInfo, p1: String, p2: Bundle?)

addFocusables

open fun addFocusables(p0: ArrayList<View>, p1: Int)

open override fun addFocusables(p0: ArrayList<View>, p1: Int, p2: Int)

addKeyboardNavigationClusters

open override fun addKeyboardNavigationClusters(p0: MutableCollection<View>, p1: Int)

addOnAttachStateChangeListener

open fun addOnAttachStateChangeListener(p0: View.OnAttachStateChangeListener)

addOnLayoutChangeListener

open fun addOnLayoutChangeListener(p0: View.OnLayoutChangeListener)

addOnUnhandledKeyEventListener

open fun addOnUnhandledKeyEventListener(p0: View.OnUnhandledKeyEventListener)

addStatesFromChildren

open fun addStatesFromChildren(): Boolean

addTouchables

open override fun addTouchables(p0: ArrayList<View>)

addView

open fun addView(p0: View)

open override fun addView(p0: View, p1: ViewGroup.LayoutParams)

open fun addView(p0: View, p1: Int)

open fun addView(p0: View, p1: Int, p2: ViewGroup.LayoutParams)

open fun addView(p0: View, p1: Int, p2: Int)

addViewInLayout

open fun addViewInLayout(p0: View, p1: Int, p2: ViewGroup.LayoutParams): Boolean

open fun addViewInLayout(p0: View, p1: Int, p2: ViewGroup.LayoutParams, p3: Boolean): Boolean

animate

open fun animate(): ViewPropertyAnimator

announceForAccessibility

open fun announceForAccessibility(p0: CharSequence)

attachLayoutAnimationParameters

open fun attachLayoutAnimationParameters(p0: View, p1: ViewGroup.LayoutParams, p2: Int, p3: Int)

attachViewToParent

open fun attachViewToParent(p0: View, p1: Int, p2: ViewGroup.LayoutParams)

autofill

open fun autofill(p0: SparseArray<AutofillValue>)

open fun autofill(p0: AutofillValue)

awakenScrollBars

open fun awakenScrollBars(): Boolean

open fun awakenScrollBars(p0: Int): Boolean

open fun awakenScrollBars(p0: Int, p1: Boolean): Boolean

bringChildToFront

open override fun bringChildToFront(p0: View)

bringToFront

open fun bringToFront()

buildDrawingCache

open fun buildDrawingCache()

open fun buildDrawingCache(p0: Boolean)

buildLayer

open fun buildLayer()

callOnClick

open fun callOnClick(): Boolean

canAnimate

open fun canAnimate(): Boolean

cancelDragAndDrop

fun cancelDragAndDrop()

cancelLongPress

open fun cancelLongPress()

cancelPendingInputEvents

fun cancelPendingInputEvents()

canResolveLayoutDirection

open fun canResolveLayoutDirection(): Boolean

canResolveTextAlignment

open fun canResolveTextAlignment(): Boolean

canResolveTextDirection

open fun canResolveTextDirection(): Boolean

canScrollHorizontally

open fun canScrollHorizontally(p0: Int): Boolean

canScrollVertically

open fun canScrollVertically(p0: Int): Boolean

checkInputConnectionProxy

open fun checkInputConnectionProxy(p0: View): Boolean

checkLayoutParams

open override fun checkLayoutParams(p0: ViewGroup.LayoutParams): Boolean

childDrawableStateChanged

open override fun childDrawableStateChanged(p0: View)

childHasTransientStateChanged

open override fun childHasTransientStateChanged(p0: View, p1: Boolean)

cleanupLayoutState

open fun cleanupLayoutState(p0: View)

clearAnimation

open fun clearAnimation()

clearChildFocus

open override fun clearChildFocus(p0: View)

clearDisappearingChildren

open fun clearDisappearingChildren()

clearFocus

open override fun clearFocus()

computeHorizontalScrollExtent

open fun computeHorizontalScrollExtent(): Int

computeHorizontalScrollOffset

open fun computeHorizontalScrollOffset(): Int

computeHorizontalScrollRange

open fun computeHorizontalScrollRange(): Int

computeScroll

open fun computeScroll()

computeSystemWindowInsets

open fun computeSystemWindowInsets(p0: WindowInsets, p1: Rect): WindowInsets

computeVerticalScrollExtent

open fun computeVerticalScrollExtent(): Int

computeVerticalScrollOffset

open fun computeVerticalScrollOffset(): Int

computeVerticalScrollRange

open fun computeVerticalScrollRange(): Int

createAccessibilityNodeInfo

open fun createAccessibilityNodeInfo(): AccessibilityNodeInfo

createContextMenu

open fun createContextMenu(p0: ContextMenu)

createPlugin

fun createPlugin(plugin: Plugin)

Create a new plugin instance that will be added to the map.

debug

open fun debug(p0: Int)

destroyDrawingCache

open fun destroyDrawingCache()

detachAllViewsFromParent

open fun detachAllViewsFromParent()

detachViewFromParent

open fun detachViewFromParent(p0: View)

open fun detachViewFromParent(p0: Int)

detachViewsFromParent

open fun detachViewsFromParent(p0: Int, p1: Int)

dispatchApplyWindowInsets

open override fun dispatchApplyWindowInsets(p0: WindowInsets): WindowInsets

dispatchCapturedPointerEvent

open override fun dispatchCapturedPointerEvent(p0: MotionEvent): Boolean

dispatchConfigurationChanged

open override fun dispatchConfigurationChanged(p0: Configuration)

dispatchDisplayHint

open override fun dispatchDisplayHint(p0: Int)

dispatchDragEvent

open override fun dispatchDragEvent(p0: DragEvent): Boolean

dispatchDraw

open override fun dispatchDraw(p0: Canvas)

dispatchDrawableHotspotChanged

open override fun dispatchDrawableHotspotChanged(p0: Float, p1: Float)

dispatchFinishTemporaryDetach

open override fun dispatchFinishTemporaryDetach()

dispatchFreezeSelfOnly

open fun dispatchFreezeSelfOnly(p0: SparseArray<Parcelable>)

dispatchGenericFocusedEvent

open override fun dispatchGenericFocusedEvent(p0: MotionEvent): Boolean

dispatchGenericMotionEvent

open fun dispatchGenericMotionEvent(p0: MotionEvent): Boolean

dispatchGenericPointerEvent

open override fun dispatchGenericPointerEvent(p0: MotionEvent): Boolean

dispatchHoverEvent

open override fun dispatchHoverEvent(p0: MotionEvent): Boolean

dispatchKeyEvent

open override fun dispatchKeyEvent(p0: KeyEvent): Boolean

dispatchKeyEventPreIme

open override fun dispatchKeyEventPreIme(p0: KeyEvent): Boolean

dispatchKeyShortcutEvent

open override fun dispatchKeyShortcutEvent(p0: KeyEvent): Boolean

dispatchNestedFling

open fun dispatchNestedFling(p0: Float, p1: Float, p2: Boolean): Boolean

dispatchNestedPreFling

open fun dispatchNestedPreFling(p0: Float, p1: Float): Boolean

dispatchNestedPrePerformAccessibilityAction

open fun dispatchNestedPrePerformAccessibilityAction(p0: Int, p1: Bundle): Boolean

dispatchNestedPreScroll

open fun dispatchNestedPreScroll(p0: Int, p1: Int, p2: IntArray?, p3: IntArray?): Boolean

dispatchNestedScroll

open fun dispatchNestedScroll(p0: Int, p1: Int, p2: Int, p3: Int, p4: IntArray?): Boolean

dispatchPointerCaptureChanged

open override fun dispatchPointerCaptureChanged(p0: Boolean)

dispatchPopulateAccessibilityEvent

open fun dispatchPopulateAccessibilityEvent(p0: AccessibilityEvent): Boolean

dispatchProvideAutofillStructure

open override fun dispatchProvideAutofillStructure(p0: ViewStructure, p1: Int)

dispatchProvideStructure

open override fun dispatchProvideStructure(p0: ViewStructure)

dispatchRestoreInstanceState

open override fun dispatchRestoreInstanceState(p0: SparseArray<Parcelable>)

dispatchSaveInstanceState

open override fun dispatchSaveInstanceState(p0: SparseArray<Parcelable>)

dispatchSetActivated

open override fun dispatchSetActivated(p0: Boolean)

dispatchSetPressed

open override fun dispatchSetPressed(p0: Boolean)

dispatchSetSelected

open override fun dispatchSetSelected(p0: Boolean)

dispatchStartTemporaryDetach

open override fun dispatchStartTemporaryDetach()

dispatchSystemUiVisibilityChanged

open override fun dispatchSystemUiVisibilityChanged(p0: Int)

dispatchThawSelfOnly

open fun dispatchThawSelfOnly(p0: SparseArray<Parcelable>)

dispatchTouchEvent

open override fun dispatchTouchEvent(p0: MotionEvent): Boolean

dispatchTrackballEvent

open override fun dispatchTrackballEvent(p0: MotionEvent): Boolean

dispatchUnhandledMove

open override fun dispatchUnhandledMove(p0: View, p1: Int): Boolean

dispatchVisibilityChanged

open override fun dispatchVisibilityChanged(p0: View, p1: Int)

dispatchWindowFocusChanged

open override fun dispatchWindowFocusChanged(p0: Boolean)

dispatchWindowInsetsAnimationEnd

open override fun dispatchWindowInsetsAnimationEnd(p0: WindowInsetsAnimation)

dispatchWindowInsetsAnimationPrepare

open override fun dispatchWindowInsetsAnimationPrepare(p0: WindowInsetsAnimation)

dispatchWindowInsetsAnimationProgress

open override fun dispatchWindowInsetsAnimationProgress(p0: WindowInsets, p1: MutableList<WindowInsetsAnimation>): WindowInsets

dispatchWindowInsetsAnimationStart

open override fun dispatchWindowInsetsAnimationStart(p0: WindowInsetsAnimation, p1: WindowInsetsAnimation.Bounds): WindowInsetsAnimation.Bounds

dispatchWindowSystemUiVisiblityChanged

open override fun dispatchWindowSystemUiVisiblityChanged(p0: Int)

dispatchWindowVisibilityChanged

open override fun dispatchWindowVisibilityChanged(p0: Int)

draw

open fun draw(p0: Canvas)

drawableHotspotChanged

open fun drawableHotspotChanged(p0: Float, p1: Float)

drawableStateChanged

open override fun drawableStateChanged()

drawChild

open fun drawChild(p0: Canvas, p1: View, p2: Long): Boolean

endViewTransition

open fun endViewTransition(p0: View)

equals

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

findFocus

open override fun findFocus(): View

findViewById

fun <T : View> findViewById(p0: Int): T

findViewsWithText

open override fun findViewsWithText(p0: ArrayList<View>, p1: CharSequence, p2: Int)

findViewWithTag

fun <T : View> findViewWithTag(p0: Any): T

fitSystemWindows

open fun fitSystemWindows(p0: Rect): Boolean

focusableViewAvailable

open override fun focusableViewAvailable(p0: View)

focusSearch

open fun focusSearch(p0: Int): View

open override fun focusSearch(p0: View, p1: Int): View

forceHasOverlappingRendering

open fun forceHasOverlappingRendering(p0: Boolean)

forceLayout

open fun forceLayout()

gatherTransparentRegion

open fun gatherTransparentRegion(p0: Region): Boolean

generateDefaultLayoutParams

open override fun generateDefaultLayoutParams(): FrameLayout.LayoutParams

generateLayoutParams

open override fun generateLayoutParams(p0: AttributeSet): FrameLayout.LayoutParams

open override fun generateLayoutParams(p0: ViewGroup.LayoutParams): ViewGroup.LayoutParams

getAccessibilityClassName

open override fun getAccessibilityClassName(): CharSequence

getAccessibilityDelegate

open fun getAccessibilityDelegate(): View.AccessibilityDelegate

getAccessibilityLiveRegion

open fun getAccessibilityLiveRegion(): Int

getAccessibilityNodeProvider

open fun getAccessibilityNodeProvider(): AccessibilityNodeProvider

getAccessibilityPaneTitle

open fun getAccessibilityPaneTitle(): CharSequence?

getAccessibilityTraversalAfter

open fun getAccessibilityTraversalAfter(): Int

getAccessibilityTraversalBefore

open fun getAccessibilityTraversalBefore(): Int

getAlpha

open fun getAlpha(): Float

getAnimation

open fun getAnimation(): Animation

getAnimationMatrix

open fun getAnimationMatrix(): Matrix?

getApplicationWindowToken

open fun getApplicationWindowToken(): IBinder

getAttributeResolutionStack

open fun getAttributeResolutionStack(p0: Int): IntArray

getAttributeSourceResourceMap

open fun getAttributeSourceResourceMap(): MutableMap<Int, Int>

getAutofillHints

open fun getAutofillHints(): Array<String>?

getAutofillId

fun getAutofillId(): AutofillId

getAutofillType

open fun getAutofillType(): Int

getAutofillValue

open fun getAutofillValue(): AutofillValue?

getBackground

open fun getBackground(): Drawable

getBackgroundTintBlendMode

open fun getBackgroundTintBlendMode(): BlendMode?

getBackgroundTintList

open fun getBackgroundTintList(): ColorStateList?

getBackgroundTintMode

open fun getBackgroundTintMode(): PorterDuff.Mode?

getBaseline

open fun getBaseline(): Int

getBottom

fun getBottom(): Int

getBottomFadingEdgeStrength

open fun getBottomFadingEdgeStrength(): Float

getBottomPaddingOffset

open fun getBottomPaddingOffset(): Int

getCameraDistance

open fun getCameraDistance(): Float

getChildAt

open fun getChildAt(p0: Int): View

getChildCount

open fun getChildCount(): Int

getChildDrawingOrder

fun getChildDrawingOrder(p0: Int): Int

open fun getChildDrawingOrder(p0: Int, p1: Int): Int

getChildStaticTransformation

open fun getChildStaticTransformation(p0: View, p1: Transformation): Boolean

getChildVisibleRect

open override fun getChildVisibleRect(p0: View, p1: Rect, p2: Point): Boolean

getClipBounds

open fun getClipBounds(): Rect

open fun getClipBounds(p0: Rect): Boolean

getClipChildren

open fun getClipChildren(): Boolean

getClipToOutline

fun getClipToOutline(): Boolean

getClipToPadding

open fun getClipToPadding(): Boolean

getConsiderGoneChildrenWhenMeasuring

open fun getConsiderGoneChildrenWhenMeasuring(): Boolean

getContentCaptureSession

fun getContentCaptureSession(): ContentCaptureSession?

getContentDescription

open fun getContentDescription(): CharSequence

getContext

fun getContext(): Context

getContextMenuInfo

open fun getContextMenuInfo(): ContextMenu.ContextMenuInfo

getDefaultFocusHighlightEnabled

fun getDefaultFocusHighlightEnabled(): Boolean

getDescendantFocusability

open fun getDescendantFocusability(): Int

getDisplay

open fun getDisplay(): Display

getDrawableState

fun getDrawableState(): IntArray

getDrawingCache

open fun getDrawingCache(): Bitmap

open fun getDrawingCache(p0: Boolean): Bitmap

getDrawingCacheBackgroundColor

open fun getDrawingCacheBackgroundColor(): Int

getDrawingCacheQuality

open fun getDrawingCacheQuality(): Int

getDrawingRect

open fun getDrawingRect(p0: Rect)

getDrawingTime

open fun getDrawingTime(): Long

getElevation

open fun getElevation(): Float

getExplicitStyle

open fun getExplicitStyle(): Int

getFilterTouchesWhenObscured

open fun getFilterTouchesWhenObscured(): Boolean

getFitsSystemWindows

open fun getFitsSystemWindows(): Boolean

getFocusable

open fun getFocusable(): Int

getFocusables

open fun getFocusables(p0: Int): ArrayList<View>

getFocusedChild

open fun getFocusedChild(): View

getFocusedRect

open fun getFocusedRect(p0: Rect)

getForeground

open fun getForeground(): Drawable

getForegroundGravity

open fun getForegroundGravity(): Int

getForegroundTintBlendMode

open fun getForegroundTintBlendMode(): BlendMode?

getForegroundTintList

open fun getForegroundTintList(): ColorStateList?

getForegroundTintMode

open fun getForegroundTintMode(): PorterDuff.Mode?

getGlobalVisibleRect

fun getGlobalVisibleRect(p0: Rect): Boolean

open fun getGlobalVisibleRect(p0: Rect, p1: Point): Boolean

getHandler

open fun getHandler(): Handler

getHasOverlappingRendering

fun getHasOverlappingRendering(): Boolean

getHeight

fun getHeight(): Int

getHitRect

open fun getHitRect(p0: Rect)

getHorizontalFadingEdgeLength

open fun getHorizontalFadingEdgeLength(): Int

getHorizontalScrollbarHeight

open fun getHorizontalScrollbarHeight(): Int

getHorizontalScrollbarThumbDrawable

open fun getHorizontalScrollbarThumbDrawable(): Drawable?

getHorizontalScrollbarTrackDrawable

open fun getHorizontalScrollbarTrackDrawable(): Drawable?

getId

open fun getId(): Int

getImportantForAccessibility

open fun getImportantForAccessibility(): Int

getImportantForAutofill

open fun getImportantForAutofill(): Int

getImportantForContentCapture

open fun getImportantForContentCapture(): Int

getKeepScreenOn

open fun getKeepScreenOn(): Boolean

getKeyDispatcherState

open fun getKeyDispatcherState(): KeyEvent.DispatcherState

getLabelFor

open fun getLabelFor(): Int

getLayerType

open fun getLayerType(): Int

getLayoutAnimation

open fun getLayoutAnimation(): LayoutAnimationController

getLayoutAnimationListener

open fun getLayoutAnimationListener(): Animation.AnimationListener

getLayoutDirection

open fun getLayoutDirection(): Int

getLayoutMode

open fun getLayoutMode(): Int

getLayoutParams

open fun getLayoutParams(): ViewGroup.LayoutParams

getLayoutTransition

open fun getLayoutTransition(): LayoutTransition

getLeft

fun getLeft(): Int

getLeftFadingEdgeStrength

open fun getLeftFadingEdgeStrength(): Float

getLeftPaddingOffset

open fun getLeftPaddingOffset(): Int

getLocalVisibleRect

fun getLocalVisibleRect(p0: Rect): Boolean

getLocationInSurface

open fun getLocationInSurface(p0: IntArray)

getLocationInWindow

open fun getLocationInWindow(p0: IntArray)

getLocationOnScreen

open fun getLocationOnScreen(p0: IntArray)

getMapboxMap

open override fun getMapboxMap(): MapboxMap

Returns a MapboxMap object that can be used to interact with the map.

getMatrix

open fun getMatrix(): Matrix

getMeasureAllChildren

open fun getMeasureAllChildren(): Boolean

getMeasuredHeight

fun getMeasuredHeight(): Int

getMeasuredHeightAndState

fun getMeasuredHeightAndState(): Int

getMeasuredState

fun getMeasuredState(): Int

getMeasuredWidth

fun getMeasuredWidth(): Int

getMeasuredWidthAndState

fun getMeasuredWidthAndState(): Int

getMinimumHeight

open fun getMinimumHeight(): Int

getMinimumWidth

open fun getMinimumWidth(): Int

getNestedScrollAxes

open fun getNestedScrollAxes(): Int

getNextClusterForwardId

open fun getNextClusterForwardId(): Int

getNextFocusDownId

open fun getNextFocusDownId(): Int

getNextFocusForwardId

open fun getNextFocusForwardId(): Int

getNextFocusLeftId

open fun getNextFocusLeftId(): Int

getNextFocusRightId

open fun getNextFocusRightId(): Int

getNextFocusUpId

open fun getNextFocusUpId(): Int

getOnFocusChangeListener

open fun getOnFocusChangeListener(): View.OnFocusChangeListener

getOutlineAmbientShadowColor

open fun getOutlineAmbientShadowColor(): Int

getOutlineProvider

open fun getOutlineProvider(): ViewOutlineProvider

getOutlineSpotShadowColor

open fun getOutlineSpotShadowColor(): Int

getOverlay

open override fun getOverlay(): ViewGroupOverlay

getOverScrollMode

open fun getOverScrollMode(): Int

getPaddingBottom

open fun getPaddingBottom(): Int

getPaddingEnd

open fun getPaddingEnd(): Int

getPaddingLeft

open fun getPaddingLeft(): Int

getPaddingRight

open fun getPaddingRight(): Int

getPaddingStart

open fun getPaddingStart(): Int

getPaddingTop

open fun getPaddingTop(): Int

getParent

fun getParent(): ViewParent

getParentForAccessibility

open fun getParentForAccessibility(): ViewParent

getPersistentDrawingCache

open fun getPersistentDrawingCache(): Int

getPivotX

open fun getPivotX(): Float

getPivotY

open fun getPivotY(): Float

getPlugin

open override fun <T : MapPlugin> getPlugin(id: String): T?

Get the plugin instance.

getPointerIcon

open fun getPointerIcon(): PointerIcon

getResources

open fun getResources(): Resources

getRevealOnFocusHint

fun getRevealOnFocusHint(): Boolean

getRight

fun getRight(): Int

getRightFadingEdgeStrength

open fun getRightFadingEdgeStrength(): Float

getRightPaddingOffset

open fun getRightPaddingOffset(): Int

getRootView

open fun getRootView(): View

getRootWindowInsets

open fun getRootWindowInsets(): WindowInsets

getRotation

open fun getRotation(): Float

getRotationX

open fun getRotationX(): Float

getRotationY

open fun getRotationY(): Float

getScaleX

open fun getScaleX(): Float

getScaleY

open fun getScaleY(): Float

getScrollBarDefaultDelayBeforeFade

open fun getScrollBarDefaultDelayBeforeFade(): Int

getScrollBarFadeDuration

open fun getScrollBarFadeDuration(): Int

getScrollBarSize

open fun getScrollBarSize(): Int

getScrollBarStyle

open fun getScrollBarStyle(): Int

getScrollIndicators

open fun getScrollIndicators(): Int

getScrollX

fun getScrollX(): Int

getScrollY

fun getScrollY(): Int

getSolidColor

open fun getSolidColor(): Int

getSourceLayoutResId

open fun getSourceLayoutResId(): Int

getStateDescription

fun getStateDescription(): CharSequence?

getStateListAnimator

open fun getStateListAnimator(): StateListAnimator

getSuggestedMinimumHeight