SymbolLayer

An icon or a text label.

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

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

SymbolLayer
Link copied to clipboard

the ID of the layer

fun SymbolLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Bind the layer to the Style.

override fun bindTo(delegate: StyleInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
filter
Link copied to clipboard

Set the filter property

open override fun filter(filter: Expression): SymbolLayer
hashCode
Link copied to clipboard
open override fun hashCode(): Int
iconAllowOverlap
Link copied to clipboard

Set the IconAllowOverlap property

open override fun iconAllowOverlap(iconAllowOverlap: Expression): SymbolLayer
open override fun iconAllowOverlap(iconAllowOverlap: Boolean): SymbolLayer
iconAnchor
Link copied to clipboard

Set the IconAnchor property

open override fun iconAnchor(iconAnchor: Expression): SymbolLayer
open override fun iconAnchor(iconAnchor: IconAnchor): SymbolLayer
iconColor
Link copied to clipboard

Set the IconColor property

open override fun iconColor(iconColor: Expression): SymbolLayer
open override fun iconColor(iconColor: String): SymbolLayer

Set the IconColor property.

open override fun iconColor(@ColorInt() iconColor: Int): SymbolLayer
iconColorTransition
Link copied to clipboard

Set the IconColor property transition options

open override fun iconColorTransition(options: StyleTransition): SymbolLayer
open override fun iconColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconHaloBlur
Link copied to clipboard

Set the IconHaloBlur property

open override fun iconHaloBlur(iconHaloBlur: Expression): SymbolLayer
open override fun iconHaloBlur(iconHaloBlur: Double): SymbolLayer
iconHaloBlurTransition
Link copied to clipboard

Set the IconHaloBlur property transition options

open override fun iconHaloBlurTransition(options: StyleTransition): SymbolLayer
open override fun iconHaloBlurTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconHaloColor
Link copied to clipboard

Set the IconHaloColor property

open override fun iconHaloColor(iconHaloColor: Expression): SymbolLayer
open override fun iconHaloColor(iconHaloColor: String): SymbolLayer

Set the IconHaloColor property.

open override fun iconHaloColor(@ColorInt() iconHaloColor: Int): SymbolLayer
iconHaloColorTransition
Link copied to clipboard

Set the IconHaloColor property transition options

open override fun iconHaloColorTransition(options: StyleTransition): SymbolLayer
open override fun iconHaloColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconHaloWidth
Link copied to clipboard

Set the IconHaloWidth property

open override fun iconHaloWidth(iconHaloWidth: Expression): SymbolLayer
open override fun iconHaloWidth(iconHaloWidth: Double): SymbolLayer
iconHaloWidthTransition
Link copied to clipboard

Set the IconHaloWidth property transition options

open override fun iconHaloWidthTransition(options: StyleTransition): SymbolLayer
open override fun iconHaloWidthTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconIgnorePlacement
Link copied to clipboard

Set the IconIgnorePlacement property

open override fun iconIgnorePlacement(iconIgnorePlacement: Expression): SymbolLayer
open override fun iconIgnorePlacement(iconIgnorePlacement: Boolean): SymbolLayer
iconImage
Link copied to clipboard

Set the IconImage property

open override fun iconImage(iconImage: Expression): SymbolLayer
open override fun iconImage(iconImage: String): SymbolLayer
iconKeepUpright
Link copied to clipboard

Set the IconKeepUpright property

open override fun iconKeepUpright(iconKeepUpright: Expression): SymbolLayer
open override fun iconKeepUpright(iconKeepUpright: Boolean): SymbolLayer
iconOffset
Link copied to clipboard

Set the IconOffset property

open override fun iconOffset(iconOffset: Expression): SymbolLayer
open override fun iconOffset(iconOffset: List<Double>): SymbolLayer
iconOpacity
Link copied to clipboard

Set the IconOpacity property

open override fun iconOpacity(iconOpacity: Expression): SymbolLayer
open override fun iconOpacity(iconOpacity: Double): SymbolLayer
iconOpacityTransition
Link copied to clipboard

Set the IconOpacity property transition options

open override fun iconOpacityTransition(options: StyleTransition): SymbolLayer
open override fun iconOpacityTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
iconOptional
Link copied to clipboard

Set the IconOptional property

open override fun iconOptional(iconOptional: Expression): SymbolLayer
open override fun iconOptional(iconOptional: Boolean): SymbolLayer
iconPadding
Link copied to clipboard

Set the IconPadding property

open override fun iconPadding(iconPadding: Expression): SymbolLayer
open override fun iconPadding(iconPadding: Double): SymbolLayer
iconPitchAlignment
Link copied to clipboard

Set the IconPitchAlignment property

open override fun iconPitchAlignment(iconPitchAlignment: Expression): SymbolLayer
open override fun iconPitchAlignment(iconPitchAlignment: IconPitchAlignment): SymbolLayer
iconRotate
Link copied to clipboard

Set the IconRotate property

open override fun iconRotate(iconRotate: Expression): SymbolLayer
open override fun iconRotate(iconRotate: Double): SymbolLayer
iconRotationAlignment
Link copied to clipboard

Set the IconRotationAlignment property

open override fun iconRotationAlignment(iconRotationAlignment: Expression): SymbolLayer
open override fun iconRotationAlignment(iconRotationAlignment: IconRotationAlignment): SymbolLayer
iconSize
Link copied to clipboard

Set the IconSize property

open override fun iconSize(iconSize: Expression): SymbolLayer
open override fun iconSize(iconSize: Double): SymbolLayer
iconTextFit
Link copied to clipboard

Set the IconTextFit property

open override fun iconTextFit(iconTextFit: Expression): SymbolLayer
open override fun iconTextFit(iconTextFit: IconTextFit): SymbolLayer
iconTextFitPadding
Link copied to clipboard

Set the IconTextFitPadding property

open override fun iconTextFitPadding(iconTextFitPadding: Expression): SymbolLayer
open override fun iconTextFitPadding(iconTextFitPadding: List<Double>): SymbolLayer
iconTranslate
Link copied to clipboard

Set the IconTranslate property

open override fun iconTranslate(iconTranslate: Expression): SymbolLayer
open override fun iconTranslate(iconTranslate: List<Double>): SymbolLayer
iconTranslateAnchor
Link copied to clipboard

Set the IconTranslateAnchor property

open override fun iconTranslateAnchor(iconTranslateAnchor: Expression): SymbolLayer
open override fun iconTranslateAnchor(iconTranslateAnchor: IconTranslateAnchor): SymbolLayer
iconTranslateTransition
Link copied to clipboard

Set the IconTranslate property transition options

open override fun iconTranslateTransition(options: StyleTransition): SymbolLayer
open override fun iconTranslateTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
maxZoom
Link copied to clipboard

Set the maxzoom property

open override fun maxZoom(maxZoom: Double): SymbolLayer
minZoom
Link copied to clipboard

Set the minzoom property

open override fun minZoom(minZoom: Double): SymbolLayer
sourceLayer
Link copied to clipboard

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): SymbolLayer
symbolAvoidEdges
Link copied to clipboard

