CircleAnnotationManager

The circleAnnotation manager allows to add circleAnnotations to a map.

Constructors

CircleAnnotationManager
Link copied to clipboard
fun CircleAnnotationManager(mapView: View, delegateProvider: MapDelegateProvider, annotationConfig: AnnotationConfig?)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

addAnnotation
Link copied to clipboard

Add an annotation to MapView.

override fun addAnnotation(annotation: CircleAnnotation)
addClickListener
Link copied to clipboard
open override fun addClickListener(u: OnCircleAnnotationClickListener): Boolean
addDragListener
Link copied to clipboard
open override fun addDragListener(d: OnCircleAnnotationDragListener): Boolean
addInteractionListener
Link copied to clipboard
open override fun addInteractionListener(i: OnCircleAnnotationInteractionListener): Boolean
addLongClickListener
Link copied to clipboard
open override fun addLongClickListener(v: OnCircleAnnotationLongClickListener): Boolean
create
Link copied to clipboard

Create a list of circleAnnotations on the map.

CircleAnnotations are going to be created only for features with a matching geometry.

All supported properties are: CircleAnnotationOptions.PROPERTY_CIRCLE_SORT_KEY - Double CircleAnnotationOptions.PROPERTY_CIRCLE_BLUR - Double CircleAnnotationOptions.PROPERTY_CIRCLE_COLOR - String CircleAnnotationOptions.PROPERTY_CIRCLE_OPACITY - Double CircleAnnotationOptions.PROPERTY_CIRCLE_RADIUS - Double CircleAnnotationOptions.PROPERTY_CIRCLE_STROKE_COLOR - String CircleAnnotationOptions.PROPERTY_CIRCLE_STROKE_OPACITY - Double CircleAnnotationOptions.PROPERTY_CIRCLE_STROKE_WIDTH - Double Learn more about above properties in the )The online documentation.

Out of spec properties: "is-draggable" - Boolean, true if the circleAnnotation should be draggable, false otherwise

fun create(featureCollection: FeatureCollection): List<CircleAnnotation>
fun create(json: String): List<CircleAnnotation>

Create an annotation with the option

open override fun create(option: CircleAnnotationOptions): CircleAnnotation

Create some annotations with the options

open override fun create(options: List<CircleAnnotationOptions>): List<CircleAnnotation>
createClusterLevelLayer
Link copied to clipboard
override fun createClusterLevelLayer(level: Int, colorLevels: List<Pair<Int, Int>>): CircleLayer
createClusterTextLayer
Link copied to clipboard
override fun createClusterTextLayer(): SymbolLayer
createDragSource
Link copied to clipboard
override fun createDragSource(): GeoJsonSource
createSource
Link copied to clipboard
override fun createSource(): GeoJsonSource
delete
Link copied to clipboard

Delete the annotation

open override fun delete(annotation: CircleAnnotation)

Delete annotations in the list

open override fun delete(annotations: List<CircleAnnotation>)
deleteAll
Link copied to clipboard

Delete all the added annotations

open override fun deleteAll()
enableDataDrivenProperty
Link copied to clipboard

Enable a data-driven property

open override fun enableDataDrivenProperty(property: String)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getAnnotationIdKey
Link copied to clipboard

Get the key of the id of the annotation.

open override fun getAnnotationIdKey(): String
hashCode
Link copied to clipboard
open override fun hashCode(): Int
initClusterLayers
Link copied to clipboard
override fun initClusterLayers(style: StyleInterface)
onDestroy
Link copied to clipboard

Invoked when Mapview or Annotation manager is destroyed.

open override fun onDestroy()
onSizeChanged
Link copied to clipboard

Invoked when MapView's width and height have changed.

open override fun onSizeChanged(width: Int, height: Int)
queryMapForFeatures
Link copied to clipboard

Query the rendered annotation around the point

