mapbox-maps-android/com.mapbox.maps.extension.style.layers.generated/SymbolLayer

SymbolLayer

@UiThread()

class SymbolLayer(layerId: String, sourceId: String) : Layer, SymbolLayerDsl

An icon or a text label.

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

SymbolLayer

androidJvm

fun SymbolLayer(layerId: String, sourceId: String)

the ID of the layer

Types

Companion

androidJvm

object Companion

Static variables and methods.

Functions

bindTo

androidJvm

fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)

Bind the layer to the map controller.

equals

androidJvm

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

filter

androidJvm

open override fun filter(filter: Expression): <ERROR CLASS>

Set the filter property

hashCode

androidJvm

open fun hashCode(): Int

iconAllowOverlap

androidJvm

open override fun iconAllowOverlap(iconAllowOverlap: Expression): <ERROR CLASS>

Set the IconAllowOverlap property

open override fun iconAllowOverlap(iconAllowOverlap: Boolean): <ERROR CLASS>

Set the IconAllowOverlap property

iconAnchor

androidJvm

open override fun iconAnchor(iconAnchor: Expression): <ERROR CLASS>

Set the IconAnchor property

open override fun iconAnchor(iconAnchor: IconAnchor): <ERROR CLASS>

Set the IconAnchor property

iconColor

androidJvm

open override fun iconColor(iconColor: Expression): <ERROR CLASS>

Set the IconColor property

open override fun iconColor(@ColorInt() iconColor: Int): <ERROR CLASS>

Set the IconColor property.

open override fun iconColor(iconColor: String): <ERROR CLASS>

Set the IconColor property

iconColorTransition

androidJvm

open override fun iconColorTransition(options: StyleTransition): <ERROR CLASS>

Set the IconColor property transition options

open override fun iconColorTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for iconColorTransition.

iconHaloBlur

androidJvm

open override fun iconHaloBlur(iconHaloBlur: Expression): <ERROR CLASS>

Set the IconHaloBlur property

open override fun iconHaloBlur(iconHaloBlur: Double): <ERROR CLASS>

Set the IconHaloBlur property

iconHaloBlurTransition

androidJvm

open override fun iconHaloBlurTransition(options: StyleTransition): <ERROR CLASS>

Set the IconHaloBlur property transition options

open override fun iconHaloBlurTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for iconHaloBlurTransition.

iconHaloColor

androidJvm

open override fun iconHaloColor(iconHaloColor: Expression): <ERROR CLASS>

Set the IconHaloColor property

open override fun iconHaloColor(@ColorInt() iconHaloColor: Int): <ERROR CLASS>

Set the IconHaloColor property.

open override fun iconHaloColor(iconHaloColor: String): <ERROR CLASS>

Set the IconHaloColor property

iconHaloColorTransition

androidJvm

open override fun iconHaloColorTransition(options: StyleTransition): <ERROR CLASS>

Set the IconHaloColor property transition options

open override fun iconHaloColorTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for iconHaloColorTransition.

iconHaloWidth

androidJvm

open override fun iconHaloWidth(iconHaloWidth: Expression): <ERROR CLASS>

Set the IconHaloWidth property

open override fun iconHaloWidth(iconHaloWidth: Double): <ERROR CLASS>

Set the IconHaloWidth property

iconHaloWidthTransition

androidJvm

open override fun iconHaloWidthTransition(options: StyleTransition): <ERROR CLASS>

Set the IconHaloWidth property transition options

open override fun iconHaloWidthTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for iconHaloWidthTransition.

iconIgnorePlacement

androidJvm

open override fun iconIgnorePlacement(iconIgnorePlacement: Expression): <ERROR CLASS>

Set the IconIgnorePlacement property

open override fun iconIgnorePlacement(iconIgnorePlacement: Boolean): <ERROR CLASS>

Set the IconIgnorePlacement property

iconImage

androidJvm

open override fun iconImage(iconImage: Expression): <ERROR CLASS>

Set the IconImage property

open override fun iconImage(iconImage: String): <ERROR CLASS>

Set the IconImage property

iconKeepUpright

androidJvm

open override fun iconKeepUpright(iconKeepUpright: Expression): <ERROR CLASS>

Set the IconKeepUpright property

open override fun iconKeepUpright(iconKeepUpright: Boolean): <ERROR CLASS>

Set the IconKeepUpright property

iconOffset

androidJvm

open override fun iconOffset(iconOffset: Expression): <ERROR CLASS>

