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

Symbol

Class for Symbol

class Symbol(id: Long, annotationManager: AnnotationManager<Point, Symbol, *, *, *, *>, jsonObject: JsonObject, geometry: Point) : Annotation<Point>

Constructors

Symbol

fun Symbol(id: Long, annotationManager: AnnotationManager<Point, Symbol, *, *, *, *>, jsonObject: JsonObject, geometry: Point)

Types

Companion

Static variables and methods.

object Companion

Functions

equals

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

getData

open override fun getData(): JsonElement?

getOffsetGeometry

Get the offset geometry for the touch point

open override fun getOffsetGeometry(projectionDelegate: MapProjectionDelegate, moveDistancesObject: MoveDistancesObject, touchAreaShiftX: Int, touchAreaShiftY: Int): Point?

getType

Get the type of this annotation

open override fun getType(): AnnotationType

hashCode

open override fun hashCode(): Int

setData

open override fun setData(jsonElement: JsonElement?)

setUsedDataDrivenProperties

Set the used data-driven properties

open override fun setUsedDataDrivenProperties()

toString

open override fun toString(): String

Properties

annotationManager

The annotation manger that manipulate this annotation

val annotationManager: AnnotationManager<Point, Symbol, *, *, *, *>

geometry

override var geometry: Point

iconAnchor

The iconAnchor property

Part of the icon placed closest to the anchor.

var iconAnchor: IconAnchor?

iconColorInt

The iconColor property in Int

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

var iconColorInt: Int?

iconColorString

The iconColor property in String

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

var iconColorString: String?

iconHaloBlur

The iconHaloBlur property

Fade out the halo towards the outside.

var iconHaloBlur: Double?

iconHaloColorInt

The iconHaloColor property in Int

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

var iconHaloColorInt: Int?

iconHaloColorString

The iconHaloColor property in String

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

var iconHaloColorString: String?

iconHaloWidth

The iconHaloWidth property

Distance of halo to the icon outline.

var iconHaloWidth: Double?

iconImage

The iconImage property

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

var iconImage: String?

iconOffset

The iconOffset property

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.

var iconOffset: List<Double>?

iconOpacity

The iconOpacity property

The opacity at which the icon will be drawn.

var iconOpacity: Double?

iconRotate

The iconRotate property

Rotates the icon clockwise.

var iconRotate: Double?

iconSize

The iconSize property

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.

var iconSize: Double?

override val id: Long

isDraggable

override var isDraggable: Boolean

jsonObject

override val jsonObject: JsonObject

point

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

To update the symbol on the map use {@link SymbolManager#update(Annotation)}.

var point: Point

symbolSortKey

The symbolSortKey property

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.

var symbolSortKey: Double?

textAnchor

The textAnchor property

Part of the text placed closest to the anchor.

var textAnchor: TextAnchor?

textColorInt

The textColor property in Int

The color with which the text will be drawn.

var textColorInt: Int?

textColorString

The textColor property in String

The color with which the text will be drawn.

var textColorString: String?

textField

The textField property

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

The textFont property

Font stack to use for displaying text.

var textFont: List<String>?

textHaloBlur

The textHaloBlur property

The halo's fadeout distance towards the outside.

var textHaloBlur: Double?

textHaloColorInt

The textHaloColor property in Int

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

var textHaloColorInt: Int?

textHaloColorString

The textHaloColor property in String

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

var textHaloColorString: String?

textHaloWidth

The textHaloWidth property

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

var textHaloWidth: Double?

textJustify

The textJustify property

Text justification options.

var textJustify: TextJustify?

textLetterSpacing

The textLetterSpacing property

Text tracking amount.

var textLetterSpacing: Double?

textMaxWidth

The textMaxWidth property

The maximum line width for text wrapping.

var textMaxWidth: Double?

textOffset

The textOffset property

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 textOpacity property

The opacity at which the text will be drawn.

var textOpacity: Double?

textRadialOffset

The textRadialOffset property

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.

var textRadialOffset: Double?

textRotate

The textRotate property

Rotates the text clockwise.

var textRotate: Double?

textSize

The textSize property

Font size.

var textSize: Double?

textTransform

The textTransform property

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

var textTransform: TextTransform?