Companion

object Companion

Static variables and methods.

Properties

defaultIconAllowOverlap
Link copied to clipboard
val defaultIconAllowOverlap: Boolean?

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

defaultIconAllowOverlapAsExpression
Link copied to clipboard
val defaultIconAllowOverlapAsExpression: Expression?

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

defaultIconAnchor
Link copied to clipboard
val defaultIconAnchor: IconAnchor?

Part of the icon placed closest to the anchor.

defaultIconAnchorAsExpression
Link copied to clipboard
val defaultIconAnchorAsExpression: Expression?

Part of the icon placed closest to the anchor.

defaultIconColor
Link copied to clipboard
val defaultIconColor: String?

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

defaultIconColorAsColorInt
Link copied to clipboard
val defaultIconColorAsColorInt: Int?

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

defaultIconColorAsExpression
Link copied to clipboard
val defaultIconColorAsExpression: Expression?

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

defaultIconColorTransition
Link copied to clipboard
val defaultIconColorTransition: StyleTransition?

Transition options for IconColor.

defaultIconHaloBlur
Link copied to clipboard
val defaultIconHaloBlur: Double?

Fade out the halo towards the outside.

defaultIconHaloBlurAsExpression
Link copied to clipboard
val defaultIconHaloBlurAsExpression: Expression?

Fade out the halo towards the outside.

defaultIconHaloBlurTransition
Link copied to clipboard
val defaultIconHaloBlurTransition: StyleTransition?

Transition options for IconHaloBlur.

defaultIconHaloColor
Link copied to clipboard
val defaultIconHaloColor: String?

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

defaultIconHaloColorAsColorInt
Link copied to clipboard
val defaultIconHaloColorAsColorInt: Int?

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

defaultIconHaloColorAsExpression
Link copied to clipboard
val defaultIconHaloColorAsExpression: Expression?

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

defaultIconHaloColorTransition
Link copied to clipboard
val defaultIconHaloColorTransition: StyleTransition?

Transition options for IconHaloColor.

defaultIconHaloWidth
Link copied to clipboard
val defaultIconHaloWidth: Double?

Distance of halo to the icon outline.

defaultIconHaloWidthAsExpression
Link copied to clipboard
val defaultIconHaloWidthAsExpression: Expression?

Distance of halo to the icon outline.

defaultIconHaloWidthTransition
Link copied to clipboard
val defaultIconHaloWidthTransition: StyleTransition?

Transition options for IconHaloWidth.

defaultIconIgnorePlacement
Link copied to clipboard
val defaultIconIgnorePlacement: Boolean?

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

defaultIconIgnorePlacementAsExpression
Link copied to clipboard
val defaultIconIgnorePlacementAsExpression: Expression?

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

defaultIconImage
Link copied to clipboard
val defaultIconImage: String?

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

defaultIconImageAsExpression
Link copied to clipboard
val defaultIconImageAsExpression: Expression?

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

defaultIconKeepUpright
Link copied to clipboard
val defaultIconKeepUpright: Boolean?

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

defaultIconKeepUprightAsExpression
Link copied to clipboard
val defaultIconKeepUprightAsExpression: Expression?

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

defaultIconOffset
Link copied to clipboard
val defaultIconOffset: List<Double>?

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.

defaultIconOffsetAsExpression
Link copied to clipboard
val defaultIconOffsetAsExpression: Expression?

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.

defaultIconOpacity
Link copied to clipboard
val defaultIconOpacity: Double?

The opacity at which the icon will be drawn.

defaultIconOpacityAsExpression
Link copied to clipboard
val defaultIconOpacityAsExpression: Expression?

The opacity at which the icon will be drawn.

defaultIconOpacityTransition
Link copied to clipboard
val defaultIconOpacityTransition: StyleTransition?

Transition options for IconOpacity.

defaultIconOptional
Link copied to clipboard
val defaultIconOptional: Boolean?

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

defaultIconOptionalAsExpression
Link copied to clipboard
val defaultIconOptionalAsExpression: Expression?

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

defaultIconPadding
Link copied to clipboard
val defaultIconPadding: Double?

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

defaultIconPaddingAsExpression
Link copied to clipboard
val defaultIconPaddingAsExpression: Expression?

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

