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

PointAnnotationManager

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

The pointAnnotation manager allows to add pointAnnotations to a map.

Constructors

androidJvm

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

Types

Companion

androidJvm

object Companion

Static variables and methods.

Functions

addClickListener

androidJvm

open fun addClickListener(u: OnPointAnnotationClickListener): Boolean

addDragListener

androidJvm

open fun addDragListener(d: OnPointAnnotationDragListener): Boolean

addInteractionListener

androidJvm

open fun addInteractionListener(i: OnPointAnnotationInteractionListener): Boolean

addLongClickListener

androidJvm

open fun addLongClickListener(v: OnPointAnnotationLongClickListener): Boolean

create

androidJvm

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

Create a list of pointAnnotations on the map.

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

androidJvm

open override fun delete(annotation: PointAnnotation)

Delete the annotation

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

Delete annotations in the list

deleteAll

androidJvm

open override fun deleteAll()

Delete all the added annotations

enableDataDrivenProperty

androidJvm

open override fun enableDataDrivenProperty(property: String)

Enable a data-driven property

equals

androidJvm

open operator fun equals(other: Any?): Boolean

getAnnotationIdKey

androidJvm

open override fun getAnnotationIdKey(): String

Get the key of the id of the annotation.

hashCode

androidJvm

open fun hashCode(): Int

onDestroy

androidJvm

open override fun onDestroy()

Invoked when Mapview or Annotation manager is destroyed.

onSizeChanged

androidJvm

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

Invoked when MapView's width and height have changed.

queryMapForFeatures

androidJvm

fun queryMapForFeatures(point: Point): PointAnnotation?

Query the rendered annotation around the point

fun queryMapForFeatures(screenCoordinate: ScreenCoordinate): PointAnnotation?

Query the rendered annotation around the point

removeClickListener

androidJvm

open fun removeClickListener(u: OnPointAnnotationClickListener): Boolean

removeDragListener

androidJvm

open fun removeDragListener(d: OnPointAnnotationDragListener): Boolean

removeInteractionListener

androidJvm

open fun removeInteractionListener(i: OnPointAnnotationInteractionListener): Boolean

removeLongClickListener

androidJvm

open fun removeLongClickListener(v: OnPointAnnotationLongClickListener): Boolean

selectAnnotation

androidJvm

open override fun selectAnnotation(annotation: PointAnnotation)

Toggles the annotation's selection state.

toString

androidJvm

open fun toString(): String

update

androidJvm

open override fun update(annotation: PointAnnotation)

Update the annotation

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

Update annotations in the list

Properties

annotations

androidJvm

open override val annotations: List<PointAnnotation>

The added annotations

clickListeners

androidJvm

open override val clickListeners: MutableList<OnPointAnnotationClickListener>

The Added clickListeners

delegateProvider

androidJvm

override val delegateProvider: MapDelegateProvider

The delegateProvider

dragListeners

androidJvm

open override val dragListeners: MutableList<OnPointAnnotationDragListener>

The added dragListeners

iconAllowOverlap

androidJvm

var iconAllowOverlap: Boolean?

The IconAllowOverlap propertyIf true, the icon will be visible even if it collides with other previously drawn symbols.

iconIgnorePlacement

androidJvm

var iconIgnorePlacement: Boolean?

The IconIgnorePlacement propertyIf true, other symbols can be visible even if they collide with the icon.

iconKeepUpright

androidJvm

var iconKeepUpright: Boolean?

The IconKeepUpright propertyIf true, the icon may be flipped to prevent it from being rendered upside-down.

iconOptional

androidJvm

var iconOptional: Boolean?

The IconOptional propertyIf true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.

iconPadding

androidJvm

var iconPadding: Double?

The IconPadding propertySize of the additional area around the icon bounding box used for detecting symbol collisions.

iconPitchAlignment

androidJvm

var iconPitchAlignment: IconPitchAlignment?

The IconPitchAlignment propertyOrientation of icon when map is pitched.

iconRotationAlignment

androidJvm

var iconRotationAlignment: IconRotationAlignment?

