PointAnnotationOptions

class PointAnnotationOptions : AnnotationOptions<Point, PointAnnotation>

Builder class from which a pointAnnotation is created.

Constructors

PointAnnotationOptions
Link copied to clipboard
fun PointAnnotationOptions()

Types

Companion
Link copied to clipboard
object Companion
Static variables and methods.

Functions

build
Link copied to clipboard
open override fun build(id: Long, annotationManager: AnnotationManager<Point, PointAnnotation, *, *, *, *, *>): PointAnnotation
Build an annotation
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
getData
Link copied to clipboard
fun getData(): JsonElement?
Get the arbitrary json data of the annotation.
getDraggable
Link copied to clipboard
fun getDraggable(): Boolean
Returns whether this pointAnnotation is draggable, meaning it can be dragged across the screen when touched and moved.
getGeometry
Link copied to clipboard
fun getGeometry(): Point?
Get the geometry of the pointAnnotation, which represents the location of the pointAnnotation on the map
getPoint
Link copied to clipboard
fun getPoint(): Point?
Get the Point of the pointAnnotation, which represents the location of the pointAnnotation on the map
hashCode
Link copied to clipboard
open fun hashCode(): Int
toString
Link copied to clipboard
open fun toString(): String
withData
Link copied to clipboard
fun withData(jsonElement: JsonElement): PointAnnotationOptions
Set the arbitrary json data of the annotation.
withDraggable
Link copied to clipboard
fun withDraggable(draggable: Boolean): PointAnnotationOptions
Set whether this pointAnnotation should be draggable, meaning it can be dragged across the screen when touched and moved.
withGeometry
Link copied to clipboard
fun withGeometry(geometry: Point): PointAnnotationOptions
Set the geometry of the pointAnnotation, which represents the location of the pointAnnotation on the map
withIconAnchor
Link copied to clipboard
fun withIconAnchor(iconAnchor: IconAnchor): PointAnnotationOptions
Set icon-anchor to initialise the pointAnnotation with.
withIconColor
Link copied to clipboard
fun withIconColor(@ColorInt() iconColor: Int): PointAnnotationOptions
Set icon-color to initialise the pointAnnotation with.
fun withIconColor(iconColor: String): PointAnnotationOptions
Set icon-color to initialise the pointAnnotation with.
withIconHaloBlur
Link copied to clipboard
fun withIconHaloBlur(iconHaloBlur: Double): PointAnnotationOptions
Set icon-halo-blur to initialise the pointAnnotation with.
withIconHaloColor
Link copied to clipboard
fun withIconHaloColor(@ColorInt() iconHaloColor: Int): PointAnnotationOptions
Set icon-halo-color to initialise the pointAnnotation with.
fun withIconHaloColor(iconHaloColor: String): PointAnnotationOptions
Set icon-halo-color to initialise the pointAnnotation with.
withIconHaloWidth
Link copied to clipboard
fun withIconHaloWidth(iconHaloWidth: Double): PointAnnotationOptions
Set icon-halo-width to initialise the pointAnnotation with.
withIconImage
Link copied to clipboard
fun withIconImage(iconImageBitmap: Bitmap): PointAnnotationOptions
Set bitmap icon-image to initialise the symbol.
fun withIconImage(iconImage: String): PointAnnotationOptions
Set icon-image to initialise the pointAnnotation with.
withIconOffset
Link copied to clipboard
fun withIconOffset(iconOffset: List<Double>): PointAnnotationOptions
Set icon-offset to initialise the pointAnnotation with.
withIconOpacity
Link copied to clipboard
fun withIconOpacity(iconOpacity: Double): PointAnnotationOptions
Set icon-opacity to initialise the pointAnnotation with.
withIconRotate
Link copied to clipboard
fun withIconRotate(iconRotate: Double): PointAnnotationOptions
Set icon-rotate to initialise the pointAnnotation with.
withIconSize
Link copied to clipboard
fun withIconSize(iconSize: Double): PointAnnotationOptions
Set icon-size to initialise the pointAnnotation with.
withPoint
Link copied to clipboard
fun withPoint(point: Point): PointAnnotationOptions
Set the Point of the pointAnnotation, which represents the location of the pointAnnotation on the map
withSymbolSortKey
Link copied to clipboard
fun withSymbolSortKey(symbolSortKey: Double): PointAnnotationOptions
Set symbol-sort-key to initialise the pointAnnotation with.
withTextAnchor
Link copied to clipboard
fun withTextAnchor(textAnchor: TextAnchor): PointAnnotationOptions
Set text-anchor to initialise the pointAnnotation with.
withTextColor
Link copied to clipboard
fun withTextColor(@ColorInt() textColor: Int): PointAnnotationOptions
Set text-color to initialise the pointAnnotation with.
fun withTextColor(textColor: String): PointAnnotationOptions
Set text-color to initialise the pointAnnotation with.
withTextField
Link copied to clipboard
fun withTextField(textField: String): PointAnnotationOptions
Set text-field to initialise the pointAnnotation with.
withTextHaloBlur
Link copied to clipboard
fun withTextHaloBlur(textHaloBlur: Double): PointAnnotationOptions
Set text-halo-blur to initialise the pointAnnotation with.
withTextHaloColor
Link copied to clipboard
fun withTextHaloColor(@ColorInt() textHaloColor: Int): PointAnnotationOptions
Set text-halo-color to initialise the pointAnnotation with.
fun withTextHaloColor(textHaloColor: String): PointAnnotationOptions
Set text-halo-color to initialise the pointAnnotation with.
withTextHaloWidth
Link copied to clipboard
fun withTextHaloWidth(textHaloWidth: Double): PointAnnotationOptions
Set text-halo-width to initialise the pointAnnotation with.
withTextJustify
Link copied to clipboard
fun withTextJustify(textJustify: TextJustify): PointAnnotationOptions
Set text-justify to initialise the pointAnnotation with.
withTextLetterSpacing
Link copied to clipboard
fun withTextLetterSpacing(textLetterSpacing: Double): PointAnnotationOptions
Set text-letter-spacing to initialise the pointAnnotation with.
withTextMaxWidth
Link copied to clipboard
fun withTextMaxWidth(textMaxWidth: Double): PointAnnotationOptions
Set text-max-width to initialise the pointAnnotation with.
withTextOffset
Link copied to clipboard
fun withTextOffset(textOffset: List<Double>): PointAnnotationOptions
Set text-offset to initialise the pointAnnotation with.
withTextOpacity
Link copied to clipboard
fun withTextOpacity(textOpacity: Double): PointAnnotationOptions
Set text-opacity to initialise the pointAnnotation with.
withTextRadialOffset
Link copied to clipboard
fun withTextRadialOffset(textRadialOffset: Double): PointAnnotationOptions
Set text-radial-offset to initialise the pointAnnotation with.
withTextRotate
Link copied to clipboard
fun withTextRotate(textRotate: Double): PointAnnotationOptions
Set text-rotate to initialise the pointAnnotation with.
withTextSize
Link copied to clipboard
fun withTextSize(textSize: Double): PointAnnotationOptions
Set text-size to initialise the pointAnnotation with.
withTextTransform
Link copied to clipboard
fun withTextTransform(textTransform: TextTransform): PointAnnotationOptions
Set text-transform to initialise the pointAnnotation with.

