SymbolLayerDsl

interface SymbolLayerDsl

This Interface contains all the functions that will be exposed to Koltin DSL.

Separated the DSL receiver class to this interface to avoid IDE code suggestion for property getters.

Functions

Link copied to clipboard
abstract fun filter(filter: Expression): SymbolLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

Link copied to clipboard
abstract fun iconAllowOverlap(iconAllowOverlap: Expression): SymbolLayer
abstract fun iconAllowOverlap(iconAllowOverlap: Boolean = false): SymbolLayer

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

Link copied to clipboard
abstract fun iconAnchor(iconAnchor: Expression): SymbolLayer
abstract fun iconAnchor(iconAnchor: IconAnchor = IconAnchor.CENTER): SymbolLayer

Part of the icon placed closest to the anchor. Default value: "center".

Link copied to clipboard
abstract fun iconColor(iconColor: Expression): SymbolLayer
abstract fun iconColor(@ColorInt iconColor: Int): SymbolLayer
abstract fun iconColor(iconColor: String = "#000000"): SymbolLayer

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. Default value: "#000000".

Link copied to clipboard
abstract fun iconColorSaturation(iconColorSaturation: Expression): SymbolLayer
abstract fun iconColorSaturation(iconColorSaturation: Double = 0.0): SymbolLayer

Increase or reduce the saturation of the symbol icon. Default value: 0. Value range: -1, 1

Link copied to clipboard

Increase or reduce the saturation of the symbol icon. Default value: 0. Value range: -1, 1

Link copied to clipboard

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. Default value: "#000000".

Link copied to clipboard
abstract fun iconEmissiveStrength(iconEmissiveStrength: Expression): SymbolLayer
abstract fun iconEmissiveStrength(iconEmissiveStrength: Double = 1.0): SymbolLayer

Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.

Link copied to clipboard
abstract fun iconHaloBlur(iconHaloBlur: Expression): SymbolLayer
abstract fun iconHaloBlur(iconHaloBlur: Double = 0.0): SymbolLayer

Fade out the halo towards the outside. Default value: 0. Minimum value: 0.

Link copied to clipboard

Fade out the halo towards the outside. Default value: 0. Minimum value: 0.

Link copied to clipboard
abstract fun iconHaloColor(iconHaloColor: Expression): SymbolLayer
abstract fun iconHaloColor(@ColorInt iconHaloColor: Int): SymbolLayer
abstract fun iconHaloColor(iconHaloColor: String = "rgba(0, 0, 0, 0)"): SymbolLayer

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard
abstract fun iconHaloWidth(iconHaloWidth: Expression): SymbolLayer
abstract fun iconHaloWidth(iconHaloWidth: Double = 0.0): SymbolLayer

Distance of halo to the icon outline. Default value: 0. Minimum value: 0.

Link copied to clipboard

Distance of halo to the icon outline. Default value: 0. Minimum value: 0.

Link copied to clipboard
abstract fun iconIgnorePlacement(iconIgnorePlacement: Expression): SymbolLayer
abstract fun iconIgnorePlacement(iconIgnorePlacement: Boolean = false): SymbolLayer

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

Link copied to clipboard
abstract fun iconImage(iconImage: Expression): SymbolLayer
abstract fun iconImage(iconImage: String): SymbolLayer

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

Link copied to clipboard
abstract fun iconImageCrossFade(iconImageCrossFade: Expression): SymbolLayer
abstract fun iconImageCrossFade(iconImageCrossFade: Double = 0.0): SymbolLayer

Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together. Default value: 0. Value range: 0, 1

Link copied to clipboard

Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together. Default value: 0. Value range: 0, 1

Link copied to clipboard
abstract fun iconKeepUpright(iconKeepUpright: Expression): SymbolLayer
abstract fun iconKeepUpright(iconKeepUpright: Boolean = false): SymbolLayer

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

Link copied to clipboard
abstract fun iconOcclusionOpacity(iconOcclusionOpacity: Expression): SymbolLayer
abstract fun iconOcclusionOpacity(iconOcclusionOpacity: Double = 0.0): SymbolLayer

The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range: 0, 1

Link copied to clipboard

The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range: 0, 1

Link copied to clipboard
abstract fun iconOffset(iconOffset: Expression): SymbolLayer
abstract fun iconOffset(iconOffset: List<Double> = listOf(0.0, 0.0)): SymbolLayer

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. Default value: 0,0.

Link copied to clipboard
abstract fun iconOpacity(iconOpacity: Expression): SymbolLayer
abstract fun iconOpacity(iconOpacity: Double = 1.0): SymbolLayer