Set the SymbolAvoidEdges property

open override fun symbolAvoidEdges(symbolAvoidEdges: Expression): SymbolLayer
open override fun symbolAvoidEdges(symbolAvoidEdges: Boolean): SymbolLayer
symbolPlacement
Link copied to clipboard

Set the SymbolPlacement property

open override fun symbolPlacement(symbolPlacement: Expression): SymbolLayer
open override fun symbolPlacement(symbolPlacement: SymbolPlacement): SymbolLayer
symbolSortKey
Link copied to clipboard

Set the SymbolSortKey property

open override fun symbolSortKey(symbolSortKey: Expression): SymbolLayer
open override fun symbolSortKey(symbolSortKey: Double): SymbolLayer
symbolSpacing
Link copied to clipboard

Set the SymbolSpacing property

open override fun symbolSpacing(symbolSpacing: Expression): SymbolLayer
open override fun symbolSpacing(symbolSpacing: Double): SymbolLayer
symbolZOrder
Link copied to clipboard

Set the SymbolZOrder property

open override fun symbolZOrder(symbolZOrder: Expression): SymbolLayer
open override fun symbolZOrder(symbolZOrder: SymbolZOrder): SymbolLayer
textAllowOverlap
Link copied to clipboard

Set the TextAllowOverlap property

