PointAnnotationOptions

class PointAnnotationOptions : AnnotationOptions<Point, PointAnnotation>

Builder class from which a pointAnnotation is created.

Constructors

PointAnnotationOptions

fun PointAnnotationOptions()

Types

Companion

object Companion

Static variables and methods.

Functions

build

open override fun build(id: Long, annotationManager: AnnotationManager<Point, PointAnnotation, *, *, *, *, *>): PointAnnotation

Build an annotation

getData

fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

getDraggable

fun getDraggable(): Boolean

Returns whether this pointAnnotation is draggable, meaning it can be dragged across the screen when touched and moved.

getGeometry

fun getGeometry(): Point?

Get the geometry of the pointAnnotation, which represents the location of the pointAnnotation on the map

getPoint

fun getPoint(): Point?

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

withData

fun withData(jsonElement: JsonElement): PointAnnotationOptions

Set the arbitrary json data of the annotation.

withDraggable

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

fun withGeometry(geometry: Point): PointAnnotationOptions

Set the geometry of the pointAnnotation, which represents the location of the pointAnnotation on the map

withIconAnchor

fun withIconAnchor(iconAnchor: IconAnchor): PointAnnotationOptions

Set icon-anchor to initialise the pointAnnotation with.

withIconColor

fun withIconColor(@ColorInt iconColor: Int): PointAnnotationOptions

fun withIconColor(iconColor: String): PointAnnotationOptions

Set icon-color to initialise the pointAnnotation with.

withIconHaloBlur

fun withIconHaloBlur(iconHaloBlur: Double): PointAnnotationOptions

Set icon-halo-blur to initialise the pointAnnotation with.

withIconHaloColor

fun withIconHaloColor(@ColorInt iconHaloColor: Int): PointAnnotationOptions

fun withIconHaloColor(iconHaloColor: String): PointAnnotationOptions

Set icon-halo-color to initialise the pointAnnotation with.

withIconHaloWidth

fun withIconHaloWidth(iconHaloWidth: Double): PointAnnotationOptions

Set icon-halo-width to initialise the pointAnnotation with.

withIconImage

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

fun withIconOffset(iconOffset: List<Double>): PointAnnotationOptions

Set icon-offset to initialise the pointAnnotation with.

withIconOpacity

fun withIconOpacity(iconOpacity: Double): PointAnnotationOptions

Set icon-opacity to initialise the pointAnnotation with.

withIconRotate

fun withIconRotate(iconRotate: Double): PointAnnotationOptions

Set icon-rotate to initialise the pointAnnotation with.

withIconSize

fun withIconSize(iconSize: Double): PointAnnotationOptions

Set icon-size to initialise the pointAnnotation with.

withPoint

fun withPoint(point: Point): PointAnnotationOptions

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

withSymbolSortKey

fun withSymbolSortKey(symbolSortKey: Double): PointAnnotationOptions

Set symbol-sort-key to initialise the pointAnnotation with.

withTextAnchor

fun withTextAnchor(textAnchor: TextAnchor): PointAnnotationOptions

Set text-anchor to initialise the pointAnnotation with.

withTextColor

fun withTextColor(@ColorInt textColor: Int): PointAnnotationOptions

fun withTextColor(textColor: String): PointAnnotationOptions

Set text-color to initialise the pointAnnotation with.

withTextField

fun withTextField(textField: String): PointAnnotationOptions

Set text-field to initialise the pointAnnotation with.

withTextHaloBlur

fun withTextHaloBlur(textHaloBlur: Double): PointAnnotationOptions

Set text-halo-blur to initialise the pointAnnotation with.

withTextHaloColor

fun withTextHaloColor(@ColorInt textHaloColor: Int): PointAnnotationOptions

fun withTextHaloColor(textHaloColor: String): PointAnnotationOptions

Set text-halo-color to initialise the pointAnnotation with.

withTextHaloWidth

fun withTextHaloWidth(textHaloWidth: Double): PointAnnotationOptions

