SymbolLayer

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

An icon or a text label.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

SymbolLayer
Link copied to clipboard
fun SymbolLayer(layerId: String, sourceId: String)
the ID of the layer

Types

Companion
Link copied to clipboard
object Companion
Static variables and methods.

Functions

bindTo
Link copied to clipboard
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
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
filter
Link copied to clipboard
open override fun filter(filter: Expression): SymbolLayer
Set the filter property
hashCode
Link copied to clipboard
open fun hashCode(): Int
iconAllowOverlap
Link copied to clipboard
open override fun iconAllowOverlap(iconAllowOverlap: Expression): SymbolLayer
Set the IconAllowOverlap property
open override fun iconAllowOverlap(iconAllowOverlap: Boolean): SymbolLayer
Set the IconAllowOverlap property
iconAnchor
Link copied to clipboard
open override fun iconAnchor(iconAnchor: Expression): SymbolLayer
Set the IconAnchor property
open override fun iconAnchor(iconAnchor: IconAnchor): SymbolLayer
Set the IconAnchor property
iconColor
Link copied to clipboard
open override fun iconColor(iconColor: Expression): SymbolLayer
Set the IconColor property
open override fun iconColor(@ColorInt() iconColor: Int): SymbolLayer
Set the IconColor property.
open override fun iconColor(iconColor: String): SymbolLayer
Set the IconColor property
iconColorTransition
Link copied to clipboard
open override fun iconColorTransition(options: StyleTransition): SymbolLayer
Set the IconColor property transition options
open override fun iconColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconHaloBlur
Link copied to clipboard
open override fun iconHaloBlur(iconHaloBlur: Expression): SymbolLayer
Set the IconHaloBlur property
open override fun iconHaloBlur(iconHaloBlur: Double): SymbolLayer
Set the IconHaloBlur property
iconHaloBlurTransition
Link copied to clipboard
open override fun iconHaloBlurTransition(options: StyleTransition): SymbolLayer
Set the IconHaloBlur property transition options
open override fun iconHaloBlurTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconHaloColor
Link copied to clipboard
open override fun iconHaloColor(iconHaloColor: Expression): SymbolLayer
Set the IconHaloColor property
open override fun iconHaloColor(@ColorInt() iconHaloColor: Int): SymbolLayer
Set the IconHaloColor property.
open override fun iconHaloColor(iconHaloColor: String): SymbolLayer
Set the IconHaloColor property
iconHaloColorTransition
Link copied to clipboard
open override fun iconHaloColorTransition(options: StyleTransition): SymbolLayer
Set the IconHaloColor property transition options
open override fun iconHaloColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconHaloWidth
Link copied to clipboard
open override fun iconHaloWidth(iconHaloWidth: Expression): SymbolLayer
Set the IconHaloWidth property
open override fun iconHaloWidth(iconHaloWidth: Double): SymbolLayer
Set the IconHaloWidth property
iconHaloWidthTransition
Link copied to clipboard
open override fun iconHaloWidthTransition(options: StyleTransition): SymbolLayer
Set the IconHaloWidth property transition options
open override fun iconHaloWidthTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconIgnorePlacement
Link copied to clipboard
open override fun iconIgnorePlacement(iconIgnorePlacement: Expression): SymbolLayer
Set the IconIgnorePlacement property
open override fun iconIgnorePlacement(iconIgnorePlacement: Boolean): SymbolLayer
Set the IconIgnorePlacement property
iconImage
Link copied to clipboard
open override fun iconImage(iconImage: Expression): SymbolLayer
Set the IconImage property
open override fun iconImage(iconImage: String): SymbolLayer
Set the IconImage property
iconKeepUpright
Link copied to clipboard
open override fun iconKeepUpright(iconKeepUpright: Expression): SymbolLayer
Set the IconKeepUpright property
open override fun iconKeepUpright(iconKeepUpright: Boolean): SymbolLayer
Set the IconKeepUpright property
iconOffset
Link copied to clipboard
open override fun iconOffset(iconOffset: Expression): SymbolLayer
Set the IconOffset property
open override fun iconOffset(iconOffset: List<Double>): SymbolLayer
Set the IconOffset property
iconOpacity
Link copied to clipboard
open override fun iconOpacity(iconOpacity: Expression): SymbolLayer
Set the IconOpacity property
open override fun iconOpacity(iconOpacity: Double): SymbolLayer
Set the IconOpacity property
iconOpacityTransition
Link copied to clipboard
open override fun iconOpacityTransition(options: StyleTransition): SymbolLayer
Set the IconOpacity property transition options
open override fun iconOpacityTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconOptional
Link copied to clipboard
open override fun iconOptional(iconOptional: Expression): SymbolLayer
Set the IconOptional property
open override fun iconOptional(iconOptional: Boolean): SymbolLayer
Set the IconOptional property
iconPadding
Link copied to clipboard
open override fun iconPadding(iconPadding: Expression): SymbolLayer
Set the IconPadding property
open override fun iconPadding(iconPadding: Double): SymbolLayer
Set the IconPadding property
iconPitchAlignment
Link copied to clipboard
open override fun iconPitchAlignment(iconPitchAlignment: Expression): SymbolLayer
Set the IconPitchAlignment property
open override fun iconPitchAlignment(iconPitchAlignment: IconPitchAlignment): SymbolLayer
Set the IconPitchAlignment property
iconRotate
Link copied to clipboard
open override fun iconRotate(iconRotate: Expression): SymbolLayer
Set the IconRotate property
open override fun iconRotate(iconRotate: Double): SymbolLayer
Set the IconRotate property
iconRotationAlignment
Link copied to clipboard
open override fun iconRotationAlignment(iconRotationAlignment: Expression): SymbolLayer
Set the IconRotationAlignment property
open override fun iconRotationAlignment(iconRotationAlignment: IconRotationAlignment): SymbolLayer
Set the IconRotationAlignment property
iconSize
Link copied to clipboard
open override fun iconSize(iconSize: Expression): SymbolLayer
Set the IconSize property
open override fun iconSize(iconSize: Double): SymbolLayer
Set the IconSize property
iconTextFit
Link copied to clipboard
open override fun iconTextFit(iconTextFit: Expression): SymbolLayer
Set the IconTextFit property
open override fun iconTextFit(iconTextFit: IconTextFit): SymbolLayer
Set the IconTextFit property
iconTextFitPadding
Link copied to clipboard
open override fun iconTextFitPadding(iconTextFitPadding: Expression): SymbolLayer
Set the IconTextFitPadding property
open override fun iconTextFitPadding(iconTextFitPadding: List<Double>): SymbolLayer
Set the IconTextFitPadding property
iconTranslate
Link copied to clipboard
open override fun iconTranslate(iconTranslate: Expression): SymbolLayer
Set the IconTranslate property
open override fun iconTranslate(iconTranslate: List<Double>): SymbolLayer
Set the IconTranslate property
iconTranslateAnchor
Link copied to clipboard
open override fun iconTranslateAnchor(iconTranslateAnchor: Expression): SymbolLayer
Set the IconTranslateAnchor property
open override fun iconTranslateAnchor(iconTranslateAnchor: IconTranslateAnchor): SymbolLayer
Set the IconTranslateAnchor property
iconTranslateTransition
Link copied to clipboard
open override fun iconTranslateTransition(options: StyleTransition): SymbolLayer
Set the IconTranslate property transition options
open override fun iconTranslateTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): SymbolLayer
Set the maxzoom property
minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): SymbolLayer
Set the minzoom property
sourceLayer
Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): SymbolLayer
Set the sourceLayer property
symbolAvoidEdges
Link copied to clipboard
open override fun symbolAvoidEdges(symbolAvoidEdges: Expression): SymbolLayer
Set the SymbolAvoidEdges property
open override fun symbolAvoidEdges(symbolAvoidEdges: Boolean): SymbolLayer
Set the SymbolAvoidEdges property
symbolPlacement
Link copied to clipboard
open override fun symbolPlacement(symbolPlacement: Expression): SymbolLayer
Set the SymbolPlacement property
open override fun symbolPlacement(symbolPlacement: SymbolPlacement): SymbolLayer
Set the SymbolPlacement property
symbolSortKey
Link copied to clipboard
open override fun symbolSortKey(symbolSortKey: Expression): SymbolLayer
Set the SymbolSortKey property
open override fun symbolSortKey(symbolSortKey: Double): SymbolLayer
Set the SymbolSortKey property
symbolSpacing
Link copied to clipboard
open override fun symbolSpacing(symbolSpacing: Expression): SymbolLayer
Set the SymbolSpacing property
open override fun symbolSpacing(symbolSpacing: Double): SymbolLayer
Set the SymbolSpacing property
symbolZOrder
Link copied to clipboard
open override fun symbolZOrder(symbolZOrder: Expression): SymbolLayer
Set the SymbolZOrder property
open override fun symbolZOrder(symbolZOrder: SymbolZOrder): SymbolLayer
Set the SymbolZOrder property
textAllowOverlap
Link copied to clipboard
open override fun textAllowOverlap(textAllowOverlap: Expression): SymbolLayer
Set the TextAllowOverlap property
open override fun textAllowOverlap(textAllowOverlap: Boolean): SymbolLayer
Set the TextAllowOverlap property
textAnchor
Link copied to clipboard
open override fun textAnchor(textAnchor: Expression): SymbolLayer
Set the TextAnchor property
open override fun textAnchor(textAnchor: TextAnchor): SymbolLayer
Set the TextAnchor property
textColor
Link copied to clipboard
open override fun textColor(textColor: Expression): SymbolLayer
Set the TextColor property
open override fun textColor(@ColorInt() textColor: Int): SymbolLayer
Set the TextColor property.
open override fun textColor(textColor: String): SymbolLayer
Set the TextColor property
textColorTransition
Link copied to clipboard
open override fun textColorTransition(options: StyleTransition): SymbolLayer
Set the TextColor property transition options
open override fun textColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textField
Link copied to clipboard
open override fun textField(textField: Expression): SymbolLayer
Set the TextField property
open override fun textField(textField: Formatted): SymbolLayer
Set the TextField property
open override fun textField(block: Formatted.() -> Unit): SymbolLayer
DSL for construct Formatted textField.
open override fun textField(textField: String): SymbolLayer
Set the TextField property as String.
textFont
Link copied to clipboard
open override fun textFont(textFont: Expression): SymbolLayer
Set the TextFont property
open override fun textFont(textFont: List<String>): SymbolLayer
Set the TextFont property
textHaloBlur
Link copied to clipboard
open override fun textHaloBlur(textHaloBlur: Expression): SymbolLayer
Set the TextHaloBlur property
open override fun textHaloBlur(textHaloBlur: Double): SymbolLayer
Set the TextHaloBlur property
textHaloBlurTransition
Link copied to clipboard
open override fun textHaloBlurTransition(options: StyleTransition): SymbolLayer
Set the TextHaloBlur property transition options
open override fun textHaloBlurTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textHaloColor
Link copied to clipboard
open override fun textHaloColor(textHaloColor: Expression): SymbolLayer
Set the TextHaloColor property
open override fun textHaloColor(@ColorInt() textHaloColor: Int): SymbolLayer
Set the TextHaloColor property.
open override fun textHaloColor(textHaloColor: String): SymbolLayer
Set the TextHaloColor property
textHaloColorTransition
Link copied to clipboard
open override fun textHaloColorTransition(options: StyleTransition): SymbolLayer
Set the TextHaloColor property transition options
open override fun textHaloColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textHaloWidth
Link copied to clipboard
open override fun textHaloWidth(textHaloWidth: Expression): SymbolLayer
Set the TextHaloWidth property
open override fun textHaloWidth(textHaloWidth: Double): SymbolLayer
Set the TextHaloWidth property
textHaloWidthTransition
Link copied to clipboard
open override fun textHaloWidthTransition(options: StyleTransition): SymbolLayer
Set the TextHaloWidth property transition options
open override fun textHaloWidthTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textIgnorePlacement
Link copied to clipboard
open override fun textIgnorePlacement(textIgnorePlacement: Expression): SymbolLayer
Set the TextIgnorePlacement property
open override fun textIgnorePlacement(textIgnorePlacement: Boolean): SymbolLayer
Set the TextIgnorePlacement property
textJustify
Link copied to clipboard
open override fun textJustify(textJustify: Expression): SymbolLayer
Set the TextJustify property
open override fun textJustify(textJustify: TextJustify): SymbolLayer
Set the TextJustify property
textKeepUpright
Link copied to clipboard
open override fun textKeepUpright(textKeepUpright: Expression): SymbolLayer
Set the TextKeepUpright property
open override fun textKeepUpright(textKeepUpright: Boolean): SymbolLayer
Set the TextKeepUpright property
textLetterSpacing
Link copied to clipboard
open override fun textLetterSpacing(textLetterSpacing: Expression): SymbolLayer
Set the TextLetterSpacing property
open override fun textLetterSpacing(textLetterSpacing: Double): SymbolLayer
Set the TextLetterSpacing property
textLineHeight
Link copied to clipboard
open override fun textLineHeight(textLineHeight: Expression): SymbolLayer
Set the TextLineHeight property
open override fun textLineHeight(textLineHeight: Double): SymbolLayer
Set the TextLineHeight property
textMaxAngle
Link copied to clipboard
open override fun textMaxAngle(textMaxAngle: Expression): SymbolLayer
Set the TextMaxAngle property
open override fun textMaxAngle(textMaxAngle: Double): SymbolLayer
Set the TextMaxAngle property
textMaxWidth
Link copied to clipboard
open override fun textMaxWidth(textMaxWidth: Expression): SymbolLayer
Set the TextMaxWidth property
open override fun textMaxWidth(textMaxWidth: Double): SymbolLayer
Set the TextMaxWidth property
textOffset
Link copied to clipboard
open override fun textOffset(textOffset: Expression): SymbolLayer
Set the TextOffset property
open override fun textOffset(textOffset: List<Double>): SymbolLayer
Set the TextOffset property
textOpacity
Link copied to clipboard
open override fun textOpacity(textOpacity: Expression): SymbolLayer
Set the TextOpacity property
open override fun textOpacity(textOpacity: Double): SymbolLayer
Set the TextOpacity property
textOpacityTransition
Link copied to clipboard
open override fun textOpacityTransition(options: StyleTransition): SymbolLayer
Set the TextOpacity property transition options
open override fun textOpacityTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textOptional
Link copied to clipboard
open override fun textOptional(textOptional: Expression): SymbolLayer
Set the TextOptional property
open override fun textOptional(textOptional: Boolean): SymbolLayer
Set the TextOptional property
textPadding
Link copied to clipboard
open override fun textPadding(textPadding: Expression): SymbolLayer
Set the TextPadding property
open override fun textPadding(textPadding: Double): SymbolLayer
Set the TextPadding property
textPitchAlignment
Link copied to clipboard
open override fun textPitchAlignment(textPitchAlignment: Expression): SymbolLayer
Set the TextPitchAlignment property
open override fun textPitchAlignment(textPitchAlignment: TextPitchAlignment): SymbolLayer
Set the TextPitchAlignment property
textRadialOffset
Link copied to clipboard
open override fun textRadialOffset(textRadialOffset: Expression): SymbolLayer
Set the TextRadialOffset property
open override fun textRadialOffset(textRadialOffset: Double): SymbolLayer
Set the TextRadialOffset property
textRotate
Link copied to clipboard
open override fun textRotate(textRotate: Expression): SymbolLayer
Set the TextRotate property
open override fun textRotate(textRotate: Double): SymbolLayer
Set the TextRotate property
textRotationAlignment
Link copied to clipboard
open override fun textRotationAlignment(textRotationAlignment: Expression): SymbolLayer
Set the TextRotationAlignment property
open override fun textRotationAlignment(textRotationAlignment: TextRotationAlignment): SymbolLayer
Set the TextRotationAlignment property
textSize
Link copied to clipboard
open override fun textSize(textSize: Expression): SymbolLayer
Set the TextSize property
open override fun textSize(textSize: Double): SymbolLayer
Set the TextSize property
textTransform
Link copied to clipboard
open override fun textTransform(textTransform: Expression): SymbolLayer
Set the TextTransform property
open override fun textTransform(textTransform: TextTransform): SymbolLayer
Set the TextTransform property
textTranslate
Link copied to clipboard
open override fun textTranslate(textTranslate: Expression): SymbolLayer
Set the TextTranslate property
open override fun textTranslate(textTranslate: List<Double>): SymbolLayer
Set the TextTranslate property
textTranslateAnchor
Link copied to clipboard
open override fun textTranslateAnchor(textTranslateAnchor: Expression): SymbolLayer
Set the TextTranslateAnchor property
open override fun textTranslateAnchor(textTranslateAnchor: TextTranslateAnchor): SymbolLayer
Set the TextTranslateAnchor property
textTranslateTransition
Link copied to clipboard
open override fun textTranslateTransition(options: StyleTransition): SymbolLayer
Set the TextTranslate property transition options
open override fun textTranslateTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textVariableAnchor
Link copied to clipboard
open override fun textVariableAnchor(textVariableAnchor: Expression): SymbolLayer
Set the TextVariableAnchor property
open override fun textVariableAnchor(textVariableAnchor: List<String>): SymbolLayer
Set the TextVariableAnchor property
textWritingMode
Link copied to clipboard
open override fun textWritingMode(textWritingMode: Expression): SymbolLayer
Set the TextWritingMode property
open override fun textWritingMode(textWritingMode: List<String>): SymbolLayer
Set the TextWritingMode property
toString
Link copied to clipboard
open fun toString(): String
visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): SymbolLayer
Set the Visibility property

