Package com.mapbox.maps.plugin.annotation

Types

Annotation

abstract class Annotation<T : Geometry>(id: Long, jsonObject: JsonObject, geometry: T)

Base class for annotations

AnnotationConfig

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

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

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>(delegateProvider: MapDelegateProvider, annotationConfig: AnnotationConfig?) : AnnotationManager<G, T, S, D, U, V, I>

Base class for annotation managers

AnnotationOptions

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

Options interface for building annotations

AnnotationPlugin

interface AnnotationPlugin : MapPlugin, MapSizePlugin, MapStyleObserverPlugin

Plugin interface for the annotation.

AnnotationPluginImpl

class AnnotationPluginImpl : AnnotationPlugin

The impl class for AnnotationPlugin

AnnotationSourceOptions

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

Configure class for composing GeoJsonSource objects that included in Annotation

AnnotationType

enum AnnotationType : Enum<AnnotationType>

Enum class for annotation types

ClusterOptions

data class ClusterOptions @JvmOverloads() constructor(cluster: Boolean, clusterRadius: Long, circleRadiusExpression: Value?, circleRadius: Double, textColorExpression: Value?, textColor: Int, textSizeExpression: Value?, textSize: Double, textField: Value?, clusterMaxZoom: Long, colorLevels: List<Pair<Int, Int>>, clusterProperties: HashMap<String, Any>?)

Options to show and configure symbol clustering with using SymbolManager.

ConvertUtils

object ConvertUtils

Util class for converting properties.

OnAnnotationClickListener

fun 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 fun interface OnAnnotationLongClickListener<T : Annotation<*>>

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

QueryAnnotationCallback

fun fun interface QueryAnnotationCallback<T>

Callback for query annotation

Properties

annotations

val MapPluginProviderDelegate.annotations: AnnotationPlugin

Extension val for MapView to get the Annotation plugin instance.