The opacity at which the icon will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard

The opacity at which the icon will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard
abstract fun iconOptional(iconOptional: Expression): SymbolLayer
abstract fun iconOptional(iconOptional: Boolean = false): SymbolLayer

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

Link copied to clipboard
abstract fun iconPadding(iconPadding: Expression): SymbolLayer
abstract fun iconPadding(iconPadding: Double = 2.0): SymbolLayer

Size of the additional area around the icon bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0.

Link copied to clipboard
abstract fun iconPitchAlignment(iconPitchAlignment: Expression): SymbolLayer
abstract fun iconPitchAlignment(iconPitchAlignment: IconPitchAlignment = IconPitchAlignment.AUTO): SymbolLayer

Orientation of icon when map is pitched. Default value: "auto".

Link copied to clipboard
abstract fun iconRotate(iconRotate: Expression): SymbolLayer
abstract fun iconRotate(iconRotate: Double = 0.0): SymbolLayer

Rotates the icon clockwise. Default value: 0.

Link copied to clipboard
abstract fun iconRotationAlignment(iconRotationAlignment: Expression): SymbolLayer
abstract fun iconRotationAlignment(iconRotationAlignment: IconRotationAlignment = IconRotationAlignment.AUTO): SymbolLayer

In combination with symbol-placement, determines the rotation behavior of icons. Default value: "auto".

Link copied to clipboard
abstract fun iconSize(iconSize: Expression): SymbolLayer
abstract fun iconSize(iconSize: Double = 1.0): SymbolLayer

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. Default value: 1. Minimum value: 0.

Link copied to clipboard
abstract fun iconTextFit(iconTextFit: Expression): SymbolLayer
abstract fun iconTextFit(iconTextFit: IconTextFit = IconTextFit.NONE): SymbolLayer

Scales the icon to fit around the associated text. Default value: "none".

Link copied to clipboard
abstract fun iconTextFitPadding(iconTextFitPadding: Expression): SymbolLayer
abstract fun iconTextFitPadding(iconTextFitPadding: List<Double> = listOf(0.0, 0.0, 0.0, 0.0)): SymbolLayer

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

Link copied to clipboard
abstract fun iconTranslate(iconTranslate: Expression): SymbolLayer
abstract fun iconTranslate(iconTranslate: List<Double> = listOf(0.0, 0.0)): SymbolLayer

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. Default value: 0,0.

Link copied to clipboard
abstract fun iconTranslateAnchor(iconTranslateAnchor: Expression): SymbolLayer
abstract fun iconTranslateAnchor(iconTranslateAnchor: IconTranslateAnchor = IconTranslateAnchor.MAP): SymbolLayer

Controls the frame of reference for icon-translate. Default value: "map".

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. Default value: 0,0.

Link copied to clipboard
abstract fun maxZoom(maxZoom: Double): SymbolLayer

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

Link copied to clipboard
abstract fun minZoom(minZoom: Double): SymbolLayer

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

Link copied to clipboard
abstract fun slot(slot: String): SymbolLayer

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
abstract fun sourceLayer(sourceLayer: String): SymbolLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
abstract fun symbolAvoidEdges(symbolAvoidEdges: Expression): SymbolLayer
abstract fun symbolAvoidEdges(symbolAvoidEdges: Boolean = false): SymbolLayer

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. Default value: false.

Link copied to clipboard
abstract fun symbolElevationReference(symbolElevationReference: Expression): SymbolLayer
abstract fun symbolElevationReference(symbolElevationReference: SymbolElevationReference = SymbolElevationReference.GROUND): SymbolLayer

Selects the base of symbol-elevation. Default value: "ground".

Link copied to clipboard
abstract fun symbolPlacement(symbolPlacement: Expression): SymbolLayer
abstract fun symbolPlacement(symbolPlacement: SymbolPlacement = SymbolPlacement.POINT): SymbolLayer

Label placement relative to its geometry. Default value: "point".

Link copied to clipboard
abstract fun symbolSortKey(symbolSortKey: Expression): SymbolLayer
abstract fun symbolSortKey(symbolSortKey: Double): SymbolLayer

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.

Link copied to clipboard
abstract fun symbolSpacing(symbolSpacing: Expression): SymbolLayer
abstract fun symbolSpacing(symbolSpacing: Double = 250.0): SymbolLayer

Distance between two symbol anchors. Default value: 250. Minimum value: 1.

Link copied to clipboard
abstract fun symbolZElevate(symbolZElevate: Expression): SymbolLayer
abstract fun symbolZElevate(symbolZElevate: Boolean = false): SymbolLayer