open override fun textAllowOverlap(textAllowOverlap: Expression): SymbolLayer
open override fun textAllowOverlap(textAllowOverlap: Boolean): SymbolLayer
textAnchor
Link copied to clipboard

Set the TextAnchor property

open override fun textAnchor(textAnchor: Expression): SymbolLayer
open override fun textAnchor(textAnchor: TextAnchor): SymbolLayer
textColor
Link copied to clipboard

Set the TextColor property

open override fun textColor(textColor: Expression): SymbolLayer
open override fun textColor(textColor: String): SymbolLayer

Set the TextColor property.

open override fun textColor(@ColorInt() textColor: Int): SymbolLayer
textColorTransition
Link copied to clipboard

Set the TextColor property transition options

open override fun textColorTransition(options: StyleTransition): SymbolLayer
open override fun textColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textField
Link copied to clipboard

Set the TextField property

open override fun textField(textField: Expression): SymbolLayer
open override fun textField(textField: Formatted): SymbolLayer

DSL for construct Formatted textField.

open override fun textField(block: Formatted.() -> Unit): SymbolLayer

Set the TextField property as String.

open override fun textField(textField: String): SymbolLayer
textFont
Link copied to clipboard

Set the TextFont property

open override fun textFont(textFont: Expression): SymbolLayer
open override fun textFont(textFont: List<String>): SymbolLayer
textHaloBlur
Link copied to clipboard

Set the TextHaloBlur property

open override fun textHaloBlur(textHaloBlur: Expression): SymbolLayer
open override fun textHaloBlur(textHaloBlur: Double): SymbolLayer
textHaloBlurTransition
Link copied to clipboard

Set the TextHaloBlur property transition options

open override fun textHaloBlurTransition(options: StyleTransition): SymbolLayer
open override fun textHaloBlurTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textHaloColor
Link copied to clipboard

Set the TextHaloColor property

open override fun textHaloColor(textHaloColor: Expression): SymbolLayer
open override fun textHaloColor(textHaloColor: String): SymbolLayer

Set the TextHaloColor property.

open override fun textHaloColor(@ColorInt() textHaloColor: Int): SymbolLayer
textHaloColorTransition
Link copied to clipboard

Set the TextHaloColor property transition options

open override fun textHaloColorTransition(options: StyleTransition): SymbolLayer
open override fun textHaloColorTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textHaloWidth
Link copied to clipboard

Set the TextHaloWidth property

open override fun textHaloWidth(textHaloWidth: Expression): SymbolLayer
open override fun textHaloWidth(textHaloWidth: Double): SymbolLayer
textHaloWidthTransition
Link copied to clipboard

Set the TextHaloWidth property transition options

open override fun textHaloWidthTransition(options: StyleTransition): SymbolLayer
open override fun textHaloWidthTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textIgnorePlacement
Link copied to clipboard

Set the TextIgnorePlacement property

open override fun textIgnorePlacement(textIgnorePlacement: Expression): SymbolLayer
open override fun textIgnorePlacement(textIgnorePlacement: Boolean): SymbolLayer
textJustify
Link copied to clipboard

Set the TextJustify property

open override fun textJustify(textJustify: Expression): SymbolLayer
open override fun textJustify(textJustify: TextJustify): SymbolLayer
textKeepUpright
Link copied to clipboard

Set the TextKeepUpright property

open override fun textKeepUpright(textKeepUpright: Expression): SymbolLayer
open override fun textKeepUpright(textKeepUpright: Boolean): SymbolLayer
textLetterSpacing
Link copied to clipboard