Set the IconOffset property

open override fun iconOffset(iconOffset: List<Double>): <ERROR CLASS>

Set the IconOffset property

iconOpacity

androidJvm

open override fun iconOpacity(iconOpacity: Expression): <ERROR CLASS>

Set the IconOpacity property

open override fun iconOpacity(iconOpacity: Double): <ERROR CLASS>

Set the IconOpacity property

iconOpacityTransition

androidJvm

open override fun iconOpacityTransition(options: StyleTransition): <ERROR CLASS>

Set the IconOpacity property transition options

open override fun iconOpacityTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for iconOpacityTransition.

iconOptional

androidJvm

open override fun iconOptional(iconOptional: Expression): <ERROR CLASS>

Set the IconOptional property

open override fun iconOptional(iconOptional: Boolean): <ERROR CLASS>

Set the IconOptional property

iconPadding

androidJvm

open override fun iconPadding(iconPadding: Expression): <ERROR CLASS>

Set the IconPadding property

open override fun iconPadding(iconPadding: Double): <ERROR CLASS>

Set the IconPadding property

iconPitchAlignment

androidJvm

open override fun iconPitchAlignment(iconPitchAlignment: Expression): <ERROR CLASS>

Set the IconPitchAlignment property

open override fun iconPitchAlignment(iconPitchAlignment: IconPitchAlignment): <ERROR CLASS>

Set the IconPitchAlignment property

iconRotate

androidJvm

open override fun iconRotate(iconRotate: Expression): <ERROR CLASS>

Set the IconRotate property

open override fun iconRotate(iconRotate: Double): <ERROR CLASS>

Set the IconRotate property

iconRotationAlignment

androidJvm

open override fun iconRotationAlignment(iconRotationAlignment: Expression): <ERROR CLASS>

Set the IconRotationAlignment property

open override fun iconRotationAlignment(iconRotationAlignment: IconRotationAlignment): <ERROR CLASS>

Set the IconRotationAlignment property

iconSize

androidJvm

open override fun iconSize(iconSize: Expression): <ERROR CLASS>

Set the IconSize property

open override fun iconSize(iconSize: Double): <ERROR CLASS>

Set the IconSize property

iconTextFit

androidJvm

open override fun iconTextFit(iconTextFit: Expression): <ERROR CLASS>

Set the IconTextFit property

open override fun iconTextFit(iconTextFit: IconTextFit): <ERROR CLASS>

Set the IconTextFit property

iconTextFitPadding

androidJvm

open override fun iconTextFitPadding(iconTextFitPadding: Expression): <ERROR CLASS>

Set the IconTextFitPadding property

open override fun iconTextFitPadding(iconTextFitPadding: List<Double>): <ERROR CLASS>

Set the IconTextFitPadding property

iconTranslate

androidJvm

open override fun iconTranslate(iconTranslate: Expression): <ERROR CLASS>

Set the IconTranslate property

open override fun iconTranslate(iconTranslate: List<Double>): <ERROR CLASS>

Set the IconTranslate property

iconTranslateAnchor

androidJvm

open override fun iconTranslateAnchor(iconTranslateAnchor: Expression): <ERROR CLASS>

Set the IconTranslateAnchor property

open override fun iconTranslateAnchor(iconTranslateAnchor: IconTranslateAnchor): <ERROR CLASS>

Set the IconTranslateAnchor property

iconTranslateTransition

androidJvm

open override fun iconTranslateTransition(options: StyleTransition): <ERROR CLASS>

Set the IconTranslate property transition options

open override fun iconTranslateTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for iconTranslateTransition.

maxZoom

androidJvm

open override fun maxZoom(maxZoom: Double): <ERROR CLASS>

Set the maxzoom property

minZoom

androidJvm

open override fun minZoom(minZoom: Double): <ERROR CLASS>

Set the minzoom property

sourceLayer

androidJvm

open override fun sourceLayer(sourceLayer: String): <ERROR CLASS>

Set the sourceLayer property

symbolAvoidEdges

androidJvm

open override fun symbolAvoidEdges(symbolAvoidEdges: Expression): <ERROR CLASS>

Set the SymbolAvoidEdges property

open override fun symbolAvoidEdges(symbolAvoidEdges: Boolean): <ERROR CLASS>

Set the SymbolAvoidEdges property

symbolPlacement

androidJvm

open override fun symbolPlacement(symbolPlacement: Expression): <ERROR CLASS>

Set the SymbolPlacement property