Position symbol on buildings (both fill extrusions and models) rooftops. In order to have minimal impact on performance, this is supported only when fill-extrusion-height is not zoom-dependent and remains unchanged. For fading in buildings when zooming in, fill-extrusion-vertical-scale should be used and symbols would raise with building rooftops. Symbols are sorted by elevation, except in cases when viewport-y sorting or symbol-sort-key are applied. Default value: false.

Link copied to clipboard
abstract fun symbolZOffset(symbolZOffset: Double = 0.0): SymbolLayer

Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.

Link copied to clipboard

Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.

Link copied to clipboard
abstract fun symbolZOrder(symbolZOrder: Expression): SymbolLayer
abstract fun symbolZOrder(symbolZOrder: SymbolZOrder = SymbolZOrder.AUTO): SymbolLayer

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. Default value: "auto".

Link copied to clipboard
abstract fun textAllowOverlap(textAllowOverlap: Expression): SymbolLayer
abstract fun textAllowOverlap(textAllowOverlap: Boolean = false): SymbolLayer

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

Link copied to clipboard
abstract fun textAnchor(textAnchor: Expression): SymbolLayer
abstract fun textAnchor(textAnchor: TextAnchor = TextAnchor.CENTER): SymbolLayer

Part of the text placed closest to the anchor. Default value: "center".

Link copied to clipboard
abstract fun textColor(textColor: Expression): SymbolLayer
abstract fun textColor(@ColorInt textColor: Int): SymbolLayer
abstract fun textColor(textColor: String = "#000000"): SymbolLayer

The color with which the text will be drawn. Default value: "#000000".

Link copied to clipboard

The color with which the text will be drawn. Default value: "#000000".

Link copied to clipboard
abstract fun textEmissiveStrength(textEmissiveStrength: Expression): SymbolLayer
abstract fun textEmissiveStrength(textEmissiveStrength: Double = 1.0): SymbolLayer

Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.

Link copied to clipboard
abstract fun textField(textField: Expression): SymbolLayer
abstract fun textField(textField: Formatted): SymbolLayer
abstract fun textField(block: Formatted.() -> Unit): SymbolLayer
abstract fun textField(textField: String): SymbolLayer

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. SDF images are not supported in formatted text and will be ignored. Default value: "".

Link copied to clipboard
abstract fun textFont(textFont: Expression): SymbolLayer
abstract fun textFont(textFont: List<String> = listOf("Open Sans Regular", "Arial Unicode MS Regular")): SymbolLayer

Font stack to use for displaying text.

Link copied to clipboard
abstract fun textHaloBlur(textHaloBlur: Expression): SymbolLayer
abstract fun textHaloBlur(textHaloBlur: Double = 0.0): SymbolLayer

The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0.

Link copied to clipboard

The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0.

Link copied to clipboard
abstract fun textHaloColor(textHaloColor: Expression): SymbolLayer
abstract fun textHaloColor(@ColorInt textHaloColor: Int): SymbolLayer
abstract fun textHaloColor(textHaloColor: String = "rgba(0, 0, 0, 0)"): SymbolLayer

The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard

The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard
abstract fun textHaloWidth(textHaloWidth: Expression): SymbolLayer
abstract fun textHaloWidth(textHaloWidth: Double = 0.0): SymbolLayer

Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. Default value: 0. Minimum value: 0.

Link copied to clipboard

Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. Default value: 0. Minimum value: 0.

Link copied to clipboard
abstract fun textIgnorePlacement(textIgnorePlacement: Expression): SymbolLayer
abstract fun textIgnorePlacement(textIgnorePlacement: Boolean = false): SymbolLayer

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

Link copied to clipboard
abstract fun textJustify(textJustify: Expression): SymbolLayer
abstract fun textJustify(textJustify: TextJustify = TextJustify.CENTER): SymbolLayer

Text justification options. Default value: "center".

Link copied to clipboard
abstract fun textKeepUpright(textKeepUpright: Expression): SymbolLayer
abstract fun textKeepUpright(textKeepUpright: Boolean = true): SymbolLayer

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

Link copied to clipboard
abstract fun textLetterSpacing(textLetterSpacing: Expression): SymbolLayer
abstract fun textLetterSpacing(textLetterSpacing: Double = 0.0): SymbolLayer

Text tracking amount. Default value: 0.

Link copied to clipboard
abstract fun textLineHeight(textLineHeight: Expression): SymbolLayer
abstract fun textLineHeight(textLineHeight: Double = 1.2): SymbolLayer

Text leading value for multi-line text. Default value: 1.2.