Set the TextLetterSpacing property

open override fun textLetterSpacing(textLetterSpacing: Expression): SymbolLayer
open override fun textLetterSpacing(textLetterSpacing: Double): SymbolLayer
textLineHeight
Link copied to clipboard

Set the TextLineHeight property

open override fun textLineHeight(textLineHeight: Expression): SymbolLayer
open override fun textLineHeight(textLineHeight: Double): SymbolLayer
textMaxAngle
Link copied to clipboard

Set the TextMaxAngle property

open override fun textMaxAngle(textMaxAngle: Expression): SymbolLayer
open override fun textMaxAngle(textMaxAngle: Double): SymbolLayer
textMaxWidth
Link copied to clipboard

Set the TextMaxWidth property

open override fun textMaxWidth(textMaxWidth: Expression): SymbolLayer
open override fun textMaxWidth(textMaxWidth: Double): SymbolLayer
textOffset
Link copied to clipboard

Set the TextOffset property

open override fun textOffset(textOffset: Expression): SymbolLayer
open override fun textOffset(textOffset: List<Double>): SymbolLayer
textOpacity
Link copied to clipboard

Set the TextOpacity property

open override fun textOpacity(textOpacity: Expression): SymbolLayer
open override fun textOpacity(textOpacity: Double): SymbolLayer
textOpacityTransition
Link copied to clipboard

Set the TextOpacity property transition options

open override fun textOpacityTransition(options: StyleTransition): SymbolLayer
open override fun textOpacityTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textOptional
Link copied to clipboard

Set the TextOptional property

open override fun textOptional(textOptional: Expression): SymbolLayer
open override fun textOptional(textOptional: Boolean): SymbolLayer
textPadding
Link copied to clipboard

Set the TextPadding property

open override fun textPadding(textPadding: Expression): SymbolLayer
open override fun textPadding(textPadding: Double): SymbolLayer
textPitchAlignment
Link copied to clipboard

Set the TextPitchAlignment property

open override fun textPitchAlignment(textPitchAlignment: Expression): SymbolLayer
open override fun textPitchAlignment(textPitchAlignment: TextPitchAlignment): SymbolLayer
textRadialOffset
Link copied to clipboard

Set the TextRadialOffset property

open override fun textRadialOffset(textRadialOffset: Expression): SymbolLayer
open override fun textRadialOffset(textRadialOffset: Double): SymbolLayer
textRotate
Link copied to clipboard

Set the TextRotate property

open override fun textRotate(textRotate: Expression): SymbolLayer
open override fun textRotate(textRotate: Double): SymbolLayer
textRotationAlignment
Link copied to clipboard

Set the TextRotationAlignment property

open override fun textRotationAlignment(textRotationAlignment: Expression): SymbolLayer
open override fun textRotationAlignment(textRotationAlignment: TextRotationAlignment): SymbolLayer
textSize
Link copied to clipboard

Set the TextSize property

open override fun textSize(textSize: Expression): SymbolLayer
open override fun textSize(textSize: Double): SymbolLayer
textTransform
Link copied to clipboard

Set the TextTransform property

open override fun textTransform(textTransform: Expression): SymbolLayer
open override fun textTransform(textTransform: TextTransform): SymbolLayer
textTranslate
Link copied to clipboard

Set the TextTranslate property

open override fun textTranslate(textTranslate: Expression): SymbolLayer
open override fun textTranslate(textTranslate: List<Double>): SymbolLayer
textTranslateAnchor
Link copied to clipboard

Set the TextTranslateAnchor property

open override fun textTranslateAnchor(textTranslateAnchor: Expression): SymbolLayer
open override fun textTranslateAnchor(textTranslateAnchor: TextTranslateAnchor): SymbolLayer
textTranslateTransition
Link copied to clipboard

Set the TextTranslate property transition options

open override fun textTranslateTransition(options: StyleTransition): SymbolLayer
open override fun textTranslateTransition(block: StyleTransition.Builder.() -> Unit): SymbolLayer
textVariableAnchor
Link copied to clipboard