open override fun symbolPlacement(symbolPlacement: SymbolPlacement): <ERROR CLASS>

Set the SymbolPlacement property

symbolSortKey

androidJvm

open override fun symbolSortKey(symbolSortKey: Expression): <ERROR CLASS>

Set the SymbolSortKey property

open override fun symbolSortKey(symbolSortKey: Double): <ERROR CLASS>

Set the SymbolSortKey property

symbolSpacing

androidJvm

open override fun symbolSpacing(symbolSpacing: Expression): <ERROR CLASS>

Set the SymbolSpacing property

open override fun symbolSpacing(symbolSpacing: Double): <ERROR CLASS>

Set the SymbolSpacing property

symbolZOrder

androidJvm

open override fun symbolZOrder(symbolZOrder: Expression): <ERROR CLASS>

Set the SymbolZOrder property

open override fun symbolZOrder(symbolZOrder: SymbolZOrder): <ERROR CLASS>

Set the SymbolZOrder property

textAllowOverlap

androidJvm

open override fun textAllowOverlap(textAllowOverlap: Expression): <ERROR CLASS>

Set the TextAllowOverlap property

open override fun textAllowOverlap(textAllowOverlap: Boolean): <ERROR CLASS>

Set the TextAllowOverlap property

textAnchor

androidJvm

open override fun textAnchor(textAnchor: Expression): <ERROR CLASS>

Set the TextAnchor property

open override fun textAnchor(textAnchor: TextAnchor): <ERROR CLASS>

Set the TextAnchor property

textColor

androidJvm

open override fun textColor(textColor: Expression): <ERROR CLASS>

Set the TextColor property

open override fun textColor(@ColorInt() textColor: Int): <ERROR CLASS>

Set the TextColor property.

open override fun textColor(textColor: String): <ERROR CLASS>

Set the TextColor property

textColorTransition

androidJvm

open override fun textColorTransition(options: StyleTransition): <ERROR CLASS>

Set the TextColor property transition options

open override fun textColorTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for textColorTransition.

textField

androidJvm

open override fun textField(textField: Expression): <ERROR CLASS>

Set the TextField property

open override fun textField(textField: Formatted): <ERROR CLASS>

Set the TextField property

open override fun textField(block: Formatted.() -> Unit): <ERROR CLASS>

DSL for construct Formatted textField.

open override fun textField(textField: String): <ERROR CLASS>

Set the TextField property as String.

textFont

androidJvm

open override fun textFont(textFont: Expression): <ERROR CLASS>

Set the TextFont property

open override fun textFont(textFont: List<String>): <ERROR CLASS>

Set the TextFont property

textHaloBlur

androidJvm

open override fun textHaloBlur(textHaloBlur: Expression): <ERROR CLASS>

Set the TextHaloBlur property

open override fun textHaloBlur(textHaloBlur: Double): <ERROR CLASS>

Set the TextHaloBlur property

textHaloBlurTransition

androidJvm

open override fun textHaloBlurTransition(options: StyleTransition): <ERROR CLASS>

Set the TextHaloBlur property transition options

open override fun textHaloBlurTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for textHaloBlurTransition.

textHaloColor

androidJvm

open override fun textHaloColor(textHaloColor: Expression): <ERROR CLASS>

Set the TextHaloColor property

open override fun textHaloColor(@ColorInt() textHaloColor: Int): <ERROR CLASS>

Set the TextHaloColor property.

open override fun textHaloColor(textHaloColor: String): <ERROR CLASS>

Set the TextHaloColor property

textHaloColorTransition

androidJvm

open override fun textHaloColorTransition(options: StyleTransition): <ERROR CLASS>

Set the TextHaloColor property transition options

open override fun textHaloColorTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for textHaloColorTransition.

textHaloWidth

androidJvm

open override fun textHaloWidth(textHaloWidth: Expression): <ERROR CLASS>

Set the TextHaloWidth property

open override fun textHaloWidth(textHaloWidth: Double): <ERROR CLASS>

Set the TextHaloWidth property

textHaloWidthTransition

androidJvm

open override fun textHaloWidthTransition(options: StyleTransition): <ERROR CLASS>

Set the TextHaloWidth property transition options

open override fun textHaloWidthTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for textHaloWidthTransition.

textIgnorePlacement

androidJvm

open override fun textIgnorePlacement(textIgnorePlacement: Expression): <ERROR CLASS>

Set the TextIgnorePlacement property