Link copied to clipboard
abstract fun textMaxAngle(textMaxAngle: Expression): SymbolLayer
abstract fun textMaxAngle(textMaxAngle: Double = 45.0): SymbolLayer

Maximum angle change between adjacent characters. Default value: 45.

Link copied to clipboard
abstract fun textMaxWidth(textMaxWidth: Expression): SymbolLayer
abstract fun textMaxWidth(textMaxWidth: Double = 10.0): SymbolLayer

The maximum line width for text wrapping. Default value: 10. Minimum value: 0.

Link copied to clipboard
abstract fun textOcclusionOpacity(textOcclusionOpacity: Expression): SymbolLayer
abstract fun textOcclusionOpacity(textOcclusionOpacity: Double = 0.0): SymbolLayer

The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range: 0, 1

Link copied to clipboard

The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range: 0, 1

Link copied to clipboard
abstract fun textOffset(textOffset: Expression): SymbolLayer
abstract fun textOffset(textOffset: List<Double> = listOf(0.0, 0.0)): SymbolLayer

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. Default value: 0,0.

Link copied to clipboard
abstract fun textOpacity(textOpacity: Expression): SymbolLayer
abstract fun textOpacity(textOpacity: Double = 1.0): SymbolLayer

The opacity at which the text will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard

The opacity at which the text will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard
abstract fun textOptional(textOptional: Expression): SymbolLayer
abstract fun textOptional(textOptional: Boolean = false): SymbolLayer

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

Link copied to clipboard
abstract fun textPadding(textPadding: Expression): SymbolLayer
abstract fun textPadding(textPadding: Double = 2.0): SymbolLayer

Size of the additional area around the text bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0.

Link copied to clipboard
abstract fun textPitchAlignment(textPitchAlignment: Expression): SymbolLayer
abstract fun textPitchAlignment(textPitchAlignment: TextPitchAlignment = TextPitchAlignment.AUTO): SymbolLayer

Orientation of text when map is pitched. Default value: "auto".

Link copied to clipboard
abstract fun textRadialOffset(textRadialOffset: Expression): SymbolLayer
abstract fun textRadialOffset(textRadialOffset: Double = 0.0): SymbolLayer

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. Default value: 0.

Link copied to clipboard
abstract fun textRotate(textRotate: Expression): SymbolLayer
abstract fun textRotate(textRotate: Double = 0.0): SymbolLayer

Rotates the text clockwise. Default value: 0.

Link copied to clipboard
abstract fun textRotationAlignment(textRotationAlignment: Expression): SymbolLayer
abstract fun textRotationAlignment(textRotationAlignment: TextRotationAlignment = TextRotationAlignment.AUTO): SymbolLayer

In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto".

Link copied to clipboard
abstract fun textSize(textSize: Expression): SymbolLayer
abstract fun textSize(textSize: Double = 16.0): SymbolLayer

Font size. Default value: 16. Minimum value: 0.

Link copied to clipboard
abstract fun textTransform(textTransform: Expression): SymbolLayer
abstract fun textTransform(textTransform: TextTransform = TextTransform.NONE): SymbolLayer

Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".

Link copied to clipboard
abstract fun textTranslate(textTranslate: Expression): SymbolLayer
abstract fun textTranslate(textTranslate: List<Double> = listOf(0.0, 0.0)): SymbolLayer

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. Default value: 0,0.

Link copied to clipboard
abstract fun textTranslateAnchor(textTranslateAnchor: Expression): SymbolLayer
abstract fun textTranslateAnchor(textTranslateAnchor: TextTranslateAnchor = TextTranslateAnchor.MAP): SymbolLayer

Controls the frame of reference for text-translate. Default value: "map".

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. Default value: 0,0.

Link copied to clipboard
abstract fun textVariableAnchor(textVariableAnchor: Expression): SymbolLayer
abstract fun textVariableAnchor(textVariableAnchor: List<String>): SymbolLayer

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.

Link copied to clipboard
abstract fun textWritingMode(textWritingMode: Expression): SymbolLayer
abstract fun textWritingMode(textWritingMode: List<String>): SymbolLayer

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. For symbol with point placement, the order of elements in an array define priority order for the placement of an orientation variant. For symbol with line placement, the default text writing mode is either 'horizontal', 'vertical' or 'vertical', 'horizontal', the order doesn't affect the placement.

Link copied to clipboard
abstract fun visibility(visibility: Expression): SymbolLayer
abstract fun visibility(visibility: Visibility): SymbolLayer

Whether this layer is displayed.

Inheritors

Link copied to clipboard