Set the TextVariableAnchor property

open override fun textVariableAnchor(textVariableAnchor: Expression): SymbolLayer
open override fun textVariableAnchor(textVariableAnchor: List<String>): SymbolLayer
textWritingMode
Link copied to clipboard

Set the TextWritingMode property

open override fun textWritingMode(textWritingMode: Expression): SymbolLayer
open override fun textWritingMode(textWritingMode: List<String>): SymbolLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): SymbolLayer

Properties

filter
Link copied to clipboard

A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions.

val filter: Expression?
iconAllowOverlap
Link copied to clipboard

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

val iconAllowOverlap: Boolean?
iconAllowOverlapAsExpression
Link copied to clipboard

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

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

val iconAllowOverlapAsExpression: Expression?
iconAnchor
Link copied to clipboard

Part of the icon placed closest to the anchor.

val iconAnchor: IconAnchor?
iconAnchorAsExpression
Link copied to clipboard

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

Part of the icon placed closest to the anchor.

val iconAnchorAsExpression: Expression?
iconColor
Link copied to clipboard

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

val iconColor: String?
iconColorAsColorInt
Link copied to clipboard

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

val iconColorAsColorInt: Int?
iconColorAsExpression
Link copied to clipboard

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

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

val iconColorAsExpression: Expression?
iconColorTransition
Link copied to clipboard

Transition options for IconColor.

val iconColorTransition: StyleTransition?
iconHaloBlur
Link copied to clipboard

Fade out the halo towards the outside.

val iconHaloBlur: Double?
iconHaloBlurAsExpression
Link copied to clipboard

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

Fade out the halo towards the outside.

val iconHaloBlurAsExpression: Expression?
iconHaloBlurTransition
Link copied to clipboard

Transition options for IconHaloBlur.

val iconHaloBlurTransition: StyleTransition?
iconHaloColor
Link copied to clipboard

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

val iconHaloColor: String?
iconHaloColorAsColorInt
Link copied to clipboard

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

val iconHaloColorAsColorInt: Int?
iconHaloColorAsExpression
Link copied to clipboard

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

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

val iconHaloColorAsExpression: Expression?
iconHaloColorTransition
Link copied to clipboard

Transition options for IconHaloColor.

val iconHaloColorTransition: StyleTransition?
iconHaloWidth
Link copied to clipboard

Distance of halo to the icon outline.

val iconHaloWidth: Double?
iconHaloWidthAsExpression
Link copied to clipboard

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

Distance of halo to the icon outline.

val iconHaloWidthAsExpression: Expression?
iconHaloWidthTransition
Link copied to clipboard

Transition options for IconHaloWidth.

val iconHaloWidthTransition: StyleTransition?
iconIgnorePlacement
Link copied to clipboard

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

val iconIgnorePlacement: Boolean?
iconIgnorePlacementAsExpression
Link copied to clipboard

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

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

val iconIgnorePlacementAsExpression: Expression?
iconImage
Link copied to clipboard

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

val iconImage: String?
iconImageAsExpression
Link copied to clipboard

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

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

val iconImageAsExpression: Expression?
iconKeepUpright
Link copied to clipboard

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

val iconKeepUpright: Boolean?
iconKeepUprightAsExpression
Link copied to clipboard

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

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

val iconKeepUprightAsExpression: Expression?
iconOffset
Link copied to clipboard

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.

val iconOffset: List<Double>?
iconOffsetAsExpression
Link copied to clipboard

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

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.

val iconOffsetAsExpression: Expression?
iconOpacity
Link copied to clipboard

The opacity at which the icon will be drawn.

val iconOpacity: Double?
iconOpacityAsExpression
Link copied to clipboard

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

The opacity at which the icon will be drawn.

val iconOpacityAsExpression: Expression?
iconOpacityTransition
Link copied to clipboard

Transition options for IconOpacity.

val iconOpacityTransition: StyleTransition?
iconOptional
Link copied to clipboard

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

