PointAnnotation

Class for PointAnnotation

class PointAnnotation(id: Long, annotationManager: AnnotationManager<Point, PointAnnotation, *, *, *, *, *>, jsonObject: JsonObject, geometry: Point) : Annotation<Point>

Constructors

PointAnnotation
Link copied to clipboard
fun PointAnnotation(id: Long, annotationManager: AnnotationManager<Point, PointAnnotation, *, *, *, *, *>, jsonObject: JsonObject, geometry: Point)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getData
Link copied to clipboard
open override fun getData(): JsonElement?
getOffsetGeometry
Link copied to clipboard

Get the offset geometry for the touch point

open override fun getOffsetGeometry(mapCameraManagerDelegate: MapCameraManagerDelegate, moveDistancesObject: MoveDistancesObject, touchAreaShiftX: Int, touchAreaShiftY: Int): Point?
getType
Link copied to clipboard

Get the type of this annotation

open override fun getType(): AnnotationType
hashCode
Link copied to clipboard
open override fun hashCode(): Int
setData
Link copied to clipboard
open override fun setData(jsonElement: JsonElement?)
setUsedDataDrivenProperties
Link copied to clipboard

Set the used data-driven properties

open override fun setUsedDataDrivenProperties()
toString
Link copied to clipboard
open override fun toString(): String

Properties

geometry
Link copied to clipboard
override var geometry: Point
iconAnchor
Link copied to clipboard

The iconAnchor property

Part of the icon placed closest to the anchor.

var iconAnchor: IconAnchor?
iconColorInt
Link copied to clipboard

The iconColor property in Int The color of the icon. This can only be used with sdf icons.

var iconColorInt: Int?
iconColorString
Link copied to clipboard

The iconColor property in String

The color of the icon. This can only be used with sdf icons.

var iconColorString: String?
iconHaloBlur
Link copied to clipboard

The iconHaloBlur property

Fade out the halo towards the outside.

var iconHaloBlur: Double?
iconHaloColorInt
Link copied to clipboard

The iconHaloColor property in Int The color of the icon's halo. Icon halos can only be used with SDF icons.

var iconHaloColorInt: Int?
iconHaloColorString
Link copied to clipboard

The iconHaloColor property in String

The color of the icon's halo. Icon halos can only be used with SDF icons.

var iconHaloColorString: String?
iconHaloWidth
Link copied to clipboard

The iconHaloWidth property

Distance of halo to the icon outline.

var iconHaloWidth: Double?
iconImage
Link copied to clipboard

The iconImage property

Name of image in sprite to use for drawing an image background.

var iconImage: String?
iconImageBitmap
Link copied to clipboard

The bitmap image for this Symbol

Will not take effect if iconImage has been set.

var iconImageBitmap: Bitmap?
iconOffset
Link copied to clipboard

The iconOffset property

Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of {@link PropertyFactory#iconSize} to obtain the final offset in density-independent pixels. When combined with {@link PropertyFactory#iconRotate} the offset will be as if the rotated direction was up.

var iconOffset: List<Double>?
iconOpacity
Link copied to clipboard

The iconOpacity property

The opacity at which the icon will be drawn.

var iconOpacity: Double?
iconRotate
Link copied to clipboard

The iconRotate property

Rotates the icon clockwise.

var iconRotate: Double?
iconSize
Link copied to clipboard

The iconSize property

Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by {@link PropertyFactory#iconSize}. 1 is the original size; 3 triples the size of the image.

var iconSize: Double?
id
Link copied to clipboard
override val id: Long
isDraggable
Link copied to clipboard
override var isDraggable: Boolean
isSelected
Link copied to clipboard
override var isSelected: Boolean
jsonObject
Link copied to clipboard
override val jsonObject: JsonObject
point
Link copied to clipboard

The Point of the pointAnnotation, which represents the location of the pointAnnotation on the map

To update the pointAnnotation on the map use {@link PointAnnotationManager#update(Annotation)}.

var point: Point
symbolSortKey
Link copied to clipboard

The symbolSortKey property

Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When {@link PropertyFactory#iconAllowOverlap} or {@link PropertyFactory#textAllowOverlap} is false, features with a lower sort key will have priority during placement. When {@link PropertyFactory#iconAllowOverlap} or {@link PropertyFactory#textAllowOverlap} is set to true, features with a higher sort key will overlap over features with a lower sort key.

var symbolSortKey: Double?
textAnchor
Link copied to clipboard

The textAnchor property

Part of the text placed closest to the anchor.

var textAnchor: TextAnchor?
textColorInt
Link copied to clipboard

The textColor property in Int The color with which the text will be drawn.

var textColorInt: Int?
textColorString
Link copied to clipboard

The textColor property in String

The color with which the text will be drawn.

var textColorString: String?
textField
Link copied to clipboard

The textField property

Value to use for a text label. If a plain string is provided, it will be treated as a formatted with default/inherited formatting options.

var textField: String?
textHaloBlur
Link copied to clipboard

The textHaloBlur property

The halo's fadeout distance towards the outside.

var textHaloBlur: Double?
textHaloColorInt
Link copied to clipboard

The textHaloColor property in Int The color of the text's halo, which helps it stand out from backgrounds.

var textHaloColorInt: Int?
textHaloColorString
Link copied to clipboard

The textHaloColor property in String

The color of the text's halo, which helps it stand out from backgrounds.

var textHaloColorString: String?
textHaloWidth
Link copied to clipboard

The textHaloWidth property

Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.

var textHaloWidth: Double?
textJustify
Link copied to clipboard

The textJustify property

Text justification options.

var textJustify: TextJustify?
textLetterSpacing
Link copied to clipboard

The textLetterSpacing property

Text tracking amount.

var textLetterSpacing: Double?
textMaxWidth
Link copied to clipboard

The textMaxWidth property

The maximum line width for text wrapping.

var textMaxWidth: Double?
textOffset
Link copied to clipboard

The textOffset property

Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.

var textOffset: List<Double>?
textOpacity
Link copied to clipboard

The textOpacity property

The opacity at which the text will be drawn.

var textOpacity: Double?
textRadialOffset
Link copied to clipboard

The textRadialOffset property

Radial offset of text, in the direction of the symbol's anchor. Useful in combination with {@link PropertyFactory#textVariableAnchor}, which defaults to using the two-dimensional {@link PropertyFactory#textOffset} if present.

var textRadialOffset: Double?
textRotate
Link copied to clipboard

The textRotate property

Rotates the text clockwise.

var textRotate: Double?
textSize
Link copied to clipboard

The textSize property

Font size.

var textSize: Double?
textTransform
Link copied to clipboard

The textTransform property

Specifies how to capitalize text, similar to the CSS {@link PropertyFactory#textTransform} property.

var textTransform: TextTransform?