Package com.mapbox.maps.plugin.annotation

Types

Annotation
Link copied to clipboard

Base class for annotations

abstract class Annotation<T : Geometry>(id: Long, jsonObject: JsonObject, geometry: T)
AnnotationConfig
Link copied to clipboard

Config class for annotation plugin to get the annotation manager

data class AnnotationConfig(belowLayerId: String?, layerId: String?, sourceId: String?, annotationSourceOptions: AnnotationSourceOptions?)
AnnotationManager
Link copied to clipboard

Interface for annotationManager

AnnotationManagerImpl
Link copied to clipboard

Base class for annotation managers

abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : AnnotationOptions<G, T>, D : OnAnnotationDragListener<T>, U : OnAnnotationClickListener<T>, V : OnAnnotationLongClickListener<T>, L : Layer>(mapView: View, delegateProvider: MapDelegateProvider, annotationConfig: AnnotationConfig?) : AnnotationManager<G, T, S, D, U, V>
AnnotationOptions
Link copied to clipboard

Options interface for building annotations

fun fun interface AnnotationOptions<G : Geometry, T : Annotation<G>>
AnnotationPlugin
Link copied to clipboard

Plugin interface for the annotation.

interface AnnotationPlugin : MapPlugin, MapSizePlugin, MapStyleObserverPlugin
AnnotationPluginImpl
Link copied to clipboard

The impl class for AnnotationPlugin

class AnnotationPluginImpl : AnnotationPlugin
AnnotationSourceOptions
Link copied to clipboard

Configure class for composing GeoJsonSource objects that included in Annotation

data class AnnotationSourceOptions(maxZoom: Long?, buffer: Long?, lineMetrics: Boolean?, tolerance: Double?, clusterOptions: ClusterOptions?)
AnnotationType
Link copied to clipboard

Enum class for annotation types

enum AnnotationType : Enum<AnnotationType>
ClusterOptions
Link copied to clipboard

Options to show and configure symbol clustering with using SymbolManager.

It exposes a minimal of configuration options, a more advanced setup can be created manually with using CircleLayer and SymbolLayers directly.

data class ClusterOptions(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>?)
ConvertUtils
Link copied to clipboard

Util class for converting properties.

object ConvertUtils
OnAnnotationClickListener
Link copied to clipboard

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

fun fun interface OnAnnotationClickListener<T : Annotation<*>>
OnAnnotationDragListener
Link copied to clipboard

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

interface OnAnnotationDragListener<out T : Annotation<*>>
OnAnnotationLongClickListener
Link copied to clipboard

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

fun fun interface OnAnnotationLongClickListener<T : Annotation<*>>
QueryAnnotationCallback
Link copied to clipboard

Callback for query annotation

fun fun interface QueryAnnotationCallback<T>

Properties

annotations
Link copied to clipboard

Extension val for MapView to get the Annotation plugin instance.

val MapPluginProviderDelegate.annotations: AnnotationPlugin