val iconOptional: Boolean?
iconOptionalAsExpression
Link copied to clipboard

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

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

val iconOptionalAsExpression: Expression?
iconPadding
Link copied to clipboard

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

val iconPadding: Double?
iconPaddingAsExpression
Link copied to clipboard

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

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

val iconPaddingAsExpression: Expression?
iconPitchAlignment
Link copied to clipboard

Orientation of icon when map is pitched.

val iconPitchAlignment: IconPitchAlignment?
iconPitchAlignmentAsExpression
Link copied to clipboard

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

Orientation of icon when map is pitched.

val iconPitchAlignmentAsExpression: Expression?
iconRotate
Link copied to clipboard

Rotates the icon clockwise.

val iconRotate: Double?
iconRotateAsExpression
Link copied to clipboard

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

Rotates the icon clockwise.

val iconRotateAsExpression: Expression?
iconRotationAlignment
Link copied to clipboard

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

val iconRotationAlignment: IconRotationAlignment?
iconRotationAlignmentAsExpression
Link copied to clipboard

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

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

val iconRotationAlignmentAsExpression: Expression?
iconSize
Link copied to clipboard

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.

val iconSize: Double?
iconSizeAsExpression
Link copied to clipboard

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

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.

val iconSizeAsExpression: Expression?
iconTextFit
Link copied to clipboard

Scales the icon to fit around the associated text.

val iconTextFit: IconTextFit?
iconTextFitAsExpression
Link copied to clipboard

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

Scales the icon to fit around the associated text.

val iconTextFitAsExpression: Expression?
iconTextFitPadding
Link copied to clipboard

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

val iconTextFitPadding: List<Double>?
iconTextFitPaddingAsExpression
Link copied to clipboard

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

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

val iconTextFitPaddingAsExpression: Expression?
iconTranslate
Link copied to clipboard

Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.

val iconTranslate: List<Double>?
iconTranslateAnchor
Link copied to clipboard

Controls the frame of reference for icon-translate.

val iconTranslateAnchor: IconTranslateAnchor?
iconTranslateAnchorAsExpression
Link copied to clipboard

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

Controls the frame of reference for icon-translate.

val iconTranslateAnchorAsExpression: Expression?
iconTranslateAsExpression
Link copied to clipboard

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

Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.

val iconTranslateAsExpression: Expression?
iconTranslateTransition
Link copied to clipboard

Transition options for IconTranslate.

val iconTranslateTransition: StyleTransition?
layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
maxZoom
Link copied to clipboard

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

Range: minimum: 0 maximum: 24

open override val maxZoom: Double?
minZoom
Link copied to clipboard

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Range: minimum: 0 maximum: 24

open override val minZoom: Double?
sourceId
Link copied to clipboard

the ID of the source

val sourceId: String
sourceLayer
Link copied to clipboard

Source layer.

val sourceLayer: String?
symbolAvoidEdges
Link copied to clipboard

If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.

val symbolAvoidEdges: Boolean?
symbolAvoidEdgesAsExpression
Link copied to clipboard

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

If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.

val symbolAvoidEdgesAsExpression: Expression?
symbolPlacement
Link copied to clipboard

Label placement relative to its geometry.

val symbolPlacement: SymbolPlacement?
symbolPlacementAsExpression
Link copied to clipboard

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

Label placement relative to its geometry.

val symbolPlacementAsExpression: Expression?
symbolSortKey
Link copied to clipboard

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.

val symbolSortKey: Double?
symbolSortKeyAsExpression
Link copied to clipboard

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

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.

val symbolSortKeyAsExpression: Expression?
symbolSpacing
Link copied to clipboard

Distance between two symbol anchors.

val symbolSpacing: Double?
symbolSpacingAsExpression
Link copied to clipboard

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

Distance between two symbol anchors.

val symbolSpacingAsExpression: Expression?
symbolZOrder
Link copied to clipboard

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. To control the order and prioritization of symbols otherwise, use symbol-sort-key.

