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