defaultIconPitchAlignment
Link copied to clipboard
val defaultIconPitchAlignment: IconPitchAlignment?

Orientation of icon when map is pitched.

defaultIconPitchAlignmentAsExpression
Link copied to clipboard
val defaultIconPitchAlignmentAsExpression: Expression?

Orientation of icon when map is pitched.

defaultIconRotate
Link copied to clipboard
val defaultIconRotate: Double?

Rotates the icon clockwise.

defaultIconRotateAsExpression
Link copied to clipboard
val defaultIconRotateAsExpression: Expression?

Rotates the icon clockwise.

defaultIconRotationAlignment
Link copied to clipboard
val defaultIconRotationAlignment: IconRotationAlignment?

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

val defaultIconRotationAlignmentAsExpression: Expression?

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

defaultIconSize
Link copied to clipboard
val defaultIconSize: Double?

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.

defaultIconSizeAsExpression
Link copied to clipboard
val defaultIconSizeAsExpression: Expression?

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.

defaultIconTextFit
Link copied to clipboard
val defaultIconTextFit: IconTextFit?

Scales the icon to fit around the associated text.

defaultIconTextFitAsExpression
Link copied to clipboard
val defaultIconTextFitAsExpression: Expression?

Scales the icon to fit around the associated text.

defaultIconTextFitPadding
Link copied to clipboard
val defaultIconTextFitPadding: List<Double>?

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

defaultIconTextFitPaddingAsExpression
Link copied to clipboard
val defaultIconTextFitPaddingAsExpression: Expression?

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

defaultIconTranslate
Link copied to clipboard
val defaultIconTranslate: List<Double>?

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.

defaultIconTranslateAnchor
Link copied to clipboard
val defaultIconTranslateAnchor: IconTranslateAnchor?

Controls the frame of reference for icon-translate.

defaultIconTranslateAnchorAsExpression
Link copied to clipboard
val defaultIconTranslateAnchorAsExpression: Expression?

Controls the frame of reference for icon-translate.

defaultIconTranslateAsExpression
Link copied to clipboard
val defaultIconTranslateAsExpression: Expression?

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.

defaultIconTranslateTransition
Link copied to clipboard
val defaultIconTranslateTransition: StyleTransition?

Transition options for IconTranslate.

defaultMaxZoom
Link copied to clipboard
val defaultMaxZoom: Double?

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

defaultMinZoom
Link copied to clipboard
val defaultMinZoom: Double?

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

defaultSymbolAvoidEdges
Link copied to clipboard
val defaultSymbolAvoidEdges: Boolean?

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.

defaultSymbolAvoidEdgesAsExpression
Link copied to clipboard
val defaultSymbolAvoidEdgesAsExpression: Expression?

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.

defaultSymbolPlacement
Link copied to clipboard
val defaultSymbolPlacement: SymbolPlacement?

Label placement relative to its geometry.

defaultSymbolPlacementAsExpression
Link copied to clipboard
val defaultSymbolPlacementAsExpression: Expression?

Label placement relative to its geometry.

defaultSymbolSortKey
Link copied to clipboard
val defaultSymbolSortKey: Double?

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.

defaultSymbolSortKeyAsExpression
Link copied to clipboard
val defaultSymbolSortKeyAsExpression: Expression?

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.

defaultSymbolSpacing
Link copied to clipboard
val defaultSymbolSpacing: Double?

Distance between two symbol anchors.

defaultSymbolSpacingAsExpression
Link copied to clipboard
val defaultSymbolSpacingAsExpression: Expression?

Distance between two symbol anchors.

defaultSymbolZOrder
Link copied to clipboard
val defaultSymbolZOrder: SymbolZOrder?

Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use symbol-sort-key.

defaultSymbolZOrderAsExpression
Link copied to clipboard
val defaultSymbolZOrderAsExpression: Expression?

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.

defaultTextAllowOverlap
Link copied to clipboard
val defaultTextAllowOverlap: Boolean?

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

defaultTextAllowOverlapAsExpression
Link copied to clipboard
val defaultTextAllowOverlapAsExpression: Expression?

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

defaultTextAnchor
Link copied to clipboard
val defaultTextAnchor: TextAnchor?

