PointAnnotationOptions

Builder class from which a pointAnnotation is created.

Constructors

Link copied to clipboard

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
open override fun build(id: String, annotationManager: AnnotationManager<Point, PointAnnotation, *, *, *, *, *>): PointAnnotation

Build an annotation

Link copied to clipboard
fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

Link copied to clipboard

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

Link copied to clipboard
fun getGeometry(): Point?

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

Link copied to clipboard
fun getPoint(): Point?

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

Link copied to clipboard
fun withData(jsonElement: JsonElement): PointAnnotationOptions

Set the arbitrary json data of the annotation.

Link copied to clipboard

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

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

Link copied to clipboard

Set icon-anchor to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-color to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-emissive-strength to initialise the pointAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Set bitmap icon-image to initialise the symbol.

Set icon-image to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-image-cross-fade to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-offset to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-opacity to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-rotate to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-size to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-text-fit to initialise the pointAnnotation with.

Link copied to clipboard

Set icon-text-fit-padding to initialise the pointAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Set text-anchor to initialise the pointAnnotation with.

Link copied to clipboard

Set text-color to initialise the pointAnnotation with.

Link copied to clipboard

Set text-emissive-strength to initialise the pointAnnotation with.

Link copied to clipboard

Set text-field to initialise the pointAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Set text-justify to initialise the pointAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

Set text-line-height to initialise the pointAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

Set text-offset to initialise the pointAnnotation with.

Link copied to clipboard

Set text-opacity to initialise the pointAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

Set text-rotate to initialise the pointAnnotation with.

Link copied to clipboard

Set text-size to initialise the pointAnnotation with.

Link copied to clipboard

Set text-transform to initialise the pointAnnotation with.

Properties

Link copied to clipboard
var iconAnchor: IconAnchor? = null

Part of the icon placed closest to the anchor. Default value: "center".

Link copied to clipboard
var iconColor: String? = null

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. Default value: "#000000".

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.

Link copied to clipboard
var iconHaloBlur: Double? = null

Fade out the halo towards the outside. Default value: 0. Minimum value: 0.

Link copied to clipboard
var iconHaloColor: String? = null

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard
var iconHaloWidth: Double? = null

Distance of halo to the icon outline. Default value: 0. Minimum value: 0.

Link copied to clipboard
var iconImage: String? = null

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

Link copied to clipboard

Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together. Default value: 0. Value range: 0, 1

Link copied to clipboard
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. Default value: 0,0.

Link copied to clipboard
var iconOpacity: Double? = null

The opacity at which the icon will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard
var iconRotate: Double? = null

Rotates the icon clockwise. Default value: 0.

Link copied to clipboard
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. Default value: 1. Minimum value: 0.

Link copied to clipboard

Scales the icon to fit around the associated text. Default value: "none".

Link copied to clipboard

Size of the additional area added to dimensions determined by icon-text-fit, in clockwise order: top, right, bottom, left. Default value: 0,0,0,0.

Link copied to clipboard
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.

Link copied to clipboard
var textAnchor: TextAnchor? = null

Part of the text placed closest to the anchor. Default value: "center".

Link copied to clipboard
var textColor: String? = null

The color with which the text will be drawn. Default value: "#000000".

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.

Link copied to clipboard
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. SDF images are not supported in formatted text and will be ignored. Default value: "".

Link copied to clipboard
var textHaloBlur: Double? = null

The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0.

Link copied to clipboard
var textHaloColor: String? = null

The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard
var textHaloWidth: Double? = null

Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. Default value: 0. Minimum value: 0.

Link copied to clipboard

Text justification options. Default value: "center".

Link copied to clipboard

Text tracking amount. Default value: 0.

Link copied to clipboard
var textLineHeight: Double? = null

Text leading value for multi-line text. Default value: 1.2.

Link copied to clipboard
var textMaxWidth: Double? = null

The maximum line width for text wrapping. Default value: 10. Minimum value: 0.

Link copied to clipboard
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. Default value: 0,0.

Link copied to clipboard
var textOpacity: Double? = null

The opacity at which the text will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard

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. Default value: 0.

Link copied to clipboard
var textRotate: Double? = null

Rotates the text clockwise. Default value: 0.

Link copied to clipboard
var textSize: Double? = null

Font size. Default value: 16. Minimum value: 0.

Link copied to clipboard

Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".

Extensions

Link copied to clipboard

Set icon-color to initialise the pointAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

Set text-color to initialise the pointAnnotation with.

Link copied to clipboard

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