open override fun textIgnorePlacement(textIgnorePlacement: Boolean): <ERROR CLASS>

Set the TextIgnorePlacement property

textJustify

androidJvm

open override fun textJustify(textJustify: Expression): <ERROR CLASS>

Set the TextJustify property

open override fun textJustify(textJustify: TextJustify): <ERROR CLASS>

Set the TextJustify property

textKeepUpright

androidJvm

open override fun textKeepUpright(textKeepUpright: Expression): <ERROR CLASS>

Set the TextKeepUpright property

open override fun textKeepUpright(textKeepUpright: Boolean): <ERROR CLASS>

Set the TextKeepUpright property

textLetterSpacing

androidJvm

open override fun textLetterSpacing(textLetterSpacing: Expression): <ERROR CLASS>

Set the TextLetterSpacing property

open override fun textLetterSpacing(textLetterSpacing: Double): <ERROR CLASS>

Set the TextLetterSpacing property

textLineHeight

androidJvm

open override fun textLineHeight(textLineHeight: Expression): <ERROR CLASS>

Set the TextLineHeight property

open override fun textLineHeight(textLineHeight: Double): <ERROR CLASS>

Set the TextLineHeight property

textMaxAngle

androidJvm

open override fun textMaxAngle(textMaxAngle: Expression): <ERROR CLASS>

Set the TextMaxAngle property

open override fun textMaxAngle(textMaxAngle: Double): <ERROR CLASS>

Set the TextMaxAngle property

textMaxWidth

androidJvm

open override fun textMaxWidth(textMaxWidth: Expression): <ERROR CLASS>

Set the TextMaxWidth property

open override fun textMaxWidth(textMaxWidth: Double): <ERROR CLASS>

Set the TextMaxWidth property

textOffset

androidJvm

open override fun textOffset(textOffset: Expression): <ERROR CLASS>

Set the TextOffset property

open override fun textOffset(textOffset: List<Double>): <ERROR CLASS>

Set the TextOffset property

textOpacity

androidJvm

open override fun textOpacity(textOpacity: Expression): <ERROR CLASS>

Set the TextOpacity property

open override fun textOpacity(textOpacity: Double): <ERROR CLASS>

Set the TextOpacity property

textOpacityTransition

androidJvm

open override fun textOpacityTransition(options: StyleTransition): <ERROR CLASS>

Set the TextOpacity property transition options

open override fun textOpacityTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for textOpacityTransition.

textOptional

androidJvm

open override fun textOptional(textOptional: Expression): <ERROR CLASS>

Set the TextOptional property

open override fun textOptional(textOptional: Boolean): <ERROR CLASS>

Set the TextOptional property

textPadding

androidJvm

open override fun textPadding(textPadding: Expression): <ERROR CLASS>

Set the TextPadding property

open override fun textPadding(textPadding: Double): <ERROR CLASS>

Set the TextPadding property

textPitchAlignment

androidJvm

open override fun textPitchAlignment(textPitchAlignment: Expression): <ERROR CLASS>

Set the TextPitchAlignment property

open override fun textPitchAlignment(textPitchAlignment: TextPitchAlignment): <ERROR CLASS>

Set the TextPitchAlignment property

textRadialOffset

androidJvm

open override fun textRadialOffset(textRadialOffset: Expression): <ERROR CLASS>

Set the TextRadialOffset property

open override fun textRadialOffset(textRadialOffset: Double): <ERROR CLASS>

Set the TextRadialOffset property

textRotate

androidJvm

open override fun textRotate(textRotate: Expression): <ERROR CLASS>

Set the TextRotate property

open override fun textRotate(textRotate: Double): <ERROR CLASS>

Set the TextRotate property

textRotationAlignment

androidJvm

open override fun textRotationAlignment(textRotationAlignment: Expression): <ERROR CLASS>

Set the TextRotationAlignment property

open override fun textRotationAlignment(textRotationAlignment: TextRotationAlignment): <ERROR CLASS>

Set the TextRotationAlignment property

textSize

androidJvm

open override fun textSize(textSize: Expression): <ERROR CLASS>

Set the TextSize property

open override fun textSize(textSize: Double): <ERROR CLASS>

Set the TextSize property

textTransform

androidJvm

open override fun textTransform(textTransform: Expression): <ERROR CLASS>

Set the TextTransform property

open override fun textTransform(textTransform: TextTransform): <ERROR CLASS>

Set the TextTransform property

textTranslate

androidJvm

open override fun textTranslate(textTranslate: Expression): <ERROR CLASS>