Part of the text placed closest to the anchor.

defaultTextAnchorAsExpression
Link copied to clipboard
val defaultTextAnchorAsExpression: Expression?

Part of the text placed closest to the anchor.

defaultTextColor
Link copied to clipboard
val defaultTextColor: String?

The color with which the text will be drawn.

defaultTextColorAsColorInt
Link copied to clipboard
val defaultTextColorAsColorInt: Int?

The color with which the text will be drawn.

defaultTextColorAsExpression
Link copied to clipboard
val defaultTextColorAsExpression: Expression?

The color with which the text will be drawn.

defaultTextColorTransition
Link copied to clipboard
val defaultTextColorTransition: StyleTransition?

Transition options for TextColor.

defaultTextField
Link copied to clipboard
val defaultTextField: Formatted?

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.

defaultTextFieldAsExpression
Link copied to clipboard
val defaultTextFieldAsExpression: Expression?

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.

defaultTextFieldAsString
Link copied to clipboard
val defaultTextFieldAsString: String?

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.

defaultTextFont
Link copied to clipboard
val defaultTextFont: List<String>?

Font stack to use for displaying text.

defaultTextFontAsExpression
Link copied to clipboard
val defaultTextFontAsExpression: Expression?

Font stack to use for displaying text.

defaultTextHaloBlur
Link copied to clipboard
val defaultTextHaloBlur: Double?

The halo's fadeout distance towards the outside.

defaultTextHaloBlurAsExpression
Link copied to clipboard
val defaultTextHaloBlurAsExpression: Expression?

The halo's fadeout distance towards the outside.

defaultTextHaloBlurTransition
Link copied to clipboard
val defaultTextHaloBlurTransition: StyleTransition?

Transition options for TextHaloBlur.

defaultTextHaloColor
Link copied to clipboard
val defaultTextHaloColor: String?

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

defaultTextHaloColorAsColorInt
Link copied to clipboard
val defaultTextHaloColorAsColorInt: Int?

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

defaultTextHaloColorAsExpression
Link copied to clipboard
val defaultTextHaloColorAsExpression: Expression?

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

defaultTextHaloColorTransition
Link copied to clipboard
val defaultTextHaloColorTransition: StyleTransition?

Transition options for TextHaloColor.

defaultTextHaloWidth
Link copied to clipboard
val defaultTextHaloWidth: Double?

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

defaultTextHaloWidthAsExpression
Link copied to clipboard
val defaultTextHaloWidthAsExpression: Expression?

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

defaultTextHaloWidthTransition
Link copied to clipboard
val defaultTextHaloWidthTransition: StyleTransition?

Transition options for TextHaloWidth.

defaultTextIgnorePlacement
Link copied to clipboard
val defaultTextIgnorePlacement: Boolean?

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

defaultTextIgnorePlacementAsExpression
Link copied to clipboard
val defaultTextIgnorePlacementAsExpression: Expression?

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

defaultTextJustify
Link copied to clipboard
val defaultTextJustify: TextJustify?

Text justification options.

defaultTextJustifyAsExpression
Link copied to clipboard
val defaultTextJustifyAsExpression: Expression?

Text justification options.

defaultTextKeepUpright
Link copied to clipboard
val defaultTextKeepUpright: Boolean?

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

defaultTextKeepUprightAsExpression
Link copied to clipboard
val defaultTextKeepUprightAsExpression: Expression?

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

defaultTextLetterSpacing
Link copied to clipboard
val defaultTextLetterSpacing: Double?

Text tracking amount.

defaultTextLetterSpacingAsExpression
Link copied to clipboard
val defaultTextLetterSpacingAsExpression: Expression?

Text tracking amount.

defaultTextLineHeight
Link copied to clipboard
val defaultTextLineHeight: Double?

Text leading value for multi-line text.

defaultTextLineHeightAsExpression
Link copied to clipboard
val defaultTextLineHeightAsExpression: Expression?

Text leading value for multi-line text.

defaultTextMaxAngle
Link copied to clipboard
val defaultTextMaxAngle: Double?

Maximum angle change between adjacent characters.

defaultTextMaxAngleAsExpression
Link copied to clipboard
val defaultTextMaxAngleAsExpression: Expression?