override fun queryMapForFeatures(point: Point): CircleAnnotation?
override fun queryMapForFeatures(screenCoordinate: ScreenCoordinate): CircleAnnotation?
removeClickListener
Link copied to clipboard
open override fun removeClickListener(u: OnCircleAnnotationClickListener): Boolean
removeDragListener
Link copied to clipboard
open override fun removeDragListener(d: OnCircleAnnotationDragListener): Boolean
removeInteractionListener
Link copied to clipboard
open override fun removeInteractionListener(i: OnCircleAnnotationInteractionListener): Boolean
removeLongClickListener
Link copied to clipboard
open override fun removeLongClickListener(v: OnCircleAnnotationLongClickListener): Boolean
selectAnnotation
Link copied to clipboard

Toggles the annotation's selection state. If the annotation is deselected, it becomes selected. If the annotation is selected, it becomes deselected.

open override fun selectAnnotation(annotation: CircleAnnotation)
toString
Link copied to clipboard
open override fun toString(): String
update
Link copied to clipboard

Update the annotation

open override fun update(annotation: CircleAnnotation)

Update annotations in the list

open override fun update(annotations: List<CircleAnnotation>)
updateDragSource
Link copied to clipboard
override fun updateDragSource(style: StyleInterface)
updateSource
Link copied to clipboard

Trigger an update to the underlying source

override fun updateSource(style: StyleInterface)

Properties

annotationConfig
Link copied to clipboard
override val annotationConfig: AnnotationConfig?
annotationMap
Link copied to clipboard
override val annotationMap: ConcurrentHashMap<Long, CircleAnnotation>
annotations
Link copied to clipboard

The added annotations

open override val annotations: List<CircleAnnotation>
circlePitchAlignment
Link copied to clipboard

The CirclePitchAlignment property

Orientation of circle when map is pitched.

var circlePitchAlignment: CirclePitchAlignment?
circlePitchScale
Link copied to clipboard

The CirclePitchScale property

Controls the scaling behavior of the circle when the map is pitched.

var circlePitchScale: CirclePitchScale?
circleTranslate
Link copied to clipboard

The CircleTranslate property

The geometry's offset. Values are x, y where negatives indicate left and up, respectively.

var circleTranslate: List<Double>?
circleTranslateAnchor
Link copied to clipboard

The CircleTranslateAnchor property

Controls the frame of reference for {@link PropertyFactory#circleTranslate}.

var circleTranslateAnchor: CircleTranslateAnchor?
clickListeners
Link copied to clipboard

The Added clickListeners

open override val clickListeners: MutableList<OnCircleAnnotationClickListener>
currentId
Link copied to clipboard
override var currentId: Long
delegateProvider
Link copied to clipboard

The delegateProvider

override val delegateProvider: MapDelegateProvider
draggingAnnotation
Link copied to clipboard
override var draggingAnnotation: CircleAnnotation?
dragListeners
Link copied to clipboard

The added dragListeners

open override val dragListeners: MutableList<OnCircleAnnotationDragListener>
gesturesPlugin
Link copied to clipboard
override var gesturesPlugin: GesturesPlugin
handler
Link copied to clipboard
override val handler: Handler
height
Link copied to clipboard
override var height: Int
interactionListener
Link copied to clipboard

The added interactionListener

open override val interactionListener: MutableList<OnCircleAnnotationInteractionListener>
layerFilter
Link copied to clipboard

The filter on the managed circleAnnotations.

open override var layerFilter: Expression?
longClickListeners
Link copied to clipboard

The added longClickListeners

open override val longClickListeners: MutableList<OnCircleAnnotationLongClickListener>
mapCameraManagerDelegate
Link copied to clipboard
override var mapCameraManagerDelegate: MapCameraManagerDelegate
mapFeatureQueryDelegate
Link copied to clipboard
override var mapFeatureQueryDelegate: MapFeatureQueryDelegate
mapListenerDelegate
Link copied to clipboard
override var mapListenerDelegate: MapListenerDelegate
styleStateDelegate
Link copied to clipboard
override var styleStateDelegate: MapStyleStateDelegate
width
Link copied to clipboard
override var width: Int