mapbox-maps-android/com.mapbox.maps.plugin.annotation

Package-level declarations

Types

abstract class Annotation<T : Geometry>(val id: String, jsonObject: JsonObject, var geometry: T)

Base class for annotations

data class AnnotationConfig @JvmOverloads constructor(val belowLayerId: String? = null, val layerId: String? = null, val sourceId: String? = null, val annotationSourceOptions: AnnotationSourceOptions? = null)

Config class for annotation plugin to get the annotation manager

AnnotationManager

interface AnnotationManager<G : Geometry, T : Annotation<G>, S : AnnotationOptions<G, T>, D : OnAnnotationDragListener<T>, U : OnAnnotationClickListener<T>, V : OnAnnotationLongClickListener<T>, I : OnAnnotationInteractionListener<T>>

Interface for annotationManager

AnnotationManagerImpl

@MainThread

abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : AnnotationOptions<G, T>, D : OnAnnotationDragListener<T>, U : OnAnnotationClickListener<T>, V : OnAnnotationLongClickListener<T>, I : OnAnnotationInteractionListener<T>, L : Layer> : AnnotationManager<G, T, S, D, U, V, I>

Base class for annotation managers

AnnotationOptions

fun interface AnnotationOptions<G : Geometry, T : Annotation<G>>

Options interface for building annotations

AnnotationPlugin

interface AnnotationPlugin : MapPlugin, MapSizePlugin, MapStyleObserverPlugin

Plugin interface for the annotation.

AnnotationSourceOptions

data class AnnotationSourceOptions @JvmOverloads constructor(val maxZoom: Long? = null, val buffer: Long? = null, val lineMetrics: Boolean? = null, val tolerance: Double? = null, val clusterOptions: ClusterOptions? = null)

Configure class for composing GeoJsonSource objects that included in Annotation

AnnotationType

enum AnnotationType : Enum<AnnotationType>

Enum class for annotation types

ClusterAnnotationManager

interface ClusterAnnotationManager

Interface for annotationManager that supports clustering

ClusterFeature

class ClusterFeature @RestrictTo(value = [RestrictTo.Scope.LIBRARY]) constructor(featuresetFeature: FeaturesetFeature<FeatureState>)

ClusterFeature is a strongly typed class with cluster related properties in addition to the underlying Feature built from Point.

ClusterOptions

data class ClusterOptions @JvmOverloads constructor(val cluster: Boolean = true, val clusterRadius: Long = 50, val circleRadiusExpression: Value? = null, val circleRadius: Double = 18.0, val textColorExpression: Value? = null, val textColor: Int = Color.WHITE, val textSizeExpression: Value? = null, val textSize: Double = 12.0, val textField: Value? = null, val clusterMaxZoom: Long = 14, val clusterMinPoints: Long = 2, val colorLevels: List<Pair<Int, Int>> = listOf(Pair(0, Color.BLUE)), val clusterProperties: HashMap<String, Any>? = null)

Options to show and configure symbol clustering with using PointAnnotationManager or CircleAnnotationManager.

ConvertUtils

object ConvertUtils

Util class for converting properties.

OnAnnotationClickListener

fun interface OnAnnotationClickListener<T : Annotation<*>>

Generic interface definition of a callback to be invoked when an annotation has been clicked.

OnAnnotationDragListener

interface OnAnnotationDragListener<out T : Annotation<*>>

Generic interface definition of a callback to be invoked when an annotation is being dragged.

OnAnnotationInteractionListener

interface OnAnnotationInteractionListener<T : Annotation<*>>

Generic interface definition of a callback to be invoked when an annotation has been selected or deselected.

OnAnnotationLongClickListener

fun interface OnAnnotationLongClickListener<T : Annotation<*>>

Generic fun interface definition of a callback to be invoked when an annotation has been long clicked.

OnClusterClickListener

fun interface OnClusterClickListener

Interface definition of a callback to be invoked when cluster with annotations has been clicked.

OnClusterLongClickListener

fun interface OnClusterLongClickListener

Interface definition of a callback to be invoked when cluster with annotations has been long clicked.

QueryAnnotationCallback

fun interface QueryAnnotationCallback<T>

Callback for query annotation

Properties

annotations

@get:JvmName(name = "getAnnotations")

val MapPluginProviderDelegate.annotations: AnnotationPlugin

Extension val for MapView to get the Annotation plugin instance.