val symbolZOrder: SymbolZOrder?
symbolZOrderAsExpression
Link copied to clipboard

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

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. To control the order and prioritization of symbols otherwise, use symbol-sort-key.

val symbolZOrderAsExpression: Expression?
textAllowOverlap
Link copied to clipboard

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

val textAllowOverlap: Boolean?
textAllowOverlapAsExpression
Link copied to clipboard

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

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

val textAllowOverlapAsExpression: Expression?
textAnchor
Link copied to clipboard

Part of the text placed closest to the anchor.

val textAnchor: TextAnchor?
textAnchorAsExpression
Link copied to clipboard

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

Part of the text placed closest to the anchor.

val textAnchorAsExpression: Expression?
textColor
Link copied to clipboard

The color with which the text will be drawn.

val textColor: String?
textColorAsColorInt
Link copied to clipboard

The color with which the text will be drawn.

val textColorAsColorInt: Int?
textColorAsExpression
Link copied to clipboard

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

The color with which the text will be drawn.

val textColorAsExpression: Expression?
textColorTransition
Link copied to clipboard

Transition options for TextColor.

val textColorTransition: StyleTransition?
textField
Link copied to clipboard

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.

val textField: Formatted?
textFieldAsExpression
Link copied to clipboard

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

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.

val textFieldAsExpression: Expression?
textFieldAsString
Link copied to clipboard

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.

val textFieldAsString: String?
textFont
Link copied to clipboard

Font stack to use for displaying text.

val textFont: List<String>?
textFontAsExpression
Link copied to clipboard

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

Font stack to use for displaying text.

val textFontAsExpression: Expression?
textHaloBlur
Link copied to clipboard

The halo's fadeout distance towards the outside.

val textHaloBlur: Double?
textHaloBlurAsExpression
Link copied to clipboard

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

The halo's fadeout distance towards the outside.

val textHaloBlurAsExpression: Expression?
textHaloBlurTransition
Link copied to clipboard

Transition options for TextHaloBlur.

val textHaloBlurTransition: StyleTransition?
textHaloColor
Link copied to clipboard

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

val textHaloColor: String?
textHaloColorAsColorInt
Link copied to clipboard

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

val textHaloColorAsColorInt: Int?
textHaloColorAsExpression
Link copied to clipboard

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

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

val textHaloColorAsExpression: Expression?
textHaloColorTransition
Link copied to clipboard

Transition options for TextHaloColor.

val textHaloColorTransition: StyleTransition?
textHaloWidth
Link copied to clipboard

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

val textHaloWidth: Double?
textHaloWidthAsExpression
Link copied to clipboard

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

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

val textHaloWidthAsExpression: Expression?
textHaloWidthTransition
Link copied to clipboard

Transition options for TextHaloWidth.

val textHaloWidthTransition: StyleTransition?
textIgnorePlacement
Link copied to clipboard

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

val textIgnorePlacement: Boolean?
textIgnorePlacementAsExpression
Link copied to clipboard

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

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

val textIgnorePlacementAsExpression: Expression?
textJustify
Link copied to clipboard

Text justification options.

val textJustify: TextJustify?
textJustifyAsExpression
Link copied to clipboard

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

Text justification options.

val textJustifyAsExpression: Expression?
textKeepUpright
Link copied to clipboard

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

val textKeepUpright: Boolean?
textKeepUprightAsExpression
Link copied to clipboard

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

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

val textKeepUprightAsExpression: Expression?
textLetterSpacing
Link copied to clipboard

Text tracking amount.

val textLetterSpacing: Double?
textLetterSpacingAsExpression
Link copied to clipboard

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

Text tracking amount.

val textLetterSpacingAsExpression: Expression?
textLineHeight
Link copied to clipboard

Text leading value for multi-line text.

val textLineHeight: Double?
textLineHeightAsExpression
Link copied to clipboard

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

Text leading value for multi-line text.

val textLineHeightAsExpression: Expression?
textMaxAngle
Link copied to clipboard