Set text-halo-width to initialise the pointAnnotation with.

withTextJustify

fun withTextJustify(textJustify: TextJustify): PointAnnotationOptions

Set text-justify to initialise the pointAnnotation with.

withTextLetterSpacing

fun withTextLetterSpacing(textLetterSpacing: Double): PointAnnotationOptions

Set text-letter-spacing to initialise the pointAnnotation with.

withTextMaxWidth

fun withTextMaxWidth(textMaxWidth: Double): PointAnnotationOptions

Set text-max-width to initialise the pointAnnotation with.

withTextOffset

fun withTextOffset(textOffset: List<Double>): PointAnnotationOptions

Set text-offset to initialise the pointAnnotation with.

withTextOpacity

fun withTextOpacity(textOpacity: Double): PointAnnotationOptions

Set text-opacity to initialise the pointAnnotation with.

withTextRadialOffset

fun withTextRadialOffset(textRadialOffset: Double): PointAnnotationOptions

Set text-radial-offset to initialise the pointAnnotation with.

withTextRotate

fun withTextRotate(textRotate: Double): PointAnnotationOptions

Set text-rotate to initialise the pointAnnotation with.

withTextSize

fun withTextSize(textSize: Double): PointAnnotationOptions

Set text-size to initialise the pointAnnotation with.

withTextTransform

fun withTextTransform(textTransform: TextTransform): PointAnnotationOptions

Set text-transform to initialise the pointAnnotation with.

Properties

iconAnchor

var iconAnchor: IconAnchor? = null

Part of the icon placed closest to the anchor.

iconColor

var iconColor: String? = null

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

iconHaloBlur

var iconHaloBlur: Double? = null

Fade out the halo towards the outside.

iconHaloColor

var iconHaloColor: String? = null

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

iconHaloWidth

var iconHaloWidth: Double? = null

Distance of halo to the icon outline.

iconImage

var iconImage: String? = null

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

iconOffset

var iconOffset: List<Double>? = null

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 icon-size to obtain the final offset in pixels. When combined with icon-rotate the offset will be as if the rotated direction was up.

iconOpacity

var iconOpacity: Double? = null

The opacity at which the icon will be drawn.

iconRotate

var iconRotate: Double? = null

Rotates the icon clockwise.

iconSize

var iconSize: Double? = null

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 icon-size. 1 is the original size; 3 triples the size of the image.

symbolSortKey

var symbolSortKey: Double? = null

Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When icon-allow-overlap or text-allow-overlap is false, features with a lower sort key will have priority during placement. When icon-allow-overlap or text-allow-overlap is set to true, features with a higher sort key will overlap over features with a lower sort key.

textAnchor

var textAnchor: TextAnchor? = null

Part of the text placed closest to the anchor.

textColor

var textColor: String? = null

The color with which the text will be drawn.

textField

var textField: String? = null

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.

textHaloBlur

var textHaloBlur: Double? = null

The halo's fadeout distance towards the outside.

textHaloColor

var textHaloColor: String? = null

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

textHaloWidth

var textHaloWidth: Double? = null

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

textJustify

var textJustify: TextJustify? = null

Text justification options.

textLetterSpacing

var textLetterSpacing: Double? = null

Text tracking amount.

textMaxWidth

var textMaxWidth: Double? = null

The maximum line width for text wrapping.

textOffset

var textOffset: List<Double>? = null

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.

textOpacity

var textOpacity: Double? = null

The opacity at which the text will be drawn.

textRadialOffset

var textRadialOffset: Double? = null

Radial offset of text, in the direction of the symbol's anchor. Useful in combination with text-variable-anchor, which defaults to using the two-dimensional text-offset if present.

textRotate

var textRotate: Double? = null

Rotates the text clockwise.

textSize

var textSize: Double? = null

Font size.

textTransform

var textTransform: TextTransform? = null

Specifies how to capitalize text, similar to the CSS text-transform property.