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

PointAnnotationManager

class PointAnnotationManager(delegateProvider: MapDelegateProvider, annotationConfig: AnnotationConfig? = null) : AnnotationManagerImpl<Point, PointAnnotation, PointAnnotationOptions, OnPointAnnotationDragListener, OnPointAnnotationClickListener, OnPointAnnotationLongClickListener, OnPointAnnotationInteractionListener, SymbolLayer> , ClusterAnnotationManager

The pointAnnotation manager allows to add pointAnnotations to a map.

Constructors

fun PointAnnotationManager(delegateProvider: MapDelegateProvider, annotationConfig: AnnotationConfig? = null)

Types

Companion

object Companion

Static variables and methods.

Functions

addClickListener

open fun addClickListener(u: OnPointAnnotationClickListener): Boolean

addClusterClickListener

open fun addClusterClickListener(clusterClickListener: OnClusterClickListener): Boolean

addClusterLongClickListener

open fun addClusterLongClickListener(onClusterLongClickListener: OnClusterLongClickListener): Boolean

addDragListener

open fun addDragListener(d: OnPointAnnotationDragListener): Boolean

addInteractionListener

open fun addInteractionListener(i: OnPointAnnotationInteractionListener): Boolean

addLongClickListener

open fun addLongClickListener(v: OnPointAnnotationLongClickListener): Boolean

create

fun create(featureCollection: FeatureCollection): List<PointAnnotation>

fun create(json: String): List<PointAnnotation>

Create a list of pointAnnotations on the map.

open override fun create(option: PointAnnotationOptions): PointAnnotation

Create an annotation with the option

open override fun create(options: List<PointAnnotationOptions>): List<PointAnnotation>

Create some annotations with the options

delete

open override fun delete(annotation: PointAnnotation)

Delete the annotation

open override fun delete(annotations: List<PointAnnotation>)

Delete annotations in the list

deleteAll

open override fun deleteAll()

Delete all the added annotations

enableDataDrivenProperty

open override fun enableDataDrivenProperty(property: String)

Enable a data-driven property

getAnnotationIdKey

open override fun getAnnotationIdKey(): String

Get the key of the id of the annotation.

onDestroy

open override fun onDestroy()

Invoked when Mapview or Annotation manager is destroyed.

onSizeChanged

open override fun onSizeChanged(width: Int, height: Int)

Invoked when MapView's width and height have changed.

queryMapForFeatures

fun queryMapForFeatures(point: Point): PointAnnotation?

Query the rendered annotation for given point.

fun queryMapForFeatures(screenCoordinate: ScreenCoordinate): PointAnnotation?

Query the rendered annotation for given screen coordinate.

removeClickListener

open fun removeClickListener(u: OnPointAnnotationClickListener): Boolean

removeClusterClickListener

open fun removeClusterClickListener(clusterClickListener: OnClusterClickListener): Boolean

removeClusterLongClickListener

open fun removeClusterLongClickListener(onClusterLongClickListener: OnClusterLongClickListener): Boolean

removeDragListener

open fun removeDragListener(d: OnPointAnnotationDragListener): Boolean

removeInteractionListener

open fun removeInteractionListener(i: OnPointAnnotationInteractionListener): Boolean

removeLongClickListener

open fun removeLongClickListener(v: OnPointAnnotationLongClickListener): Boolean

selectAnnotation

open override fun selectAnnotation(annotation: PointAnnotation)

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

update

open override fun update(annotation: PointAnnotation)

Update the annotation

open override fun update(annotations: List<PointAnnotation>)

Update annotations in the list

Properties

annotations

open override val annotations: List<PointAnnotation>

The added annotations

associatedLayers

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val associatedLayers: MutableList<String>

The list of layer ids that's associated with the annotation manager.

clickListeners

open override val clickListeners: MutableList<OnPointAnnotationClickListener>

The Added clickListeners

clusterClickListeners

open override val clusterClickListeners: MutableList<OnClusterClickListener>

The Added clusterClickListeners

clusterLongClickListeners

open override val clusterLongClickListeners: MutableList<OnClusterLongClickListener>

The Added clusterLongClickListeners

delegateProvider

override val delegateProvider: MapDelegateProvider

The delegateProvider

dragListeners

open override val dragListeners: MutableList<OnPointAnnotationDragListener>

The added dragListeners

iconAllowOverlap

var iconAllowOverlap: Boolean?

The IconAllowOverlap property

iconAnchor

var iconAnchor: IconAnchor?

The default iconAnchor for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconColorInt

@get:ColorInt

var iconColorInt: Int?

The default iconColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color int.

iconColorSaturation

var iconColorSaturation: Double?

The IconColorSaturation property

iconColorString

var iconColorString: String?

The default iconColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color string.

iconEmissiveStrength

var iconEmissiveStrength: Double?

The default iconEmissiveStrength for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconHaloBlur

var iconHaloBlur: Double?

The default iconHaloBlur for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconHaloColorInt

@get:ColorInt

var iconHaloColorInt: Int?

The default iconHaloColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color int.

iconHaloColorString

var iconHaloColorString: String?

The default iconHaloColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color string.

iconHaloWidth

var iconHaloWidth: Double?

The default iconHaloWidth for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconIgnorePlacement

var iconIgnorePlacement: Boolean?

The IconIgnorePlacement property

iconImage

var iconImage: String?

The default iconImage for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconImageBitmap

var iconImageBitmap: Bitmap? = null

