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

SymbolOptions

Builder class from which a symbol is created.

class SymbolOptions : AnnotationOptions<Point, Symbol>

Constructors

SymbolOptions

fun SymbolOptions()

Types

Companion

Static variables and methods.

object Companion

Functions

build

Build an annotation

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

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 symbol is draggable, meaning it can be dragged across the screen when touched and moved.

fun getDraggable(): Boolean

getGeometry

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

fun getGeometry(): Point?

getPoint

Get the Point of the symbol, which represents the location of the symbol 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): SymbolOptions

withDraggable

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

fun withDraggable(draggable: Boolean): SymbolOptions

withGeometry

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

fun withGeometry(geometry: Point): SymbolOptions

withIconAnchor

Set icon-anchor to initialise the symbol with.

Part of the icon placed closest to the anchor.

fun withIconAnchor(iconAnchor: IconAnchor): SymbolOptions

withIconColor

Set icon-color to initialise the symbol with.

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

fun withIconColor(iconColor: String): SymbolOptions

withIconHaloBlur

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

Fade out the halo towards the outside.

fun withIconHaloBlur(iconHaloBlur: Double): SymbolOptions

withIconHaloColor

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

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

fun withIconHaloColor(iconHaloColor: String): SymbolOptions

withIconHaloWidth

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

Distance of halo to the icon outline.

fun withIconHaloWidth(iconHaloWidth: Double): SymbolOptions

withIconImage

Set icon-image to initialise the symbol with.

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

fun withIconImage(iconImage: String): SymbolOptions

withIconOffset

Set icon-offset to initialise the symbol 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>): SymbolOptions

withIconOpacity

Set icon-opacity to initialise the symbol with.

The opacity at which the icon will be drawn.

fun withIconOpacity(iconOpacity: Double): SymbolOptions

withIconRotate

Set icon-rotate to initialise the symbol with.

Rotates the icon clockwise.

fun withIconRotate(iconRotate: Double): SymbolOptions

withIconSize

Set icon-size to initialise the symbol 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): SymbolOptions

withPoint

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

fun withPoint(point: Point): SymbolOptions

withSymbolSortKey

Set symbol-sort-key to initialise the symbol 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): SymbolOptions

withTextAnchor

Set text-anchor to initialise the symbol with.

Part of the text placed closest to the anchor.

fun withTextAnchor(textAnchor: TextAnchor): SymbolOptions

withTextColor

Set text-color to initialise the symbol with.

The color with which the text will be drawn.

fun withTextColor(textColor: String): SymbolOptions

withTextField

Set text-field to initialise the symbol 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): SymbolOptions

withTextFont

Set text-font to initialise the symbol with.

Font stack to use for displaying text.

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

withTextHaloBlur

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

The halo's fadeout distance towards the outside.

fun withTextHaloBlur(textHaloBlur: Double): SymbolOptions

withTextHaloColor

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

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

fun withTextHaloColor(textHaloColor: String): SymbolOptions

withTextHaloWidth

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

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

fun withTextHaloWidth(textHaloWidth: Double): SymbolOptions

withTextJustify

Set text-justify to initialise the symbol with.

Text justification options.

fun withTextJustify(textJustify: TextJustify): SymbolOptions

withTextLetterSpacing

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

Text tracking amount.

fun withTextLetterSpacing(textLetterSpacing: Double): SymbolOptions

withTextMaxWidth

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

The maximum line width for text wrapping.

fun withTextMaxWidth(textMaxWidth: Double): SymbolOptions

withTextOffset

Set text-offset to initialise the symbol 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>): SymbolOptions

withTextOpacity

Set text-opacity to initialise the symbol with.

The opacity at which the text will be drawn.

fun withTextOpacity(textOpacity: Double): SymbolOptions

withTextRadialOffset

Set text-radial-offset to initialise the symbol 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): SymbolOptions

withTextRotate

Set text-rotate to initialise the symbol with.

Rotates the text clockwise.

fun withTextRotate(textRotate: Double): SymbolOptions

withTextSize

Set text-size to initialise the symbol with.

Font size.

fun withTextSize(textSize: Double): SymbolOptions

withTextTransform

Set text-transform to initialise the symbol with.

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

fun withTextTransform(textTransform: TextTransform): SymbolOptions

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