Set the TextTranslate property

open override fun textTranslate(textTranslate: List<Double>): <ERROR CLASS>

Set the TextTranslate property

textTranslateAnchor

androidJvm

open override fun textTranslateAnchor(textTranslateAnchor: Expression): <ERROR CLASS>

Set the TextTranslateAnchor property

open override fun textTranslateAnchor(textTranslateAnchor: TextTranslateAnchor): <ERROR CLASS>

Set the TextTranslateAnchor property

textTranslateTransition

androidJvm

open override fun textTranslateTransition(options: StyleTransition): <ERROR CLASS>

Set the TextTranslate property transition options

open override fun textTranslateTransition(block: StyleTransition.Builder.() -> Unit): <ERROR CLASS>

DSL for textTranslateTransition.

textVariableAnchor

androidJvm

open override fun textVariableAnchor(textVariableAnchor: Expression): <ERROR CLASS>

Set the TextVariableAnchor property

open override fun textVariableAnchor(textVariableAnchor: List<String>): <ERROR CLASS>

Set the TextVariableAnchor property

textWritingMode

androidJvm

open override fun textWritingMode(textWritingMode: Expression): <ERROR CLASS>

Set the TextWritingMode property

open override fun textWritingMode(textWritingMode: List<String>): <ERROR CLASS>

Set the TextWritingMode property

toString

androidJvm

open fun toString(): String

visibility

androidJvm

open override fun visibility(visibility: Visibility): <ERROR CLASS>

Set the Visibility property

Properties

filter

androidJvm

val filter: Expression?

A expression specifying conditions on source features.

iconAllowOverlap

androidJvm

val iconAllowOverlap: Boolean?

If true, the icon will be visible even if it collides with other previously drawn symbols.

iconAllowOverlapAsExpression

androidJvm

val iconAllowOverlapAsExpression: Expression?

This is an Expression representation of "icon-allow-overlap".

iconAnchor

androidJvm

val iconAnchor: IconAnchor?

Part of the icon placed closest to the anchor.

iconAnchorAsExpression

androidJvm

val iconAnchorAsExpression: Expression?

This is an Expression representation of "icon-anchor".

iconColor

androidJvm

val iconColor: String?

The color of the icon.

iconColorAsColorInt

androidJvm

val iconColorAsColorInt: Int?

The color of the icon.

iconColorAsExpression

androidJvm

val iconColorAsExpression: Expression?

This is an Expression representation of "icon-color".

iconColorTransition

androidJvm

val iconColorTransition: StyleTransition?

Transition options for IconColor.

iconHaloBlur

androidJvm

val iconHaloBlur: Double?

Fade out the halo towards the outside.

iconHaloBlurAsExpression

androidJvm

val iconHaloBlurAsExpression: Expression?

This is an Expression representation of "icon-halo-blur".

iconHaloBlurTransition

androidJvm

val iconHaloBlurTransition: StyleTransition?

Transition options for IconHaloBlur.

iconHaloColor

androidJvm

val iconHaloColor: String?

The color of the icon's halo.

iconHaloColorAsColorInt

androidJvm

val iconHaloColorAsColorInt: Int?

The color of the icon's halo.

iconHaloColorAsExpression

androidJvm

val iconHaloColorAsExpression: Expression?

This is an Expression representation of "icon-halo-color".

iconHaloColorTransition

androidJvm

val iconHaloColorTransition: StyleTransition?

Transition options for IconHaloColor.

iconHaloWidth

androidJvm

val iconHaloWidth: Double?

Distance of halo to the icon outline.

iconHaloWidthAsExpression

androidJvm

val iconHaloWidthAsExpression: Expression?

This is an Expression representation of "icon-halo-width".

iconHaloWidthTransition

androidJvm

val iconHaloWidthTransition: StyleTransition?

Transition options for IconHaloWidth.

iconIgnorePlacement

androidJvm

val iconIgnorePlacement: Boolean?

If true, other symbols can be visible even if they collide with the icon.

iconIgnorePlacementAsExpression

androidJvm

val iconIgnorePlacementAsExpression: Expression?

This is an Expression representation of "icon-ignore-placement".

iconImage

androidJvm

val iconImage: String?

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

iconImageAsExpression

androidJvm

val iconImageAsExpression: Expression?

This is an Expression representation of "icon-image".

iconKeepUpright

androidJvm

val iconKeepUpright: Boolean?