Maximum angle change between adjacent characters.

defaultTextMaxWidth
Link copied to clipboard
val defaultTextMaxWidth: Double?

The maximum line width for text wrapping.

defaultTextMaxWidthAsExpression
Link copied to clipboard
val defaultTextMaxWidthAsExpression: Expression?

The maximum line width for text wrapping.

defaultTextOffset
Link copied to clipboard
val defaultTextOffset: List<Double>?

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.

defaultTextOffsetAsExpression
Link copied to clipboard
val defaultTextOffsetAsExpression: Expression?

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.

defaultTextOpacity
Link copied to clipboard
val defaultTextOpacity: Double?

The opacity at which the text will be drawn.

defaultTextOpacityAsExpression
Link copied to clipboard
val defaultTextOpacityAsExpression: Expression?

The opacity at which the text will be drawn.

defaultTextOpacityTransition
Link copied to clipboard
val defaultTextOpacityTransition: StyleTransition?

Transition options for TextOpacity.

defaultTextOptional
Link copied to clipboard
val defaultTextOptional: Boolean?

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

defaultTextOptionalAsExpression
Link copied to clipboard
val defaultTextOptionalAsExpression: Expression?

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

defaultTextPadding
Link copied to clipboard
val defaultTextPadding: Double?

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

defaultTextPaddingAsExpression
Link copied to clipboard
val defaultTextPaddingAsExpression: Expression?

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

defaultTextPitchAlignment
Link copied to clipboard
val defaultTextPitchAlignment: TextPitchAlignment?

Orientation of text when map is pitched.

defaultTextPitchAlignmentAsExpression
Link copied to clipboard
val defaultTextPitchAlignmentAsExpression: Expression?

Orientation of text when map is pitched.

defaultTextRadialOffset
Link copied to clipboard
val defaultTextRadialOffset: Double?

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.

defaultTextRadialOffsetAsExpression
Link copied to clipboard
val defaultTextRadialOffsetAsExpression: Expression?

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.

defaultTextRotate
Link copied to clipboard
val defaultTextRotate: Double?

Rotates the text clockwise.

defaultTextRotateAsExpression
Link copied to clipboard
val defaultTextRotateAsExpression: Expression?

Rotates the text clockwise.

defaultTextRotationAlignment
Link copied to clipboard
val defaultTextRotationAlignment: TextRotationAlignment?

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

val defaultTextRotationAlignmentAsExpression: Expression?

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

defaultTextSize
Link copied to clipboard
val defaultTextSize: Double?

Font size.

defaultTextSizeAsExpression
Link copied to clipboard
val defaultTextSizeAsExpression: Expression?

Font size.

defaultTextTransform
Link copied to clipboard
val defaultTextTransform: TextTransform?

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

defaultTextTransformAsExpression
Link copied to clipboard
val defaultTextTransformAsExpression: Expression?

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

defaultTextTranslate
Link copied to clipboard
val defaultTextTranslate: List<Double>?

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.

defaultTextTranslateAnchor
Link copied to clipboard
val defaultTextTranslateAnchor: TextTranslateAnchor?

Controls the frame of reference for text-translate.

defaultTextTranslateAnchorAsExpression
Link copied to clipboard
val defaultTextTranslateAnchorAsExpression: Expression?

Controls the frame of reference for text-translate.

defaultTextTranslateAsExpression
Link copied to clipboard
val defaultTextTranslateAsExpression: Expression?

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.

defaultTextTranslateTransition
Link copied to clipboard
val defaultTextTranslateTransition: StyleTransition?

Transition options for TextTranslate.

defaultTextVariableAnchor
Link copied to clipboard
val defaultTextVariableAnchor: List<String>?

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

defaultTextVariableAnchorAsExpression
Link copied to clipboard
val defaultTextVariableAnchorAsExpression: Expression?

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.

defaultTextWritingMode
Link copied to clipboard
val defaultTextWritingMode: List<String>?

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.

defaultTextWritingModeAsExpression
Link copied to clipboard
val defaultTextWritingModeAsExpression: Expression?

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.

defaultVisibility
Link copied to clipboard
val defaultVisibility: Visibility?

Visibility of the layer.