Maximum angle change between adjacent characters.

val textMaxAngle: Double?
textMaxAngleAsExpression
Link copied to clipboard

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

Maximum angle change between adjacent characters.

val textMaxAngleAsExpression: Expression?
textMaxWidth
Link copied to clipboard

The maximum line width for text wrapping.

val textMaxWidth: Double?
textMaxWidthAsExpression
Link copied to clipboard

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

The maximum line width for text wrapping.

val textMaxWidthAsExpression: Expression?
textOffset
Link copied to clipboard

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.

val textOffset: List<Double>?
textOffsetAsExpression
Link copied to clipboard

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

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.

val textOffsetAsExpression: Expression?
textOpacity
Link copied to clipboard

The opacity at which the text will be drawn.

val textOpacity: Double?
textOpacityAsExpression
Link copied to clipboard

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

The opacity at which the text will be drawn.

val textOpacityAsExpression: Expression?
textOpacityTransition
Link copied to clipboard

Transition options for TextOpacity.

val textOpacityTransition: StyleTransition?
textOptional
Link copied to clipboard

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

val textOptional: Boolean?
textOptionalAsExpression
Link copied to clipboard

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

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

val textOptionalAsExpression: Expression?
textPadding
Link copied to clipboard

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

val textPadding: Double?
textPaddingAsExpression
Link copied to clipboard

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

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

val textPaddingAsExpression: Expression?
textPitchAlignment
Link copied to clipboard

Orientation of text when map is pitched.

val textPitchAlignment: TextPitchAlignment?
textPitchAlignmentAsExpression
Link copied to clipboard

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

Orientation of text when map is pitched.

val textPitchAlignmentAsExpression: Expression?
textRadialOffset
Link copied to clipboard

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.

val textRadialOffset: Double?
textRadialOffsetAsExpression
Link copied to clipboard

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

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.

val textRadialOffsetAsExpression: Expression?
textRotate
Link copied to clipboard

Rotates the text clockwise.

val textRotate: Double?
textRotateAsExpression
Link copied to clipboard

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

Rotates the text clockwise.

val textRotateAsExpression: Expression?
textRotationAlignment
Link copied to clipboard

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

val textRotationAlignment: TextRotationAlignment?
textRotationAlignmentAsExpression
Link copied to clipboard

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

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

val textRotationAlignmentAsExpression: Expression?
textSize
Link copied to clipboard

Font size.

val textSize: Double?
textSizeAsExpression
Link copied to clipboard

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

Font size.

val textSizeAsExpression: Expression?
textTransform
Link copied to clipboard

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

val textTransform: TextTransform?
textTransformAsExpression
Link copied to clipboard

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

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

val textTransformAsExpression: Expression?
textTranslate
Link copied to clipboard

Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.

val textTranslate: List<Double>?
textTranslateAnchor
Link copied to clipboard

Controls the frame of reference for text-translate.

val textTranslateAnchor: TextTranslateAnchor?
textTranslateAnchorAsExpression
Link copied to clipboard

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

Controls the frame of reference for text-translate.

val textTranslateAnchorAsExpression: Expression?
textTranslateAsExpression
Link copied to clipboard

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

Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.

val textTranslateAsExpression: Expression?
textTranslateTransition
Link copied to clipboard

Transition options for TextTranslate.

val textTranslateTransition: StyleTransition?
textVariableAnchor
Link copied to clipboard

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. Use text-justify: auto to choose justification based on anchor position. To apply an offset, use the text-radial-offset or the two-dimensional text-offset.

val textVariableAnchor: List<String>?
textVariableAnchorAsExpression
Link copied to clipboard

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

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. Use text-justify: auto to choose justification based on anchor position. To apply an offset, use the text-radial-offset or the two-dimensional text-offset.

val textVariableAnchorAsExpression: Expression?
textWritingMode
Link copied to clipboard

The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.

val textWritingMode: List<String>?
textWritingModeAsExpression
Link copied to clipboard

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

The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.

val textWritingModeAsExpression: Expression?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?