If true, the icon may be flipped to prevent it from being rendered upside-down.

iconKeepUprightAsExpression

androidJvm

val iconKeepUprightAsExpression: Expression?

This is an Expression representation of "icon-keep-upright".

iconOffset

androidJvm

val iconOffset: List<Double>?

Offset distance of icon from its anchor.

iconOffsetAsExpression

androidJvm

val iconOffsetAsExpression: Expression?

This is an Expression representation of "icon-offset".

iconOpacity

androidJvm

val iconOpacity: Double?

The opacity at which the icon will be drawn.

iconOpacityAsExpression

androidJvm

val iconOpacityAsExpression: Expression?

This is an Expression representation of "icon-opacity".

iconOpacityTransition

androidJvm

val iconOpacityTransition: StyleTransition?

Transition options for IconOpacity.

iconOptional

androidJvm

val iconOptional: Boolean?

If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.

iconOptionalAsExpression

androidJvm

val iconOptionalAsExpression: Expression?

This is an Expression representation of "icon-optional".

iconPadding

androidJvm

val iconPadding: Double?

Size of the additional area around the icon bounding box used for detecting symbol collisions.

iconPaddingAsExpression

androidJvm

val iconPaddingAsExpression: Expression?

This is an Expression representation of "icon-padding".

iconPitchAlignment

androidJvm

val iconPitchAlignment: IconPitchAlignment?

Orientation of icon when map is pitched.

iconPitchAlignmentAsExpression

androidJvm

val iconPitchAlignmentAsExpression: Expression?

This is an Expression representation of "icon-pitch-alignment".

iconRotate

androidJvm

val iconRotate: Double?

Rotates the icon clockwise.

iconRotateAsExpression

androidJvm

val iconRotateAsExpression: Expression?

This is an Expression representation of "icon-rotate".

iconRotationAlignment

androidJvm

val iconRotationAlignment: IconRotationAlignment?

In combination with symbol-placement, determines the rotation behavior of icons.

iconRotationAlignmentAsExpression

androidJvm

val iconRotationAlignmentAsExpression: Expression?

This is an Expression representation of "icon-rotation-alignment".

iconSize

androidJvm

val iconSize: Double?

Scales the original size of the icon by the provided factor.

iconSizeAsExpression

androidJvm

val iconSizeAsExpression: Expression?

This is an Expression representation of "icon-size".

iconTextFit

androidJvm

val iconTextFit: IconTextFit?

Scales the icon to fit around the associated text.

iconTextFitAsExpression

androidJvm

val iconTextFitAsExpression: Expression?

This is an Expression representation of "icon-text-fit".

iconTextFitPadding

androidJvm

val iconTextFitPadding: List<Double>?

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

iconTextFitPaddingAsExpression

androidJvm

val iconTextFitPaddingAsExpression: Expression?

This is an Expression representation of "icon-text-fit-padding".

iconTranslate

androidJvm

val iconTranslate: List<Double>?

Distance that the icon's anchor is moved from its original placement.

iconTranslateAnchor

androidJvm

val iconTranslateAnchor: IconTranslateAnchor?

Controls the frame of reference for icon-translate.

iconTranslateAnchorAsExpression

androidJvm

val iconTranslateAnchorAsExpression: Expression?

This is an Expression representation of "icon-translate-anchor".

iconTranslateAsExpression

androidJvm

val iconTranslateAsExpression: Expression?

This is an Expression representation of "icon-translate".

iconTranslateTransition

androidJvm

val iconTranslateTransition: StyleTransition?

Transition options for IconTranslate.

layerId

androidJvm

open override val layerId: String

the ID of the layer

maxZoom

androidJvm

open override val maxZoom: Double?

The maximum zoom level for the layer.

minZoom

androidJvm

open override val minZoom: Double?

The minimum zoom level for the layer.

sourceId

androidJvm

val sourceId: String

the ID of the source

sourceLayer

androidJvm

val sourceLayer: String?

Source layer.

symbolAvoidEdges

androidJvm

val symbolAvoidEdges: Boolean?

If true, the symbols will not cross tile edges to avoid mutual collisions.

symbolAvoidEdgesAsExpression

androidJvm

val symbolAvoidEdgesAsExpression: Expression?

This is an Expression representation of "symbol-avoid-edges".

symbolPlacement

androidJvm

val symbolPlacement: SymbolPlacement?

Label placement relative to its geometry.

symbolPlacementAsExpression

androidJvm

val symbolPlacementAsExpression: Expression?