The IconRotationAlignment propertyIn combination with {@link Property.SYMBOL_PLACEMENT}, determines the rotation behavior of icons.

iconTextFit

androidJvm

var iconTextFit: IconTextFit?

The IconTextFit propertyScales the icon to fit around the associated text.

iconTextFitPadding

androidJvm

var iconTextFitPadding: List<Double>?

The IconTextFitPadding propertySize of the additional area added to dimensions determined by {@link Property.ICON_TEXT_FIT}, in clockwise order: top, right, bottom, left.

iconTranslate

androidJvm

var iconTranslate: List<Double>?

The IconTranslate propertyDistance that the icon's anchor is moved from its original placement.

iconTranslateAnchor

androidJvm

var iconTranslateAnchor: IconTranslateAnchor?

The IconTranslateAnchor propertyControls the frame of reference for {@link PropertyFactory#iconTranslate}.

interactionListener

androidJvm

open override val interactionListener: MutableList<OnPointAnnotationInteractionListener>

The added interactionListener

layerFilter

androidJvm

open override var layerFilter: Expression?

The filter on the managed pointAnnotations.

longClickListeners

androidJvm

open override val longClickListeners: MutableList<OnPointAnnotationLongClickListener>

The added longClickListeners

symbolAvoidEdges

androidJvm

var symbolAvoidEdges: Boolean?

The SymbolAvoidEdges propertyIf true, the symbols will not cross tile edges to avoid mutual collisions.

symbolPlacement

androidJvm

var symbolPlacement: SymbolPlacement?

The SymbolPlacement propertyLabel placement relative to its geometry.

symbolSpacing

androidJvm

var symbolSpacing: Double?

The SymbolSpacing propertyDistance between two symbol anchors.

symbolZOrder

androidJvm

var symbolZOrder: SymbolZOrder?

The SymbolZOrder propertyDetermines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport.

textAllowOverlap

androidJvm

var textAllowOverlap: Boolean?

The TextAllowOverlap propertyIf true, the text will be visible even if it collides with other previously drawn symbols.

textFont

androidJvm

var textFont: List<String>?

The TextFont propertyFont stack to use for displaying text.

textIgnorePlacement

androidJvm

var textIgnorePlacement: Boolean?

The TextIgnorePlacement propertyIf true, other symbols can be visible even if they collide with the text.

textKeepUpright

androidJvm

var textKeepUpright: Boolean?

The TextKeepUpright propertyIf true, the text may be flipped vertically to prevent it from being rendered upside-down.

textLineHeight

androidJvm

var textLineHeight: Double?

The TextLineHeight propertyText leading value for multi-line text.

textMaxAngle

androidJvm

var textMaxAngle: Double?

The TextMaxAngle propertyMaximum angle change between adjacent characters.

textOptional

androidJvm

var textOptional: Boolean?

The TextOptional propertyIf true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.

textPadding

androidJvm

var textPadding: Double?

The TextPadding propertySize of the additional area around the text bounding box used for detecting symbol collisions.

textPitchAlignment

androidJvm

var textPitchAlignment: TextPitchAlignment?

The TextPitchAlignment propertyOrientation of text when map is pitched.

textRotationAlignment

androidJvm

var textRotationAlignment: TextRotationAlignment?

The TextRotationAlignment propertyIn combination with {@link Property.SYMBOL_PLACEMENT}, determines the rotation behavior of the individual glyphs forming the text.

textTranslate

androidJvm

var textTranslate: List<Double>?

The TextTranslate propertyDistance that the text's anchor is moved from its original placement.

textTranslateAnchor

androidJvm

var textTranslateAnchor: TextTranslateAnchor?

The TextTranslateAnchor propertyControls the frame of reference for {@link PropertyFactory#textTranslate}.

textVariableAnchor

androidJvm

var textVariableAnchor: List<String>?

The TextVariableAnchor propertyTo increase the chance of placing high-priority labels on the map, you can provide an array of {@link Property.TEXT_ANCHOR} locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label.

textWritingMode

androidJvm

var textWritingMode: List<String>?

The TextWritingMode propertyThe property allows control over a symbol's orientation.