Mapbox Maps Android/com.mapbox.maps.plugin.annotation.generated/PointAnnotationOptions

PointAnnotationOptions

Builder class from which a pointAnnotation is created.

class PointAnnotationOptions : AnnotationOptions<Point, PointAnnotation>

Constructors

fun PointAnnotationOptions()

Types

Companion

Static variables and methods.

object Companion

Functions

build

Build an annotation

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

equals

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

getData

Get the arbitrary json data of the annotation.

fun getData(): JsonElement?

getDraggable

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

fun getDraggable(): Boolean

getGeometry

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

fun getGeometry(): Point?

getPoint

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

fun getPoint(): Point?

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withData

Set the arbitrary json data of the annotation.

fun withData(jsonElement: JsonElement): PointAnnotationOptions

withDraggable

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

fun withDraggable(draggable: Boolean): PointAnnotationOptions

withGeometry

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

fun withGeometry(geometry: Point): PointAnnotationOptions

withIconAnchor

Set icon-anchor to initialise the pointAnnotation with.

Part of the icon placed closest to the anchor.

fun withIconAnchor(iconAnchor: IconAnchor): PointAnnotationOptions

withIconColor

Set icon-color to initialise the pointAnnotation with.

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

fun withIconColor(iconColor: Int): PointAnnotationOptions

fun withIconColor(iconColor: String): PointAnnotationOptions

withIconHaloBlur

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

Fade out the halo towards the outside.

fun withIconHaloBlur(iconHaloBlur: Double): PointAnnotationOptions

withIconHaloColor

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

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

fun withIconHaloColor(iconHaloColor: Int): PointAnnotationOptions

fun withIconHaloColor(iconHaloColor: String): PointAnnotationOptions

withIconHaloWidth

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

Distance of halo to the icon outline.

fun withIconHaloWidth(iconHaloWidth: Double): PointAnnotationOptions

withIconImage

Set bitmap icon-image to initialise the symbol.

Will not take effect if a String iconImage name has been set.

fun withIconImage(iconImageBitmap: Bitmap): PointAnnotationOptions

Set icon-image to initialise the pointAnnotation with.

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

fun withIconImage(iconImage: String): PointAnnotationOptions

withIconOffset

Set icon-offset to initialise the pointAnnotation with.

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.

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

withIconOpacity

Set icon-opacity to initialise the pointAnnotation with.

The opacity at which the icon will be drawn.

fun withIconOpacity(iconOpacity: Double): PointAnnotationOptions

withIconRotate

Set icon-rotate to initialise the pointAnnotation with.

Rotates the icon clockwise.

fun withIconRotate(iconRotate: Double): PointAnnotationOptions

withIconSize

Set icon-size to initialise the pointAnnotation with.

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.

fun withIconSize(iconSize: Double): PointAnnotationOptions

withPoint

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

fun withPoint(point: Point): PointAnnotationOptions

withSymbolSortKey

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

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.

fun withSymbolSortKey(symbolSortKey: Double): PointAnnotationOptions

withTextAnchor

Set text-anchor to initialise the pointAnnotation with.

Part of the text placed closest to the anchor.

fun withTextAnchor(textAnchor: TextAnchor): PointAnnotationOptions

withTextColor

Set text-color to initialise the pointAnnotation with.

The color with which the text will be drawn.

fun withTextColor(textColor: Int): PointAnnotationOptions

fun withTextColor(textColor: String): PointAnnotationOptions

withTextField

Set text-field to initialise the pointAnnotation with.

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.

fun withTextField(textField: String): PointAnnotationOptions

withTextFont

Set text-font to initialise the pointAnnotation with.

Font stack to use for displaying text.

fun withTextFont(textFont: List<String>): PointAnnotationOptions

withTextHaloBlur

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

The halo's fadeout distance towards the outside.

fun withTextHaloBlur(textHaloBlur: Double): PointAnnotationOptions

withTextHaloColor

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

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

fun withTextHaloColor(textHaloColor: Int): PointAnnotationOptions

fun withTextHaloColor(textHaloColor: String): PointAnnotationOptions

withTextHaloWidth

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

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

fun withTextHaloWidth(textHaloWidth: Double): PointAnnotationOptions

withTextJustify

Set text-justify to initialise the pointAnnotation with.

Text justification options.

fun withTextJustify(textJustify: TextJustify): PointAnnotationOptions

withTextLetterSpacing

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

Text tracking amount.

fun withTextLetterSpacing(textLetterSpacing: Double): PointAnnotationOptions

withTextMaxWidth

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

The maximum line width for text wrapping.

fun withTextMaxWidth(textMaxWidth: Double): PointAnnotationOptions

withTextOffset

Set text-offset to initialise the pointAnnotation with.

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.

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

withTextOpacity

Set text-opacity to initialise the pointAnnotation with.

The opacity at which the text will be drawn.

fun withTextOpacity(textOpacity: Double): PointAnnotationOptions

withTextRadialOffset

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

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.

fun withTextRadialOffset(textRadialOffset: Double): PointAnnotationOptions

withTextRotate

Set text-rotate to initialise the pointAnnotation with.

Rotates the text clockwise.

fun withTextRotate(textRotate: Double): PointAnnotationOptions

withTextSize

Set text-size to initialise the pointAnnotation with.

Font size.

fun withTextSize(textSize: Double): PointAnnotationOptions

withTextTransform

Set text-transform to initialise the pointAnnotation with.

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

fun withTextTransform(textTransform: TextTransform): PointAnnotationOptions

Properties

iconAnchor

Part of the icon placed closest to the anchor.

var iconAnchor: IconAnchor?

iconColor

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

var iconColor: String?

iconHaloBlur

Fade out the halo towards the outside.

var iconHaloBlur: Double?

iconHaloColor

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

var iconHaloColor: String?

iconHaloWidth

Distance of halo to the icon outline.

var iconHaloWidth: Double?

iconImage

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

var iconImage: String?

iconOffset

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.

var iconOffset: List<Double>?

iconOpacity

The opacity at which the icon will be drawn.

var iconOpacity: Double?

iconRotate

Rotates the icon clockwise.

var iconRotate: Double?

iconSize

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.

var iconSize: Double?

symbolSortKey

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.

var symbolSortKey: Double?

textAnchor

Part of the text placed closest to the anchor.

var textAnchor: TextAnchor?

textColor

The color with which the text will be drawn.

var textColor: String?

textField

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?

textFont

Font stack to use for displaying text.

var textFont: List<String>?

textHaloBlur

The halo's fadeout distance towards the outside.

var textHaloBlur: Double?

textHaloColor

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

var textHaloColor: String?

textHaloWidth

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

var textHaloWidth: Double?

textJustify

Text justification options.

var textJustify: TextJustify?

textLetterSpacing

Text tracking amount.

var textLetterSpacing: Double?

textMaxWidth

The maximum line width for text wrapping.

var textMaxWidth: Double?

textOffset

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

The opacity at which the text will be drawn.

var textOpacity: Double?

textRadialOffset

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.

var textRadialOffset: Double?

textRotate

Rotates the text clockwise.

var textRotate: Double?

textSize

Font size.

var textSize: Double?

textTransform

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

var textTransform: TextTransform?