Dynamic view annotations
There are several ways to add markers, annotations, and other shapes to the map using the Maps SDK. To choose the appropriate approach for your application, read the Markers and annotations guide.
DynamicViewAnnotationActivity.kt
package com.mapbox.maps.testapp.examples.markersandcallouts.viewannotation
import android.content.Context
import android.graphics.Canvas
import android.graphics.Color
import android.graphics.Paint
import android.graphics.Rect
import android.graphics.drawable.BitmapDrawable
import android.graphics.drawable.Drawable
import android.os.Bundle
import android.view.View
import android.widget.Button
import androidx.annotation.ColorInt
import androidx.annotation.UiThread
import androidx.appcompat.app.AppCompatActivity
import androidx.core.content.ContextCompat.getColor
import androidx.core.content.ContextCompat.getDrawable
import androidx.lifecycle.lifecycleScope
import com.mapbox.geojson.Feature
import com.mapbox.geojson.FeatureCollection
import com.mapbox.geojson.GeometryCollection
import com.mapbox.geojson.LineString
import com.mapbox.geojson.Point
import com.mapbox.maps.EdgeInsets
import com.mapbox.maps.ImageHolder
import com.mapbox.maps.MapView
import com.mapbox.maps.MapboxMap
import com.mapbox.maps.Style
import com.mapbox.maps.ViewAnnotationAnchor
import com.mapbox.maps.ViewAnnotationAnchorConfig
import com.mapbox.maps.dsl.cameraOptions
import com.mapbox.maps.extension.style.layers.generated.CircleLayer
import com.mapbox.maps.extension.style.layers.generated.FillLayer
import com.mapbox.maps.extension.style.layers.generated.LineLayer
import com.mapbox.maps.extension.style.layers.properties.generated.LineCap
import com.mapbox.maps.extension.style.sources.generated.GeoJsonSource
import com.mapbox.maps.extension.style.sources.generated.geoJsonSource
import com.mapbox.maps.extension.style.style
import com.mapbox.maps.plugin.LocationPuck2D
import com.mapbox.maps.plugin.PuckBearing
import com.mapbox.maps.plugin.locationcomponent.location
import com.mapbox.maps.plugin.viewport.data.FollowPuckViewportStateOptions
import com.mapbox.maps.plugin.viewport.data.OverviewViewportStateOptions
import com.mapbox.maps.plugin.viewport.viewport
import com.mapbox.maps.testapp.R
import com.mapbox.maps.testapp.databinding.ActivityDynamicViewAnnotationsBinding
import com.mapbox.maps.testapp.examples.annotation.AnnotationUtils
import com.mapbox.maps.testapp.utils.BitmapUtils
import com.mapbox.maps.testapp.utils.SimulateRouteLocationProvider
import com.mapbox.maps.viewannotation.OnViewAnnotationUpdatedListener
import com.mapbox.maps.viewannotation.ViewAnnotationManager
import com.mapbox.maps.viewannotation.annotatedLayerFeature
import com.mapbox.maps.viewannotation.annotationAnchors
import com.mapbox.maps.viewannotation.viewAnnotationOptions
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
/**
* Example how to use dynamic view annotations on line layers and fixed positions.
*
* The example adds following 5 view annotations to the map:
*
* - ETA view annotation
* - Attached to the default route line geometry, configured to fit into the camera
* padding([ViewAnnotationOptions.ignoreCameraPadding]=false) and not overlapping with other view
* annotations or location puck([ViewAnnotationOptions.allowOverlap]=false and
* [ViewAnnotationOptions.allowOverlapWithPuck]=false).
*
* - Alternative ETA view annotation
* - Attached to the alternative routine line geometry, configured to fit into the camera
* padding([ViewAnnotationOptions.ignoreCameraPadding]=false) and not overlapping with other view
* annotations or location puck([ViewAnnotationOptions.allowOverlap]=false and
* [ViewAnnotationOptions.allowOverlapWithPuck]=false).
*
* - 2 parking view annotations
* - Attached to polygon geometries, configured to ignore the camera
* padding([ViewAnnotationOptions.ignoreCameraPadding]=true) and allow overlapping with other view
* annotations([ViewAnnotationOptions.allowOverlap]=true), so they would be visible on a further
* distance in the follow puck mode, where the padding top is set to 500.
* The parking view annotations are not allowed to overlap with the location puck ([ViewAnnotationOptions.allowOverlapWithPuck]=false).
*
* - Construction site view annotation
* - Attached to point geometry, configured to ignore the camera
* padding([ViewAnnotationOptions.ignoreCameraPadding]=true), allow overlapping with other view
* annotations([ViewAnnotationOptions.allowOverlap]=true), and allow overlapping with the location
* puck([ViewAnnotationOptions.allowOverlapWithPuck]=true). This is useful for high priority labels
* that shouldn't be covered by anything.
*/
class DynamicViewAnnotationActivity : AppCompatActivity() {
private lateinit var viewAnnotationManager: ViewAnnotationManager
private lateinit var featureRouteMain: Feature
private lateinit var featureRouteAlt: Feature
private lateinit var featureCollectionParkings: FeatureCollection
private lateinit var featureCollectionConstructionSite: FeatureCollection
// dynamic view annotations
private lateinit var alternativeEtaView: View
private lateinit var etaView: View
private val routeSourceMain: GeoJsonSource = geoJsonSource(SOURCE_MAIN_ID)
private val routeSourceAlt: GeoJsonSource = geoJsonSource(SOURCE_ALT_ID)
private val parkingSource: GeoJsonSource = geoJsonSource(SOURCE_PARKING)
private val constructionSource: GeoJsonSource = geoJsonSource(SOURCE_CONSTRUCTION)
private val routeLayerMain: LineLayer = LineLayer(
layerId = LAYER_MAIN_ID,
sourceId = SOURCE_MAIN_ID
)
private val routeLayerAlt: LineLayer = LineLayer(
layerId = LAYER_ALT_ID,
sourceId = SOURCE_ALT_ID,
)
private val parkingLayer = FillLayer(
layerId = LAYER_PARKING,
sourceId = SOURCE_PARKING
)
private val constructionLayer = CircleLayer(
layerId = LAYER_CONSTRUCTION,
sourceId = SOURCE_CONSTRUCTION
)
private var isMainActive = true
private var isOverview = true
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val binding = ActivityDynamicViewAnnotationsBinding.inflate(layoutInflater)
setContentView(binding.root)
val mapView = binding.mapView
viewAnnotationManager = mapView.viewAnnotationManager
lifecycleScope.launch {
mapView.mapboxMap.setCamera(
cameraOptions {
center(Point.fromLngLat(-122.3004315, 37.535426700013154))
zoom(9.614)
}
)
binding.btnMode.isEnabled = false
binding.btnMode.setOnClickListener {
isOverview = !isOverview
if (isOverview) {
overviewRoute(binding.mapView)
refreshButton(binding.btnMode)
} else {
followLocationIndicator(binding.mapView)
refreshButton(binding.btnMode)
}
}
loadAssets()
mapView.mapboxMap.apply {
initStyleWithLayers {
setupLocation(mapView)
overviewRoute(mapView)
addViewAnnotations()
observeViewAnnotationUpdate()
}
}
mapView.showPaddingZone()
refreshButton(binding.btnMode)
}
}
private suspend fun loadAssets() {
withContext(Dispatchers.Default) {
featureRouteMain = getFeatureFromAsset(ROUTE_MAIN_GEOJSON)
featureRouteAlt = getFeatureFromAsset(ROUTE_ALT_GEOJSON)
featureCollectionParkings = getFeatureCollectionFromAsset(PARKINGS_GEOJSON)
featureCollectionConstructionSite = getFeatureCollectionFromAsset(CONSTRUCTION_GEOJSON)
}
}
private fun MapboxMap.initStyleWithLayers(onLoaded: (Style) -> Unit) {
refreshRoutes()
loadStyle(
style(Style.STANDARD) {
// source for displaying main route
+routeSourceMain
// source for displaying alt route
+routeSourceAlt
// layer for alternative route
+routeLayerAlt.apply {
lineColor(Color.parseColor("#FF999999"))
lineWidth(12.0)
lineBorderWidth(2.0)
lineBorderColor(Color.parseColor("#FF333333"))
}
// layer for main route
+routeLayerMain.apply {
lineColor(Color.parseColor("#FF57A9FB"))
lineWidth(12.0)
lineCap(LineCap.ROUND)
lineBorderWidth(2.0)
lineBorderColor(Color.parseColor("#FF327AC2"))
}
+parkingSource.apply {
featureCollection(featureCollectionParkings)
}
// layer for parkings
+parkingLayer.apply {
fillColor(Color.parseColor("#0080ff")).fillOpacity(0.5)
}
+constructionSource.apply {
featureCollection(featureCollectionConstructionSite)
}
// layer for construction sites
+constructionLayer.apply {
circleColor(Color.TRANSPARENT)
}
},
onLoaded
)
}
private fun setupLocation(mapView: MapView) {
// simulates movement along the route
val simulatedLocationProvider = SimulateRouteLocationProvider(
featureRouteMain.geometry() as LineString
)
mapView.apply {
location.setLocationProvider(simulatedLocationProvider)
location.locationPuck = LocationPuck2D(
bearingImage = ImageHolder.from(R.drawable.mapbox_user_puck_icon),
)
location.enabled = true
location.puckBearingEnabled = true
location.puckBearing = PuckBearing.COURSE
}
}
private fun followLocationIndicator(mapView: MapView) {
mapView.viewport.apply {
transitionTo(
makeFollowPuckViewportState(
FollowPuckViewportStateOptions.Builder()
.pitch(70.0)
.zoom(18.0)
.padding(
EdgeInsets(
/* top = */ 500.0,
/* left = */ 100.0,
/* bottom = */ 100.0,
/* right = */ 100.0
)
)
.build()
)
)
}
}
private fun overviewRoute(mapView: MapView) {
mapView.viewport.transitionTo(
mapView.viewport.makeOverviewViewportState(
OverviewViewportStateOptions.Builder()
.geometry(
GeometryCollection.fromGeometries(
listOf(
featureRouteMain.geometry(),
featureRouteAlt.geometry(),
)
)
)
.padding(
EdgeInsets(
/* top = */ 100.0,
/* left = */ 100.0,
/* bottom = */ 100.0,
/* right = */ 100.0
)
)
.build()
)
)
}
/**
* Renders the padding on top of the MapView.
*/
private fun MapView.showPaddingZone() {
val paddingView = PaddingView(context)
addView(paddingView)
mapboxMap.subscribeCameraChanged {
mapboxMap.cameraState.padding.let {
paddingView.updateRect(
Rect(
/* left = */ it.left.toInt(),
/* top = */ it.top.toInt(),
/* right = */ width - it.right.toInt(),
/* bottom = */ height - it.bottom.toInt()
)
)
}
}
}
/**
* A View that draw a box to showcase padding position.
*/
private class PaddingView(context: Context) : View(context) {
val paint = Paint()
var rect = Rect()
init {
paint.style = Paint.Style.STROKE
paint.color = getColor(context, R.color.primary)
paint.strokeWidth = 3f
}
@UiThread
fun updateRect(rect: Rect) {
this.rect = rect
invalidate()
}
override fun onDraw(canvas: Canvas) {
super.onDraw(canvas)
canvas.drawRect(rect, paint)
}
}
private fun refreshButton(btnMode: Button) {
btnMode.isEnabled = true
btnMode.text = getString(R.string.dynamic_mode, if (isOverview) "follow" else "overview")
}
private fun addViewAnnotations() {
etaView = viewAnnotationManager.addViewAnnotation(
resId = R.layout.item_dva_eta,
options = viewAnnotationOptions {
annotatedLayerFeature(LAYER_MAIN_ID)
annotationAnchors(
{
anchor(ViewAnnotationAnchor.TOP_RIGHT)
},
{
anchor(ViewAnnotationAnchor.TOP_LEFT)
},
{
anchor(ViewAnnotationAnchor.BOTTOM_RIGHT)
},
{
anchor(ViewAnnotationAnchor.BOTTOM_LEFT)
},
)
}
)
alternativeEtaView = viewAnnotationManager.addViewAnnotation(
resId = R.layout.item_dva_alt_eta,
options = viewAnnotationOptions {
annotatedLayerFeature(LAYER_ALT_ID)
annotationAnchors(
{
anchor(ViewAnnotationAnchor.TOP_RIGHT)
},
{
anchor(ViewAnnotationAnchor.TOP_LEFT)
},
{
anchor(ViewAnnotationAnchor.BOTTOM_RIGHT)
},
{
anchor(ViewAnnotationAnchor.BOTTOM_LEFT)
},
)
}
)
alternativeEtaView.setOnClickListener {
toggleActiveRoute()
}
viewAnnotationManager.addViewAnnotation(
resId = R.layout.item_dva_parking,
options = viewAnnotationOptions {
allowOverlap(true)
ignoreCameraPadding(true)
annotatedLayerFeature(LAYER_PARKING) {
featureId(PARKING_FEATURE_ID_1)
}
}
)
viewAnnotationManager.addViewAnnotation(
resId = R.layout.item_dva_parking,
options = viewAnnotationOptions {
allowOverlap(true)
ignoreCameraPadding(true)
annotatedLayerFeature(LAYER_PARKING) {
featureId(PARKING_FEATURE_ID_2)
}
}
)
viewAnnotationManager.addViewAnnotation(
resId = R.layout.item_dva_construction,
options = viewAnnotationOptions {
allowOverlap(true)
allowOverlapWithPuck(true)
ignoreCameraPadding(true)
annotatedLayerFeature(LAYER_CONSTRUCTION) {
featureId(CONSTRUCTION_FEATURE_ID_1)
}
}
)
}
private fun toggleActiveRoute() {
isMainActive = !isMainActive
refreshRoutes()
}
private fun refreshRoutes() {
if (isMainActive) {
routeSourceMain.feature(featureRouteMain)
routeSourceAlt.feature(featureRouteAlt)
} else {
routeSourceMain.feature(featureRouteAlt)
routeSourceAlt.feature(featureRouteMain)
}
}
private fun observeViewAnnotationUpdate() {
viewAnnotationManager.addOnViewAnnotationUpdatedListener(
object : OnViewAnnotationUpdatedListener {
override fun onViewAnnotationAnchorUpdated(
view: View,
anchor: ViewAnnotationAnchorConfig
) {
// set different background according to the anchor
when (view) {
etaView -> {
view.background = getBackground(anchor, getColor(R.color.primary))
}
alternativeEtaView -> {
view.background = getBackground(anchor, getColor(R.color.white))
}
else -> {
// no-op
}
}
}
}
)
}
private suspend fun getFeatureFromAsset(featureGeojson: String) =
Feature.fromJson(
AnnotationUtils.loadStringFromAssets(
this, featureGeojson
)
)
private suspend fun getFeatureCollectionFromAsset(featureGeojson: String) =
FeatureCollection.fromJson(
AnnotationUtils.loadStringFromAssets(
this, featureGeojson
)
)
private fun getBackground(
anchorConfig: ViewAnnotationAnchorConfig,
@ColorInt tint: Int,
): Drawable {
var flipX = false
var flipY = false
when (anchorConfig.anchor) {
ViewAnnotationAnchor.BOTTOM_RIGHT -> {
flipX = true
flipY = true
}
ViewAnnotationAnchor.TOP_RIGHT -> {
flipX = true
}
ViewAnnotationAnchor.BOTTOM_LEFT -> {
flipY = true
}
else -> {
// no-op
}
}
return BitmapDrawable(
resources,
BitmapUtils.drawableToBitmap(
getDrawable(this, R.drawable.bg_dva_eta),
flipX = flipX,
flipY = flipY,
tint = tint,
)!!
)
}
override fun onDestroy() {
super.onDestroy()
}
private companion object {
const val LAYER_MAIN_ID = "layer-main"
const val LAYER_ALT_ID = "layer-alt"
const val LAYER_PARKING = "layer-parking"
const val LAYER_CONSTRUCTION = "layer-construction"
const val SOURCE_MAIN_ID = "source-main"
const val SOURCE_ALT_ID = "source-alt"
const val SOURCE_PARKING = "source-parking"
const val SOURCE_CONSTRUCTION = "source-construction"
const val PARKING_FEATURE_ID_1 = "parking-1"
const val PARKING_FEATURE_ID_2 = "parking-2"
const val CONSTRUCTION_FEATURE_ID_1 = "construction-1"
const val ROUTE_MAIN_GEOJSON = "dva-sf-route-main.geojson"
const val ROUTE_ALT_GEOJSON = "dva-sf-route-alternative.geojson"
const val PARKINGS_GEOJSON = "dva-sf-parkings.geojson"
const val CONSTRUCTION_GEOJSON = "dva-sf-construction.geojson"
}
}
Was this example helpful?