This is an Expression representation of "symbol-placement".

symbolSortKey

androidJvm

val symbolSortKey: Double?

Sorts features in ascending order based on this value.

symbolSortKeyAsExpression

androidJvm

val symbolSortKeyAsExpression: Expression?

This is an Expression representation of "symbol-sort-key".

symbolSpacing

androidJvm

val symbolSpacing: Double?

Distance between two symbol anchors.

symbolSpacingAsExpression

androidJvm

val symbolSpacingAsExpression: Expression?

This is an Expression representation of "symbol-spacing".

symbolZOrder

androidJvm

val symbolZOrder: SymbolZOrder?

Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport.

symbolZOrderAsExpression

androidJvm

val symbolZOrderAsExpression: Expression?

This is an Expression representation of "symbol-z-order".

textAllowOverlap

androidJvm

val textAllowOverlap: Boolean?

If true, the text will be visible even if it collides with other previously drawn symbols.

textAllowOverlapAsExpression

androidJvm

val textAllowOverlapAsExpression: Expression?

This is an Expression representation of "text-allow-overlap".

textAnchor

androidJvm

val textAnchor: TextAnchor?

Part of the text placed closest to the anchor.

textAnchorAsExpression

androidJvm

val textAnchorAsExpression: Expression?

This is an Expression representation of "text-anchor".

textColor

androidJvm

val textColor: String?

The color with which the text will be drawn.

textColorAsColorInt

androidJvm

val textColorAsColorInt: Int?

The color with which the text will be drawn.

textColorAsExpression

androidJvm

val textColorAsExpression: Expression?

This is an Expression representation of "text-color".

textColorTransition

androidJvm

val textColorTransition: StyleTransition?

Transition options for TextColor.

textField

androidJvm

val textField: Formatted?

Value to use for a text label.

textFieldAsExpression

androidJvm

val textFieldAsExpression: Expression?

This is an Expression representation of "text-field".

textFieldAsString

androidJvm

val textFieldAsString: String?

Value to use for a text label.

textFont

androidJvm

val textFont: List<String>?

Font stack to use for displaying text.

textFontAsExpression

androidJvm

val textFontAsExpression: Expression?

This is an Expression representation of "text-font".

textHaloBlur

androidJvm

val textHaloBlur: Double?

The halo's fadeout distance towards the outside.

textHaloBlurAsExpression

androidJvm

val textHaloBlurAsExpression: Expression?

This is an Expression representation of "text-halo-blur".

textHaloBlurTransition

androidJvm

val textHaloBlurTransition: StyleTransition?

Transition options for TextHaloBlur.

textHaloColor

androidJvm

val textHaloColor: String?

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

textHaloColorAsColorInt

androidJvm

val textHaloColorAsColorInt: Int?

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

textHaloColorAsExpression

androidJvm

val textHaloColorAsExpression: Expression?

This is an Expression representation of "text-halo-color".

textHaloColorTransition

androidJvm

val textHaloColorTransition: StyleTransition?

Transition options for TextHaloColor.

textHaloWidth

androidJvm

val textHaloWidth: Double?

Distance of halo to the font outline.

textHaloWidthAsExpression

androidJvm

val textHaloWidthAsExpression: Expression?

This is an Expression representation of "text-halo-width".

textHaloWidthTransition

androidJvm

val textHaloWidthTransition: StyleTransition?

Transition options for TextHaloWidth.

textIgnorePlacement

androidJvm

val textIgnorePlacement: Boolean?

If true, other symbols can be visible even if they collide with the text.

textIgnorePlacementAsExpression

androidJvm

val textIgnorePlacementAsExpression: Expression?

This is an Expression representation of "text-ignore-placement".

textJustify

androidJvm

val textJustify: TextJustify?

Text justification options.

textJustifyAsExpression

androidJvm

val textJustifyAsExpression: Expression?

This is an Expression representation of "text-justify".

textKeepUpright

androidJvm

val textKeepUpright: Boolean?

If true, the text may be flipped vertically to prevent it from being rendered upside-down.

textKeepUprightAsExpression

androidJvm

val textKeepUprightAsExpression: Expression?

This is an Expression representation of "text-keep-upright".

textLetterSpacing

androidJvm

val textLetterSpacing: Double?

Text tracking amount.

textLetterSpacingAsExpression

androidJvm

val textLetterSpacingAsExpression: Expression?

This is an Expression representation of "text-letter-spacing".

textLineHeight

androidJvm