Properties

filter
Link copied to clipboard
val filter: Expression?
A expression specifying conditions on source features.
iconAllowOverlap
Link copied to clipboard
val iconAllowOverlap: Boolean?
If true, the icon will be visible even if it collides with other previously drawn symbols.
iconAllowOverlapAsExpression
Link copied to clipboard
val iconAllowOverlapAsExpression: Expression?
This is an Expression representation of "icon-allow-overlap".
iconAnchor
Link copied to clipboard
val iconAnchor: IconAnchor?
Part of the icon placed closest to the anchor.
iconAnchorAsExpression
Link copied to clipboard
val iconAnchorAsExpression: Expression?
This is an Expression representation of "icon-anchor".
iconColor
Link copied to clipboard
val iconColor: String?
The color of the icon.
iconColorAsColorInt
Link copied to clipboard
val iconColorAsColorInt: Int?
The color of the icon.
iconColorAsExpression
Link copied to clipboard
val iconColorAsExpression: Expression?
This is an Expression representation of "icon-color".
iconColorTransition
Link copied to clipboard
val iconColorTransition: StyleTransition?
Transition options for IconColor.
iconHaloBlur
Link copied to clipboard
val iconHaloBlur: Double?
Fade out the halo towards the outside.
iconHaloBlurAsExpression
Link copied to clipboard
val iconHaloBlurAsExpression: Expression?
This is an Expression representation of "icon-halo-blur".
iconHaloBlurTransition
Link copied to clipboard
val iconHaloBlurTransition: StyleTransition?
Transition options for IconHaloBlur.
iconHaloColor
Link copied to clipboard
val iconHaloColor: String?
The color of the icon's halo.
iconHaloColorAsColorInt
Link copied to clipboard
val iconHaloColorAsColorInt: Int?
The color of the icon's halo.
iconHaloColorAsExpression
Link copied to clipboard
val iconHaloColorAsExpression: Expression?
This is an Expression representation of "icon-halo-color".
iconHaloColorTransition
Link copied to clipboard
val iconHaloColorTransition: StyleTransition?
Transition options for IconHaloColor.
iconHaloWidth
Link copied to clipboard
val iconHaloWidth: Double?
Distance of halo to the icon outline.
iconHaloWidthAsExpression
Link copied to clipboard
val iconHaloWidthAsExpression: Expression?
This is an Expression representation of "icon-halo-width".
iconHaloWidthTransition
Link copied to clipboard
val iconHaloWidthTransition: StyleTransition?
Transition options for IconHaloWidth.
iconIgnorePlacement
Link copied to clipboard
val iconIgnorePlacement: Boolean?
If true, other symbols can be visible even if they collide with the icon.
iconIgnorePlacementAsExpression
Link copied to clipboard
val iconIgnorePlacementAsExpression: Expression?
This is an Expression representation of "icon-ignore-placement".
iconImage
Link copied to clipboard
val iconImage: String?
Name of image in sprite to use for drawing an image background.
iconImageAsExpression
Link copied to clipboard
val iconImageAsExpression: Expression?
This is an Expression representation of "icon-image".
iconKeepUpright
Link copied to clipboard
val iconKeepUpright: Boolean?
If true, the icon may be flipped to prevent it from being rendered upside-down.
iconKeepUprightAsExpression
Link copied to clipboard
val iconKeepUprightAsExpression: Expression?
This is an Expression representation of "icon-keep-upright".
iconOffset
Link copied to clipboard
val iconOffset: List<Double>?
Offset distance of icon from its anchor.
iconOffsetAsExpression
Link copied to clipboard
val iconOffsetAsExpression: Expression?
This is an Expression representation of "icon-offset".
iconOpacity
Link copied to clipboard
val iconOpacity: Double?
The opacity at which the icon will be drawn.
iconOpacityAsExpression
Link copied to clipboard
val iconOpacityAsExpression: Expression?
This is an Expression representation of "icon-opacity".
iconOpacityTransition
Link copied to clipboard
val iconOpacityTransition: StyleTransition?
Transition options for IconOpacity.
iconOptional
Link copied to clipboard
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
Link copied to clipboard
val iconOptionalAsExpression: Expression?
This is an Expression representation of "icon-optional".
iconPadding
Link copied to clipboard
val iconPadding: Double?
Size of the additional area around the icon bounding box used for detecting symbol collisions.
iconPaddingAsExpression
Link copied to clipboard
val iconPaddingAsExpression: Expression?
This is an Expression representation of "icon-padding".
iconPitchAlignment
Link copied to clipboard
val iconPitchAlignment: IconPitchAlignment?
Orientation of icon when map is pitched.
iconPitchAlignmentAsExpression
Link copied to clipboard
val iconPitchAlignmentAsExpression: Expression?
This is an Expression representation of "icon-pitch-alignment".
iconRotate
Link copied to clipboard
val iconRotate: Double?
Rotates the icon clockwise.
iconRotateAsExpression
Link copied to clipboard
val iconRotateAsExpression: Expression?
This is an Expression representation of "icon-rotate".
iconRotationAlignment
Link copied to clipboard
val iconRotationAlignment: IconRotationAlignment?
In combination with symbol-placement, determines the rotation behavior of icons.
iconRotationAlignmentAsExpression
Link copied to clipboard
val iconRotationAlignmentAsExpression: Expression?
This is an Expression representation of "icon-rotation-alignment".
iconSize
Link copied to clipboard
val iconSize: Double?
Scales the original size of the icon by the provided factor.
iconSizeAsExpression
Link copied to clipboard
val iconSizeAsExpression: Expression?
This is an Expression representation of "icon-size".
iconTextFit
Link copied to clipboard
val iconTextFit: IconTextFit?
Scales the icon to fit around the associated text.
iconTextFitAsExpression
Link copied to clipboard
val iconTextFitAsExpression: Expression?
This is an Expression representation of "icon-text-fit".
iconTextFitPadding
Link copied to clipboard
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
Link copied to clipboard
val iconTextFitPaddingAsExpression: Expression?
This is an Expression representation of "icon-text-fit-padding".
iconTranslate
Link copied to clipboard
val iconTranslate: List<Double>?
Distance that the icon's anchor is moved from its original placement.
iconTranslateAnchor
Link copied to clipboard
val iconTranslateAnchor: IconTranslateAnchor?
Controls the frame of reference for icon-translate.
iconTranslateAnchorAsExpression
Link copied to clipboard
val iconTranslateAnchorAsExpression: Expression?
This is an Expression representation of "icon-translate-anchor".
iconTranslateAsExpression
Link copied to clipboard
val iconTranslateAsExpression: Expression?
This is an Expression representation of "icon-translate".
iconTranslateTransition
Link copied to clipboard
val iconTranslateTransition: StyleTransition?
Transition options for IconTranslate.
layerId
Link copied to clipboard
open override val layerId: String
the ID of the layer
maxZoom
Link copied to clipboard
open override val maxZoom: Double?
The maximum zoom level for the layer.
minZoom
Link copied to clipboard
open override val minZoom: Double?
The minimum zoom level for the layer.
sourceId
Link copied to clipboard
val sourceId: String
the ID of the source
sourceLayer
Link copied to clipboard
val sourceLayer: String?
Source layer.
symbolAvoidEdges
Link copied to clipboard
val symbolAvoidEdges: Boolean?
If true, the symbols will not cross tile edges to avoid mutual collisions.
symbolAvoidEdgesAsExpression
Link copied to clipboard
val symbolAvoidEdgesAsExpression: Expression?
This is an Expression representation of "symbol-avoid-edges".
symbolPlacement
Link copied to clipboard
val symbolPlacement: SymbolPlacement?
Label placement relative to its geometry.
symbolPlacementAsExpression
Link copied to clipboard
val symbolPlacementAsExpression: Expression?
This is an Expression representation of "symbol-placement".
symbolSortKey
Link copied to clipboard
val symbolSortKey: Double?
Sorts features in ascending order based on this value.
symbolSortKeyAsExpression
Link copied to clipboard
val symbolSortKeyAsExpression: Expression?
This is an Expression representation of "symbol-sort-key".
symbolSpacing
Link copied to clipboard
val symbolSpacing: Double?
Distance between two symbol anchors.
symbolSpacingAsExpression
Link copied to clipboard
val symbolSpacingAsExpression: Expression?
This is an Expression representation of "symbol-spacing".
symbolZOrder
Link copied to clipboard
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
Link copied to clipboard
val symbolZOrderAsExpression: Expression?
This is an Expression representation of "symbol-z-order".
textAllowOverlap
Link copied to clipboard
val textAllowOverlap: Boolean?
If true, the text will be visible even if it collides with other previously drawn symbols.
textAllowOverlapAsExpression
Link copied to clipboard
val textAllowOverlapAsExpression: Expression?
This is an Expression representation of "text-allow-overlap".
textAnchor
Link copied to clipboard
val textAnchor: TextAnchor?
Part of the text placed closest to the anchor.
textAnchorAsExpression
Link copied to clipboard
val textAnchorAsExpression: Expression?
This is an Expression representation of "text-anchor".
textColor
Link copied to clipboard
val textColor: String?
The color with which the text will be drawn.
textColorAsColorInt
Link copied to clipboard
val textColorAsColorInt: Int?
The color with which the text will be drawn.
textColorAsExpression
Link copied to clipboard
val textColorAsExpression: Expression?
This is an Expression representation of "text-color".
textColorTransition
Link copied to clipboard
val textColorTransition: StyleTransition?
Transition options for TextColor.
textField
Link copied to clipboard
val textField: Formatted?
Value to use for a text label.
textFieldAsExpression
Link copied to clipboard
val textFieldAsExpression: Expression?
This is an Expression representation of "text-field".
textFieldAsString
Link copied to clipboard
val textFieldAsString: String?
Value to use for a text label.
textFont
Link copied to clipboard
val textFont: List<String>?
Font stack to use for displaying text.
textFontAsExpression
Link copied to clipboard
val textFontAsExpression: Expression?
This is an Expression representation of "text-font".
textHaloBlur
Link copied to clipboard
val textHaloBlur: Double?
The halo's fadeout distance towards the outside.
textHaloBlurAsExpression
Link copied to clipboard
val textHaloBlurAsExpression: Expression?
This is an Expression representation of "text-halo-blur".
textHaloBlurTransition
Link copied to clipboard
val textHaloBlurTransition: StyleTransition?
Transition options for TextHaloBlur.
textHaloColor
Link copied to clipboard
val textHaloColor: String?
The color of the text's halo, which helps it stand out from backgrounds.
textHaloColorAsColorInt
Link copied to clipboard
val textHaloColorAsColorInt: Int?
The color of the text's halo, which helps it stand out from backgrounds.
textHaloColorAsExpression
Link copied to clipboard
val textHaloColorAsExpression: Expression?
This is an Expression representation of "text-halo-color".
textHaloColorTransition
Link copied to clipboard
val textHaloColorTransition: StyleTransition?
Transition options for TextHaloColor.
textHaloWidth
Link copied to clipboard
val textHaloWidth: Double?
Distance of halo to the font outline.
textHaloWidthAsExpression
Link copied to clipboard
val textHaloWidthAsExpression: Expression?
This is an Expression representation of "text-halo-width".
textHaloWidthTransition
Link copied to clipboard
val textHaloWidthTransition: StyleTransition?
Transition options for TextHaloWidth.
textIgnorePlacement
Link copied to clipboard
val textIgnorePlacement: Boolean?
If true, other symbols can be visible even if they collide with the text.
textIgnorePlacementAsExpression
Link copied to clipboard
val textIgnorePlacementAsExpression: Expression?
This is an Expression representation of "text-ignore-placement".
textJustify
Link copied to clipboard
val textJustify: TextJustify?
Text justification options.
textJustifyAsExpression
Link copied to clipboard
val textJustifyAsExpression: Expression?
This is an Expression representation of "text-justify".
textKeepUpright
Link copied to clipboard
val textKeepUpright: Boolean?
If true, the text may be flipped vertically to prevent it from being rendered upside-down.
textKeepUprightAsExpression
Link copied to clipboard
val textKeepUprightAsExpression: Expression?
This is an Expression representation of "text-keep-upright".
textLetterSpacing
Link copied to clipboard
val textLetterSpacing: Double?
Text tracking amount.
textLetterSpacingAsExpression
Link copied to clipboard
val textLetterSpacingAsExpression: Expression?
This is an Expression representation of "text-letter-spacing".
textLineHeight
Link copied to clipboard
val textLineHeight: Double?
Text leading value for multi-line text.
textLineHeightAsExpression
Link copied to clipboard
val textLineHeightAsExpression: Expression?
This is an Expression representation of "text-line-height".
textMaxAngle
Link copied to clipboard
val textMaxAngle: Double?
Maximum angle change between adjacent characters.
textMaxAngleAsExpression
Link copied to clipboard
val textMaxAngleAsExpression: Expression?
This is an Expression representation of "text-max-angle".
textMaxWidth
Link copied to clipboard
val textMaxWidth: Double?
The maximum line width for text wrapping.
textMaxWidthAsExpression
Link copied to clipboard
val textMaxWidthAsExpression: Expression?
This is an Expression representation of "text-max-width".
textOffset
Link copied to clipboard
val textOffset: List<Double>?
Offset distance of text from its anchor.
textOffsetAsExpression
Link copied to clipboard
val textOffsetAsExpression: Expression?
This is an Expression representation of "text-offset".
textOpacity
Link copied to clipboard
val textOpacity: Double?
The opacity at which the text will be drawn.
textOpacityAsExpression
Link copied to clipboard
val textOpacityAsExpression: Expression?
This is an Expression representation of "text-opacity".
textOpacityTransition
Link copied to clipboard
val textOpacityTransition: StyleTransition?
Transition options for TextOpacity.
textOptional
Link copied to clipboard
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
Link copied to clipboard
val textOptionalAsExpression: Expression?
This is an Expression representation of "text-optional".
textPadding
Link copied to clipboard
val textPadding: Double?
Size of the additional area around the text bounding box used for detecting symbol collisions.
textPaddingAsExpression
Link copied to clipboard
val textPaddingAsExpression: Expression?
This is an Expression representation of "text-padding".
textPitchAlignment
Link copied to clipboard
val textPitchAlignment: TextPitchAlignment?
Orientation of text when map is pitched.
textPitchAlignmentAsExpression
Link copied to clipboard
val textPitchAlignmentAsExpression: Expression?
This is an Expression representation of "text-pitch-alignment".
textRadialOffset
Link copied to clipboard
val textRadialOffset: Double?
Radial offset of text, in the direction of the symbol's anchor.
textRadialOffsetAsExpression
Link copied to clipboard
val textRadialOffsetAsExpression: Expression?
This is an Expression representation of "text-radial-offset".
textRotate
Link copied to clipboard
val textRotate: Double?
Rotates the text clockwise.
textRotateAsExpression
Link copied to clipboard
val textRotateAsExpression: Expression?
This is an Expression representation of "text-rotate".
textRotationAlignment
Link copied to clipboard
val textRotationAlignment: TextRotationAlignment?
In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text.
textRotationAlignmentAsExpression
Link copied to clipboard
val textRotationAlignmentAsExpression: Expression?
This is an Expression representation of "text-rotation-alignment".
textSize
Link copied to clipboard
val textSize: Double?
Font size.
textSizeAsExpression
Link copied to clipboard
val textSizeAsExpression: Expression?
This is an Expression representation of "text-size".
textTransform
Link copied to clipboard
val textTransform: TextTransform?
Specifies how to capitalize text, similar to the CSS text-transform property.
textTransformAsExpression
Link copied to clipboard
val textTransformAsExpression: Expression?
This is an Expression representation of "text-transform".
textTranslate
Link copied to clipboard
val textTranslate: List<Double>?
Distance that the text's anchor is moved from its original placement.
textTranslateAnchor
Link copied to clipboard
val textTranslateAnchor: TextTranslateAnchor?
Controls the frame of reference for text-translate.
textTranslateAnchorAsExpression
Link copied to clipboard
val textTranslateAnchorAsExpression: Expression?
This is an Expression representation of "text-translate-anchor".
textTranslateAsExpression
Link copied to clipboard
val textTranslateAsExpression: Expression?
This is an Expression representation of "text-translate".
textTranslateTransition
Link copied to clipboard
val textTranslateTransition: StyleTransition?
Transition options for TextTranslate.
textVariableAnchor
Link copied to clipboard
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
Link copied to clipboard
val textVariableAnchorAsExpression: Expression?
This is an Expression representation of "text-variable-anchor".
textWritingMode
Link copied to clipboard
val textWritingMode: List<String>?
The property allows control over a symbol's orientation.
textWritingModeAsExpression
Link copied to clipboard
val textWritingModeAsExpression: Expression?
This is an Expression representation of "text-writing-mode".
visibility
Link copied to clipboard
open override val visibility: Visibility?
Visibility of the layer.