mapbox-maps-android/com.mapbox.maps.viewannotation/ViewAnnotationManager

ViewAnnotationManager

interface ViewAnnotationManager

Manager API to control View Annotations.

View annotations are Android Views that are drawn on top of the MapView and bound to some Geometry (only Point is supported for now). In case some view annotations intersect on the screen Z-index is based on addition order.

View annotations are invariant to map camera transformations however such properties as size, visibility etc could be controlled by the user using update operation.

View annotations are not explicitly bound to any sources however ViewAnnotationOptions.associatedFeatureId could be used to bind given view annotation with some Feature by Feature.id meaning visibility of view annotation will be driven by visibility of given feature.

View annotation manager instance is destroyed automatically when MapView.onDestroy is called.

Functions

addOnViewAnnotationUpdatedListener

androidJvm

abstract fun addOnViewAnnotationUpdatedListener(listener: OnViewAnnotationUpdatedListener)

Add an instance of OnViewAnnotationUpdatedListener.

addViewAnnotation

androidJvm

abstract fun addViewAnnotation(view: View, options: ViewAnnotationOptions)

Add annotation View which is already inflated.

abstract fun addViewAnnotation(@LayoutRes() resId: Int, options: ViewAnnotationOptions): View

Add view annotation inflated from resId synchronously.

abstract fun addViewAnnotation(@LayoutRes() resId: Int, options: ViewAnnotationOptions, asyncInflater: AsyncLayoutInflater, asyncInflateCallback: (View) -> Unit)

Add view annotation inflated from resId asynchronously.

equals

androidJvm

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

getViewAnnotationByFeatureId

androidJvm

abstract fun getViewAnnotationByFeatureId(featureId: String): View?

Find View by feature id if it was specified as part of ViewAnnotationOptions.associatedFeatureId.

getViewAnnotationOptionsByFeatureId

androidJvm

abstract fun getViewAnnotationOptionsByFeatureId(featureId: String): ViewAnnotationOptions?

Find ViewAnnotationOptions of view annotation by feature id if it was specified as part of ViewAnnotationOptions.associatedFeatureId.

getViewAnnotationOptionsByView

androidJvm

abstract fun getViewAnnotationOptionsByView(view: View): ViewAnnotationOptions?

Get current ViewAnnotationOptions for given view.

hashCode

androidJvm

open fun hashCode(): Int

removeAllViewAnnotations

androidJvm

abstract fun removeAllViewAnnotations()

Remove all view annotations.

removeOnViewAnnotationUpdatedListener

androidJvm

abstract fun removeOnViewAnnotationUpdatedListener(listener: OnViewAnnotationUpdatedListener)

Remove an instance of OnViewAnnotationUpdatedListener.

removeViewAnnotation

androidJvm

abstract fun removeViewAnnotation(view: View): Boolean

Remove given annotation view from the map if it was present.

toString

androidJvm

open fun toString(): String

updateViewAnnotation

androidJvm

abstract fun updateViewAnnotation(view: View, options: ViewAnnotationOptions): Boolean

Update given view annotation view with ViewAnnotationOptions.