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?
This is an Expression representation of "icon-allow-overlap".
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?
This is an Expression representation of "icon-anchor".
defaultIconColor
Link copied to clipboard
val defaultIconColor: String?
The color of the icon.
defaultIconColorAsColorInt
Link copied to clipboard
val defaultIconColorAsColorInt: Int?
The color of the icon.
defaultIconColorAsExpression
Link copied to clipboard
val defaultIconColorAsExpression: Expression?
This is an Expression representation of "icon-color".
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?
This is an Expression representation of "icon-halo-blur".
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.
defaultIconHaloColorAsColorInt
Link copied to clipboard
val defaultIconHaloColorAsColorInt: Int?
The color of the icon's halo.
defaultIconHaloColorAsExpression
Link copied to clipboard
val defaultIconHaloColorAsExpression: Expression?
This is an Expression representation of "icon-halo-color".
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?
This is an Expression representation of "icon-halo-width".
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?
This is an Expression representation of "icon-ignore-placement".
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?
This is an Expression representation of "icon-image".
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?
This is an Expression representation of "icon-keep-upright".
defaultIconOffset
Link copied to clipboard
val defaultIconOffset: List<Double>?
Offset distance of icon from its anchor.
defaultIconOffsetAsExpression
Link copied to clipboard
val defaultIconOffsetAsExpression: Expression?
This is an Expression representation of "icon-offset".
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?
This is an Expression representation of "icon-opacity".
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?
This is an Expression representation of "icon-optional".
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?
This is an Expression representation of "icon-padding".
defaultIconPitchAlignment
Link copied to clipboard
val defaultIconPitchAlignment: IconPitchAlignment?
Orientation of icon when map is pitched.
defaultIconPitchAlignmentAsExpression
Link copied to clipboard
val defaultIconPitchAlignmentAsExpression: Expression?
This is an Expression representation of "icon-pitch-alignment".
defaultIconRotate
Link copied to clipboard
val defaultIconRotate: Double?
Rotates the icon clockwise.
defaultIconRotateAsExpression
Link copied to clipboard
val defaultIconRotateAsExpression: Expression?
This is an Expression representation of "icon-rotate".
defaultIconRotationAlignment
Link copied to clipboard
val defaultIconRotationAlignment: IconRotationAlignment?
In combination with symbol-placement, determines the rotation behavior of icons.
val defaultIconRotationAlignmentAsExpression: Expression?
This is an Expression representation of "icon-rotation-alignment".
defaultIconSize
Link copied to clipboard
val defaultIconSize: Double?
Scales the original size of the icon by the provided factor.
defaultIconSizeAsExpression
Link copied to clipboard
val defaultIconSizeAsExpression: Expression?
This is an Expression representation of "icon-size".
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?
This is an Expression representation of "icon-text-fit".
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?
This is an Expression representation of "icon-text-fit-padding".
defaultIconTranslate
Link copied to clipboard
val defaultIconTranslate: List<Double>?
Distance that the icon's anchor is moved from its original placement.
defaultIconTranslateAnchor
Link copied to clipboard
val defaultIconTranslateAnchor: IconTranslateAnchor?
Controls the frame of reference for icon-translate.
defaultIconTranslateAnchorAsExpression
Link copied to clipboard
val defaultIconTranslateAnchorAsExpression: Expression?
This is an Expression representation of "icon-translate-anchor".
defaultIconTranslateAsExpression
Link copied to clipboard
val defaultIconTranslateAsExpression: Expression?
This is an Expression representation of "icon-translate".
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.
defaultMinZoom
Link copied to clipboard
val defaultMinZoom: Double?
The minimum zoom level for the layer.
defaultSymbolAvoidEdges
Link copied to clipboard
val defaultSymbolAvoidEdges: Boolean?
If true, the symbols will not cross tile edges to avoid mutual collisions.
defaultSymbolAvoidEdgesAsExpression
Link copied to clipboard
val defaultSymbolAvoidEdgesAsExpression: Expression?
This is an Expression representation of "symbol-avoid-edges".
defaultSymbolPlacement
Link copied to clipboard
val defaultSymbolPlacement: SymbolPlacement?
Label placement relative to its geometry.
defaultSymbolPlacementAsExpression
Link copied to clipboard
val defaultSymbolPlacementAsExpression: Expression?
This is an Expression representation of "symbol-placement".
defaultSymbolSortKey
Link copied to clipboard
val defaultSymbolSortKey: Double?
Sorts features in ascending order based on this value.
defaultSymbolSortKeyAsExpression
Link copied to clipboard
val defaultSymbolSortKeyAsExpression: Expression?
This is an Expression representation of "symbol-sort-key".
defaultSymbolSpacing
Link copied to clipboard
val defaultSymbolSpacing: Double?
Distance between two symbol anchors.
defaultSymbolSpacingAsExpression
Link copied to clipboard
val defaultSymbolSpacingAsExpression: Expression?
This is an Expression representation of "symbol-spacing".
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.
defaultSymbolZOrderAsExpression
Link copied to clipboard
val defaultSymbolZOrderAsExpression: Expression?
This is an Expression representation of "symbol-z-order".
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?
This is an Expression representation of "text-allow-overlap".
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?
This is an Expression representation of "text-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?
This is an Expression representation of "text-color".
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.
defaultTextFieldAsExpression
Link copied to clipboard
val defaultTextFieldAsExpression: Expression?
This is an Expression representation of "text-field".
defaultTextFieldAsString
Link copied to clipboard
val defaultTextFieldAsString: String?
Value to use for a text label.
defaultTextFont
Link copied to clipboard
val defaultTextFont: List<String>?
Font stack to use for displaying text.
defaultTextFontAsExpression
Link copied to clipboard
val defaultTextFontAsExpression: Expression?
This is an Expression representation of "text-font".
defaultTextHaloBlur
Link copied to clipboard
val defaultTextHaloBlur: Double?
The halo's fadeout distance towards the outside.
defaultTextHaloBlurAsExpression
Link copied to clipboard
val defaultTextHaloBlurAsExpression: Expression?
This is an Expression representation of "text-halo-blur".
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?
This is an Expression representation of "text-halo-color".
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.
defaultTextHaloWidthAsExpression
Link copied to clipboard
val defaultTextHaloWidthAsExpression: Expression?
This is an Expression representation of "text-halo-width".
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?
This is an Expression representation of "text-ignore-placement".
defaultTextJustify
Link copied to clipboard
val defaultTextJustify: TextJustify?
Text justification options.
defaultTextJustifyAsExpression
Link copied to clipboard
val defaultTextJustifyAsExpression: Expression?
This is an Expression representation of "text-justify".
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?
This is an Expression representation of "text-keep-upright".
defaultTextLetterSpacing
Link copied to clipboard
val defaultTextLetterSpacing: Double?
Text tracking amount.
defaultTextLetterSpacingAsExpression
Link copied to clipboard
val defaultTextLetterSpacingAsExpression: Expression?
This is an Expression representation of "text-letter-spacing".
defaultTextLineHeight
Link copied to clipboard
val defaultTextLineHeight: Double?
Text leading value for multi-line text.
defaultTextLineHeightAsExpression
Link copied to clipboard
val defaultTextLineHeightAsExpression: Expression?
This is an Expression representation of "text-line-height".
defaultTextMaxAngle
Link copied to clipboard
val defaultTextMaxAngle: Double?
Maximum angle change between adjacent characters.
defaultTextMaxAngleAsExpression
Link copied to clipboard
val defaultTextMaxAngleAsExpression: Expression?
This is an Expression representation of "text-max-angle".
defaultTextMaxWidth
Link copied to clipboard
val defaultTextMaxWidth: Double?
The maximum line width for text wrapping.
defaultTextMaxWidthAsExpression
Link copied to clipboard
val defaultTextMaxWidthAsExpression: Expression?
This is an Expression representation of "text-max-width".
defaultTextOffset
Link copied to clipboard
val defaultTextOffset: List<Double>?
Offset distance of text from its anchor.
defaultTextOffsetAsExpression
Link copied to clipboard
val defaultTextOffsetAsExpression: Expression?
This is an Expression representation of "text-offset".
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?
This is an Expression representation of "text-opacity".
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?
This is an Expression representation of "text-optional".
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?
This is an Expression representation of "text-padding".
defaultTextPitchAlignment
Link copied to clipboard
val defaultTextPitchAlignment: TextPitchAlignment?
Orientation of text when map is pitched.
defaultTextPitchAlignmentAsExpression
Link copied to clipboard
val defaultTextPitchAlignmentAsExpression: Expression?
This is an Expression representation of "text-pitch-alignment".
defaultTextRadialOffset
Link copied to clipboard
val defaultTextRadialOffset: Double?
Radial offset of text, in the direction of the symbol's anchor.
defaultTextRadialOffsetAsExpression
Link copied to clipboard
val defaultTextRadialOffsetAsExpression: Expression?
This is an Expression representation of "text-radial-offset".
defaultTextRotate
Link copied to clipboard
val defaultTextRotate: Double?
Rotates the text clockwise.
defaultTextRotateAsExpression
Link copied to clipboard
val defaultTextRotateAsExpression: Expression?
This is an Expression representation of "text-rotate".
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?
This is an Expression representation of "text-rotation-alignment".
defaultTextSize
Link copied to clipboard
val defaultTextSize: Double?
Font size.
defaultTextSizeAsExpression
Link copied to clipboard
val defaultTextSizeAsExpression: Expression?
This is an Expression representation of "text-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?
This is an Expression representation of "text-transform".
defaultTextTranslate
Link copied to clipboard
val defaultTextTranslate: List<Double>?
Distance that the text's anchor is moved from its original placement.
defaultTextTranslateAnchor
Link copied to clipboard
val defaultTextTranslateAnchor: TextTranslateAnchor?
Controls the frame of reference for text-translate.
defaultTextTranslateAnchorAsExpression
Link copied to clipboard
val defaultTextTranslateAnchorAsExpression: Expression?
This is an Expression representation of "text-translate-anchor".
defaultTextTranslateAsExpression
Link copied to clipboard
val defaultTextTranslateAsExpression: Expression?
This is an Expression representation of "text-translate".
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.
defaultTextVariableAnchorAsExpression
Link copied to clipboard
val defaultTextVariableAnchorAsExpression: Expression?
This is an Expression representation of "text-variable-anchor".
defaultTextWritingMode
Link copied to clipboard
val defaultTextWritingMode: List<String>?
The property allows control over a symbol's orientation.
defaultTextWritingModeAsExpression
Link copied to clipboard
val defaultTextWritingModeAsExpression: Expression?
This is an Expression representation of "text-writing-mode".
defaultVisibility
Link copied to clipboard
val defaultVisibility: Visibility?
Visibility of the layer.