val textLineHeight: Double?

Text leading value for multi-line text.

textLineHeightAsExpression

androidJvm

val textLineHeightAsExpression: Expression?

This is an Expression representation of "text-line-height".

textMaxAngle

androidJvm

val textMaxAngle: Double?

Maximum angle change between adjacent characters.

textMaxAngleAsExpression

androidJvm

val textMaxAngleAsExpression: Expression?

This is an Expression representation of "text-max-angle".

textMaxWidth

androidJvm

val textMaxWidth: Double?

The maximum line width for text wrapping.

textMaxWidthAsExpression

androidJvm

val textMaxWidthAsExpression: Expression?

This is an Expression representation of "text-max-width".

textOffset

androidJvm

val textOffset: List<Double>?

Offset distance of text from its anchor.

textOffsetAsExpression

androidJvm

val textOffsetAsExpression: Expression?

This is an Expression representation of "text-offset".

textOpacity

androidJvm

val textOpacity: Double?

The opacity at which the text will be drawn.

textOpacityAsExpression

androidJvm

val textOpacityAsExpression: Expression?

This is an Expression representation of "text-opacity".

textOpacityTransition

androidJvm

val textOpacityTransition: StyleTransition?

Transition options for TextOpacity.

textOptional

androidJvm

val textOptional: Boolean?

If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.

textOptionalAsExpression

androidJvm

val textOptionalAsExpression: Expression?

This is an Expression representation of "text-optional".

textPadding

androidJvm

val textPadding: Double?

Size of the additional area around the text bounding box used for detecting symbol collisions.

textPaddingAsExpression

androidJvm

val textPaddingAsExpression: Expression?

This is an Expression representation of "text-padding".

textPitchAlignment

androidJvm

val textPitchAlignment: TextPitchAlignment?

Orientation of text when map is pitched.

textPitchAlignmentAsExpression

androidJvm

val textPitchAlignmentAsExpression: Expression?

This is an Expression representation of "text-pitch-alignment".

textRadialOffset

androidJvm

val textRadialOffset: Double?

Radial offset of text, in the direction of the symbol's anchor.

textRadialOffsetAsExpression

androidJvm

val textRadialOffsetAsExpression: Expression?

This is an Expression representation of "text-radial-offset".

textRotate

androidJvm

val textRotate: Double?

Rotates the text clockwise.

textRotateAsExpression

androidJvm

val textRotateAsExpression: Expression?

This is an Expression representation of "text-rotate".

textRotationAlignment

androidJvm

val textRotationAlignment: TextRotationAlignment?

In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text.

textRotationAlignmentAsExpression

androidJvm

val textRotationAlignmentAsExpression: Expression?

This is an Expression representation of "text-rotation-alignment".

textSize

androidJvm

val textSize: Double?

Font size.

textSizeAsExpression

androidJvm

val textSizeAsExpression: Expression?

This is an Expression representation of "text-size".

textTransform

androidJvm

val textTransform: TextTransform?

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

textTransformAsExpression

androidJvm

val textTransformAsExpression: Expression?

This is an Expression representation of "text-transform".

textTranslate

androidJvm

val textTranslate: List<Double>?

Distance that the text's anchor is moved from its original placement.

textTranslateAnchor

androidJvm

val textTranslateAnchor: TextTranslateAnchor?

Controls the frame of reference for text-translate.

textTranslateAnchorAsExpression

androidJvm

val textTranslateAnchorAsExpression: Expression?

This is an Expression representation of "text-translate-anchor".

textTranslateAsExpression

androidJvm

val textTranslateAsExpression: Expression?

This is an Expression representation of "text-translate".

textTranslateTransition

androidJvm

val textTranslateTransition: StyleTransition?

Transition options for TextTranslate.

textVariableAnchor

androidJvm

val textVariableAnchor: List<String>?

To increase the chance of placing high-priority labels on the map, you can provide an array of text-anchor locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label.

textVariableAnchorAsExpression

androidJvm

val textVariableAnchorAsExpression: Expression?

This is an Expression representation of "text-variable-anchor".

textWritingMode

androidJvm

val textWritingMode: List<String>?

The property allows control over a symbol's orientation.

textWritingModeAsExpression

androidJvm

val textWritingModeAsExpression: Expression?

This is an Expression representation of "text-writing-mode".

visibility

androidJvm

open override val visibility: Visibility?

Visibility of the layer.

SymbolLayer

See also

Parameters

Constructors

Types

Functions

Properties