Properties

iconAnchor
Link copied to clipboard
var iconAnchor: IconAnchor? = null
Part of the icon placed closest to the anchor.
iconColor
Link copied to clipboard
var iconColor: String? = null
The color of the icon.
iconHaloBlur
Link copied to clipboard
var iconHaloBlur: Double? = null
Fade out the halo towards the outside.
iconHaloColor
Link copied to clipboard
var iconHaloColor: String? = null
The color of the icon's halo.
iconHaloWidth
Link copied to clipboard
var iconHaloWidth: Double? = null
Distance of halo to the icon outline.
iconImage
Link copied to clipboard
var iconImage: String? = null
Name of image in sprite to use for drawing an image background.
iconOffset
Link copied to clipboard
var iconOffset: List<Double>? = null
Offset distance of icon from its anchor.
iconOpacity
Link copied to clipboard
var iconOpacity: Double? = null
The opacity at which the icon will be drawn.
iconRotate
Link copied to clipboard
var iconRotate: Double? = null
Rotates the icon clockwise.
iconSize
Link copied to clipboard
var iconSize: Double? = null
Scales the original size of the icon by the provided factor.
symbolSortKey
Link copied to clipboard
var symbolSortKey: Double? = null
Sorts features in ascending order based on this value.
textAnchor
Link copied to clipboard
var textAnchor: TextAnchor? = null
Part of the text placed closest to the anchor.
textColor
Link copied to clipboard
var textColor: String? = null
The color with which the text will be drawn.
textField
Link copied to clipboard
var textField: String? = null
Value to use for a text label.
textHaloBlur
Link copied to clipboard
var textHaloBlur: Double? = null
The halo's fadeout distance towards the outside.
textHaloColor
Link copied to clipboard
var textHaloColor: String? = null
The color of the text's halo, which helps it stand out from backgrounds.
textHaloWidth
Link copied to clipboard
var textHaloWidth: Double? = null
Distance of halo to the font outline.
textJustify
Link copied to clipboard
var textJustify: TextJustify? = null
Text justification options.
textLetterSpacing
Link copied to clipboard
var textLetterSpacing: Double? = null
Text tracking amount.
textMaxWidth
Link copied to clipboard
var textMaxWidth: Double? = null
The maximum line width for text wrapping.
textOffset
Link copied to clipboard
var textOffset: List<Double>? = null
Offset distance of text from its anchor.
textOpacity
Link copied to clipboard
var textOpacity: Double? = null
The opacity at which the text will be drawn.
textRadialOffset
Link copied to clipboard
var textRadialOffset: Double? = null
Radial offset of text, in the direction of the symbol's anchor.
textRotate
Link copied to clipboard
var textRotate: Double? = null
Rotates the text clockwise.
textSize
Link copied to clipboard
var textSize: Double? = null
Font size.
textTransform
Link copied to clipboard
var textTransform: TextTransform? = null
Specifies how to capitalize text, similar to the CSS text-transform property.