The bitmap image for this Symbol

iconImageCrossFade

var iconImageCrossFade: Double?

The default iconImageCrossFade for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconKeepUpright

var iconKeepUpright: Boolean?

The IconKeepUpright property

iconOcclusionOpacity

var iconOcclusionOpacity: Double?

The default iconOcclusionOpacity for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconOffset

var iconOffset: List<Double>?

The default iconOffset for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconOpacity

var iconOpacity: Double?

The default iconOpacity for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconOptional

var iconOptional: Boolean?

The IconOptional property

iconPadding

var iconPadding: Double?

The IconPadding property

iconPitchAlignment

var iconPitchAlignment: IconPitchAlignment?

The IconPitchAlignment property

iconRotate

var iconRotate: Double?

The default iconRotate for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconRotationAlignment

var iconRotationAlignment: IconRotationAlignment?

The IconRotationAlignment property

iconSize

var iconSize: Double?

The default iconSize for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconTextFit

var iconTextFit: IconTextFit?

The default iconTextFit for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconTextFitPadding

var iconTextFitPadding: List<Double>?

The default iconTextFitPadding for all annotations added to this annotation manager if not overwritten by individual annotation settings.

iconTranslate

var iconTranslate: List<Double>?

The IconTranslate property

iconTranslateAnchor

var iconTranslateAnchor: IconTranslateAnchor?

The IconTranslateAnchor property

interactionListener

open override val interactionListener: MutableList<OnPointAnnotationInteractionListener>

The added interactionListener

layerFilter

open override var layerFilter: Expression?

The filter on the managed pointAnnotations.

longClickListeners

open override val longClickListeners: MutableList<OnPointAnnotationLongClickListener>

The added longClickListeners

slot

var slot: String?

The Slot property

symbolAvoidEdges

var symbolAvoidEdges: Boolean?

The SymbolAvoidEdges property

symbolElevationReference

@MapboxExperimental

var symbolElevationReference: SymbolElevationReference?

The SymbolElevationReference property

symbolPlacement

var symbolPlacement: SymbolPlacement?

The SymbolPlacement property

symbolSortKey

var symbolSortKey: Double?

The default symbolSortKey for all annotations added to this annotation manager if not overwritten by individual annotation settings.

symbolSpacing

var symbolSpacing: Double?

The SymbolSpacing property

symbolZElevate

var symbolZElevate: Boolean?

The SymbolZElevate property

symbolZOffset

@MapboxExperimental

var symbolZOffset: Double?

The default symbolZOffset for all annotations added to this annotation manager if not overwritten by individual annotation settings.

symbolZOrder

var symbolZOrder: SymbolZOrder?

The SymbolZOrder property

textAllowOverlap

var textAllowOverlap: Boolean?

The TextAllowOverlap property

textAnchor

var textAnchor: TextAnchor?

The default textAnchor for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textColorInt

@get:ColorInt

var textColorInt: Int?

The default textColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color int.

textColorString

var textColorString: String?

The default textColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color string.

textEmissiveStrength

var textEmissiveStrength: Double?

The default textEmissiveStrength for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textField

var textField: String?

The default textField for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textFont

var textFont: List<String>?

The TextFont property

textHaloBlur

var textHaloBlur: Double?

The default textHaloBlur for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textHaloColorInt

@get:ColorInt

var textHaloColorInt: Int?

The default textHaloColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color int.

textHaloColorString

var textHaloColorString: String?

The default textHaloColor for all annotations added to this annotation manager if not overwritten by individual annotation settings in color string.

textHaloWidth

var textHaloWidth: Double?

The default textHaloWidth for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textIgnorePlacement

var textIgnorePlacement: Boolean?

The TextIgnorePlacement property

textJustify

var textJustify: TextJustify?

The default textJustify for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textKeepUpright

var textKeepUpright: Boolean?

The TextKeepUpright property

textLetterSpacing

var textLetterSpacing: Double?

The default textLetterSpacing for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textLineHeight

var textLineHeight: Double?

The default textLineHeight for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textMaxAngle

var textMaxAngle: Double?

The TextMaxAngle property

textMaxWidth

var textMaxWidth: Double?

The default textMaxWidth for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textOcclusionOpacity

var textOcclusionOpacity: Double?

The default textOcclusionOpacity for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textOffset

var textOffset: List<Double>?

The default textOffset for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textOpacity

var textOpacity: Double?

The default textOpacity for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textOptional

var textOptional: Boolean?

The TextOptional property

textPadding

var textPadding: Double?

The TextPadding property

textPitchAlignment

var textPitchAlignment: TextPitchAlignment?

The TextPitchAlignment property

textRadialOffset

var textRadialOffset: Double?

The default textRadialOffset for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textRotate

var textRotate: Double?

The default textRotate for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textRotationAlignment

var textRotationAlignment: TextRotationAlignment?

The TextRotationAlignment property

textSize

var textSize: Double?

The default textSize for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textTransform

var textTransform: TextTransform?

The default textTransform for all annotations added to this annotation manager if not overwritten by individual annotation settings.

textTranslate

var textTranslate: List<Double>?

The TextTranslate property

textTranslateAnchor

var textTranslateAnchor: TextTranslateAnchor?

The TextTranslateAnchor property

textVariableAnchor

var textVariableAnchor: List<String>?

The TextVariableAnchor property

textWritingMode

var textWritingMode: List<String>?

The TextWritingMode property