SymbolLayer class

An icon or a text label.

Inheritance

Constructors

SymbolLayer({required String id, Visibility? visibility, List<Object>? visibilityExpression, List<Object>? filter, double? minZoom, double? maxZoom, String? slot, required String sourceId, String? sourceLayer, bool? iconAllowOverlap, List<Object>? iconAllowOverlapExpression, IconAnchor? iconAnchor, List<Object>? iconAnchorExpression, bool? iconIgnorePlacement, List<Object>? iconIgnorePlacementExpression, String? iconImage, List<Object>? iconImageExpression, bool? iconKeepUpright, List<Object>? iconKeepUprightExpression, List<double?>? iconOffset, List<Object>? iconOffsetExpression, bool? iconOptional, List<Object>? iconOptionalExpression, double? iconPadding, List<Object>? iconPaddingExpression, IconPitchAlignment? iconPitchAlignment, List<Object>? iconPitchAlignmentExpression, double? iconRotate, List<Object>? iconRotateExpression, IconRotationAlignment? iconRotationAlignment, List<Object>? iconRotationAlignmentExpression, double? iconSize, List<Object>? iconSizeExpression, List<double?>? iconSizeScaleRange, List<Object>? iconSizeScaleRangeExpression, IconTextFit? iconTextFit, List<Object>? iconTextFitExpression, List<double?>? iconTextFitPadding, List<Object>? iconTextFitPaddingExpression, bool? symbolAvoidEdges, List<Object>? symbolAvoidEdgesExpression, SymbolElevationReference? symbolElevationReference, List<Object>? symbolElevationReferenceExpression, SymbolPlacement? symbolPlacement, List<Object>? symbolPlacementExpression, double? symbolSortKey, List<Object>? symbolSortKeyExpression, double? symbolSpacing, List<Object>? symbolSpacingExpression, bool? symbolZElevate, List<Object>? symbolZElevateExpression, SymbolZOrder? symbolZOrder, List<Object>? symbolZOrderExpression, bool? textAllowOverlap, List<Object>? textAllowOverlapExpression, TextAnchor? textAnchor, List<Object>? textAnchorExpression, String? textField, List<Object>? textFieldExpression, List<String?>? textFont, List<Object>? textFontExpression, bool? textIgnorePlacement, List<Object>? textIgnorePlacementExpression, TextJustify? textJustify, List<Object>? textJustifyExpression, bool? textKeepUpright, List<Object>? textKeepUprightExpression, double? textLetterSpacing, List<Object>? textLetterSpacingExpression, double? textLineHeight, List<Object>? textLineHeightExpression, double? textMaxAngle, List<Object>? textMaxAngleExpression, double? textMaxWidth, List<Object>? textMaxWidthExpression, List<double?>? textOffset, List<Object>? textOffsetExpression, bool? textOptional, List<Object>? textOptionalExpression, double? textPadding, List<Object>? textPaddingExpression, TextPitchAlignment? textPitchAlignment, List<Object>? textPitchAlignmentExpression, double? textRadialOffset, List<Object>? textRadialOffsetExpression, double? textRotate, List<Object>? textRotateExpression, TextRotationAlignment? textRotationAlignment, List<Object>? textRotationAlignmentExpression, double? textSize, List<Object>? textSizeExpression, List<double?>? textSizeScaleRange, List<Object>? textSizeScaleRangeExpression, TextTransform? textTransform, List<Object>? textTransformExpression, List<String?>? textVariableAnchor, List<Object>? textVariableAnchorExpression, List<String?>? textWritingMode, List<Object>? textWritingModeExpression, int? iconColor, List<Object>? iconColorExpression, double? iconColorBrightnessMax, List<Object>? iconColorBrightnessMaxExpression, double? iconColorBrightnessMin, List<Object>? iconColorBrightnessMinExpression, double? iconColorContrast, List<Object>? iconColorContrastExpression, double? iconColorSaturation, List<Object>? iconColorSaturationExpression, double? iconEmissiveStrength, List<Object>? iconEmissiveStrengthExpression, double? iconHaloBlur, List<Object>? iconHaloBlurExpression, int? iconHaloColor, List<Object>? iconHaloColorExpression, double? iconHaloWidth, List<Object>? iconHaloWidthExpression, double? iconImageCrossFade, List<Object>? iconImageCrossFadeExpression, double? iconOcclusionOpacity, List<Object>? iconOcclusionOpacityExpression, double? iconOpacity, List<Object>? iconOpacityExpression, List<double?>? iconTranslate, List<Object>? iconTranslateExpression, IconTranslateAnchor? iconTranslateAnchor, List<Object>? iconTranslateAnchorExpression, OcclusionOpacityMode? occlusionOpacityMode, List<Object>? occlusionOpacityModeExpression, double? symbolZOffset, List<Object>? symbolZOffsetExpression, int? textColor, List<Object>? textColorExpression, double? textEmissiveStrength, List<Object>? textEmissiveStrengthExpression, double? textHaloBlur, List<Object>? textHaloBlurExpression, int? textHaloColor, List<Object>? textHaloColorExpression, double? textHaloWidth, List<Object>? textHaloWidthExpression, double? textOcclusionOpacity, List<Object>? textOcclusionOpacityExpression, double? textOpacity, List<Object>? textOpacityExpression, List<double?>? textTranslate, List<Object>? textTranslateExpression, TextTranslateAnchor? textTranslateAnchor, List<Object>? textTranslateAnchorExpression})

Properties

filter ↔ List<Object>?
An expression specifying conditions on source features. Only features that match the filter are displayed.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
iconAllowOverlap ↔ bool?
If true, the icon will be visible even if it collides with other previously drawn symbols. Default value: false.
getter/setter pair
iconAllowOverlapExpression ↔ List<Object>?
If true, the icon will be visible even if it collides with other previously drawn symbols. Default value: false.
getter/setter pair
iconAnchor ↔ IconAnchor?
Part of the icon placed closest to the anchor. Default value: "center".
getter/setter pair
iconAnchorExpression ↔ List<Object>?
Part of the icon placed closest to the anchor. Default value: "center".
getter/setter pair
iconColor ↔ int?
The color of the icon. This can only be used with SDF icons. Default value: "#000000".
getter/setter pair
iconColorBrightnessMax ↔ double?
Increase or reduce the brightness of the symbols. The value is the maximum brightness. Default value: 1. Value range: 0, 1
getter/setter pair
iconColorBrightnessMaxExpression ↔ List<Object>?
Increase or reduce the brightness of the symbols. The value is the maximum brightness. Default value: 1. Value range: 0, 1
getter/setter pair
iconColorBrightnessMin ↔ double?
Increase or reduce the brightness of the symbols. The value is the minimum brightness. Default value: 0. Value range: 0, 1
getter/setter pair
iconColorBrightnessMinExpression ↔ List<Object>?
Increase or reduce the brightness of the symbols. The value is the minimum brightness. Default value: 0. Value range: 0, 1
getter/setter pair
iconColorContrast ↔ double?
Increase or reduce the contrast of the symbol icon. Default value: 0. Value range: -1, 1
getter/setter pair
iconColorContrastExpression ↔ List<Object>?
Increase or reduce the contrast of the symbol icon. Default value: 0. Value range: -1, 1
getter/setter pair
iconColorExpression ↔ List<Object>?
The color of the icon. This can only be used with SDF icons. Default value: "#000000".
getter/setter pair
iconColorSaturation ↔ double?
Increase or reduce the saturation of the symbol icon. Default value: 0. Value range: -1, 1
getter/setter pair
iconColorSaturationExpression ↔ List<Object>?
Increase or reduce the saturation of the symbol icon. Default value: 0. Value range: -1, 1
getter/setter pair
iconEmissiveStrength ↔ double?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0. The unit of iconEmissiveStrength is in intensity.
getter/setter pair
iconEmissiveStrengthExpression ↔ List<Object>?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0. The unit of iconEmissiveStrength is in intensity.
getter/setter pair
iconHaloBlur ↔ double?
Fade out the halo towards the outside. Default value: 0. Minimum value: 0. The unit of iconHaloBlur is in pixels.
getter/setter pair
iconHaloBlurExpression ↔ List<Object>?
Fade out the halo towards the outside. Default value: 0. Minimum value: 0. The unit of iconHaloBlur is in pixels.
getter/setter pair
iconHaloColor ↔ int?
The color of the icon's halo. Icon halos can only be used with SDF icons. Default value: "rgba(0, 0, 0, 0)".
getter/setter pair
iconHaloColorExpression ↔ List<Object>?
The color of the icon's halo. Icon halos can only be used with SDF icons. Default value: "rgba(0, 0, 0, 0)".
getter/setter pair
iconHaloWidth ↔ double?
Distance of halo to the icon outline. Default value: 0. Minimum value: 0. The unit of iconHaloWidth is in pixels.
getter/setter pair
iconHaloWidthExpression ↔ List<Object>?
Distance of halo to the icon outline. Default value: 0. Minimum value: 0. The unit of iconHaloWidth is in pixels.
getter/setter pair
iconIgnorePlacement ↔ bool?
If true, other symbols can be visible even if they collide with the icon. Default value: false.
getter/setter pair
iconIgnorePlacementExpression ↔ List<Object>?
If true, other symbols can be visible even if they collide with the icon. Default value: false.
getter/setter pair
iconImage ↔ String?
Name of image in sprite to use for drawing an image background.
getter/setter pair
iconImageCrossFade ↔ double?
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. . Both images should be the same size and have the same type (either raster or vector). Default value: 0. Value range: 0, 1
getter/setter pair
iconImageCrossFadeExpression ↔ List<Object>?
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. . Both images should be the same size and have the same type (either raster or vector). Default value: 0. Value range: 0, 1
getter/setter pair
iconImageExpression ↔ List<Object>?
Name of image in sprite to use for drawing an image background.
getter/setter pair
iconKeepUpright ↔ bool?
If true, the icon may be flipped to prevent it from being rendered upside-down. Default value: false.
getter/setter pair
iconKeepUprightExpression ↔ List<Object>?
If true, the icon may be flipped to prevent it from being rendered upside-down. Default value: false.
getter/setter pair
iconOcclusionOpacity ↔ double?
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
getter/setter pair
iconOcclusionOpacityExpression ↔ List<Object>?
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
getter/setter pair
iconOffset ↔ 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. Default value: 0,0.
getter/setter pair
iconOffsetExpression ↔ List<Object>?
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.
getter/setter pair
iconOpacity ↔ double?
The opacity at which the icon will be drawn. Default value: 1. Value range: 0, 1
getter/setter pair
iconOpacityExpression ↔ List<Object>?
The opacity at which the icon will be drawn. Default value: 1. Value range: 0, 1
getter/setter pair
iconOptional ↔ bool?
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not. Default value: false.
getter/setter pair
iconOptionalExpression ↔ List<Object>?
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not. Default value: false.
getter/setter pair
iconPadding ↔ double?
Size of the additional area around the icon bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0. The unit of iconPadding is in pixels.
getter/setter pair
iconPaddingExpression ↔ List<Object>?
Size of the additional area around the icon bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0. The unit of iconPadding is in pixels.
getter/setter pair
iconPitchAlignment ↔ IconPitchAlignment?
Orientation of icon when map is pitched. Default value: "auto".
getter/setter pair
iconPitchAlignmentExpression ↔ List<Object>?
Orientation of icon when map is pitched. Default value: "auto".
getter/setter pair
iconRotate ↔ double?
Rotates the icon clockwise. Default value: 0. The unit of iconRotate is in degrees.
getter/setter pair
iconRotateExpression ↔ List<Object>?
Rotates the icon clockwise. Default value: 0. The unit of iconRotate is in degrees.
getter/setter pair
iconRotationAlignment ↔ IconRotationAlignment?
In combination with symbol-placement, determines the rotation behavior of icons. Default value: "auto".
getter/setter pair
iconRotationAlignmentExpression ↔ List<Object>?
In combination with symbol-placement, determines the rotation behavior of icons. Default value: "auto".
getter/setter pair
iconSize ↔ 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. Default value: 1. Minimum value: 0. The unit of iconSize is in factor of the original icon size.
getter/setter pair
iconSizeExpression ↔ List<Object>?
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. The unit of iconSize is in factor of the original icon size.
getter/setter pair
iconSizeScaleRange ↔ List<double?>?
Limits the possible scaling range for icon-size, icon-halo-width, icon-halo-blur properties to be within min-scale, max-scale Default value: 0.8,2. Minimum value: 0.1,0.1. Maximum value: 10,10.
getter/setter pair
iconSizeScaleRangeExpression ↔ List<Object>?
Limits the possible scaling range for icon-size, icon-halo-width, icon-halo-blur properties to be within min-scale, max-scale Default value: 0.8,2. Minimum value: 0.1,0.1. Maximum value: 10,10.
getter/setter pair
iconTextFit ↔ IconTextFit?
Scales the icon to fit around the associated text. Default value: "none".
getter/setter pair
iconTextFitExpression ↔ List<Object>?
Scales the icon to fit around the associated text. Default value: "none".
getter/setter pair
iconTextFitPadding ↔ List<double?>?
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. The unit of iconTextFitPadding is in pixels.
getter/setter pair
iconTextFitPaddingExpression ↔ List<Object>?
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. The unit of iconTextFitPadding is in pixels.
getter/setter pair
iconTranslate ↔ 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. Default value: 0,0. The unit of iconTranslate is in pixels.
getter/setter pair
iconTranslateAnchor ↔ IconTranslateAnchor?
Controls the frame of reference for icon-translate. Default value: "map".
getter/setter pair
iconTranslateAnchorExpression ↔ List<Object>?
Controls the frame of reference for icon-translate. Default value: "map".
getter/setter pair
iconTranslateExpression ↔ List<Object>?
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. The unit of iconTranslate is in pixels.
getter/setter pair
id ↔ String
The ID of the Layer.
getter/setter pairinherited
maxZoom ↔ double?
The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
getter/setter pairinherited
minZoom ↔ double?
The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.
getter/setter pairinherited
occlusionOpacityMode ↔ OcclusionOpacityMode?
Specify how opacity in case of being occluded should be applied Default value: "anchor".
getter/setter pair
occlusionOpacityModeExpression ↔ List<Object>?
Specify how opacity in case of being occluded should be applied Default value: "anchor".
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slot ↔ String?
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.
getter/setter pairinherited
sourceId ↔ String
The id of the source.
getter/setter pair
sourceLayer ↔ String?
A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.
getter/setter pair
symbolAvoidEdges ↔ bool?
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.
getter/setter pair
symbolAvoidEdgesExpression ↔ List<Object>?
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.
getter/setter pair
symbolElevationReference ↔ SymbolElevationReference?
Selects the base of symbol-elevation. Default value: "ground".
getter/setter pair
symbolElevationReferenceExpression ↔ List<Object>?
Selects the base of symbol-elevation. Default value: "ground".
getter/setter pair
symbolPlacement ↔ SymbolPlacement?
Label placement relative to its geometry. Default value: "point".
getter/setter pair
symbolPlacementExpression ↔ List<Object>?
Label placement relative to its geometry. Default value: "point".
getter/setter pair
symbolSortKey ↔ 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.
getter/setter pair
symbolSortKeyExpression ↔ List<Object>?
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.
getter/setter pair
symbolSpacing ↔ double?
Distance between two symbol anchors. Default value: 250. Minimum value: 1. The unit of symbolSpacing is in pixels.
getter/setter pair
symbolSpacingExpression ↔ List<Object>?
Distance between two symbol anchors. Default value: 250. Minimum value: 1. The unit of symbolSpacing is in pixels.
getter/setter pair
symbolZElevate ↔ bool?
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.
getter/setter pair
symbolZElevateExpression ↔ List<Object>?
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.
getter/setter pair
symbolZOffset ↔ double?
Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.
getter/setter pair
symbolZOffsetExpression ↔ List<Object>?
Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.
getter/setter pair
symbolZOrder ↔ 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. Default value: "auto".
getter/setter pair
symbolZOrderExpression ↔ List<Object>?
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".
getter/setter pair
textAllowOverlap ↔ bool?
If true, the text will be visible even if it collides with other previously drawn symbols. Default value: false.
getter/setter pair
textAllowOverlapExpression ↔ List<Object>?
If true, the text will be visible even if it collides with other previously drawn symbols. Default value: false.
getter/setter pair
textAnchor ↔ TextAnchor?
Part of the text placed closest to the anchor. Default value: "center".
getter/setter pair
textAnchorExpression ↔ List<Object>?
Part of the text placed closest to the anchor. Default value: "center".
getter/setter pair
textColor ↔ int?
The color with which the text will be drawn. Default value: "#000000".
getter/setter pair
textColorExpression ↔ List<Object>?
The color with which the text will be drawn. Default value: "#000000".
getter/setter pair
textEmissiveStrength ↔ double?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0. The unit of textEmissiveStrength is in intensity.
getter/setter pair
textEmissiveStrengthExpression ↔ List<Object>?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0. The unit of textEmissiveStrength is in intensity.
getter/setter pair
textField ↔ 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. Default value: "".
getter/setter pair
textFieldExpression ↔ List<Object>?
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: "".
getter/setter pair
textFont ↔ List<String?>?
Font stack to use for displaying text.
getter/setter pair
textFontExpression ↔ List<Object>?
Font stack to use for displaying text.
getter/setter pair
textHaloBlur ↔ double?
The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0. The unit of textHaloBlur is in pixels.
getter/setter pair
textHaloBlurExpression ↔ List<Object>?
The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0. The unit of textHaloBlur is in pixels.
getter/setter pair
textHaloColor ↔ int?
The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".
getter/setter pair
textHaloColorExpression ↔ List<Object>?
The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".
getter/setter pair
textHaloWidth ↔ double?
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. Default value: 0. Minimum value: 0. The unit of textHaloWidth is in pixels.
getter/setter pair
textHaloWidthExpression ↔ List<Object>?
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. Default value: 0. Minimum value: 0. The unit of textHaloWidth is in pixels.
getter/setter pair
textIgnorePlacement ↔ bool?
If true, other symbols can be visible even if they collide with the text. Default value: false.
getter/setter pair
textIgnorePlacementExpression ↔ List<Object>?
If true, other symbols can be visible even if they collide with the text. Default value: false.
getter/setter pair
textJustify ↔ TextJustify?
Text justification options. Default value: "center".
getter/setter pair
textJustifyExpression ↔ List<Object>?
Text justification options. Default value: "center".
getter/setter pair
textKeepUpright ↔ bool?
If true, the text may be flipped vertically to prevent it from being rendered upside-down. Default value: true.
getter/setter pair
textKeepUprightExpression ↔ List<Object>?
If true, the text may be flipped vertically to prevent it from being rendered upside-down. Default value: true.
getter/setter pair
textLetterSpacing ↔ double?
Text tracking amount. Default value: 0. The unit of textLetterSpacing is in ems.
getter/setter pair
textLetterSpacingExpression ↔ List<Object>?
Text tracking amount. Default value: 0. The unit of textLetterSpacing is in ems.
getter/setter pair
textLineHeight ↔ double?
Text leading value for multi-line text. Default value: 1.2. The unit of textLineHeight is in ems.
getter/setter pair
textLineHeightExpression ↔ List<Object>?
Text leading value for multi-line text. Default value: 1.2. The unit of textLineHeight is in ems.
getter/setter pair
textMaxAngle ↔ double?
Maximum angle change between adjacent characters. Default value: 45. The unit of textMaxAngle is in degrees.
getter/setter pair
textMaxAngleExpression ↔ List<Object>?
Maximum angle change between adjacent characters. Default value: 45. The unit of textMaxAngle is in degrees.
getter/setter pair
textMaxWidth ↔ double?
The maximum line width for text wrapping. Default value: 10. Minimum value: 0. The unit of textMaxWidth is in ems.
getter/setter pair
textMaxWidthExpression ↔ List<Object>?
The maximum line width for text wrapping. Default value: 10. Minimum value: 0. The unit of textMaxWidth is in ems.
getter/setter pair
textOcclusionOpacity ↔ double?
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
getter/setter pair
textOcclusionOpacityExpression ↔ List<Object>?
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
getter/setter pair
textOffset ↔ 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. Default value: 0,0. The unit of textOffset is in ems.
getter/setter pair
textOffsetExpression ↔ List<Object>?
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. The unit of textOffset is in ems.
getter/setter pair
textOpacity ↔ double?
The opacity at which the text will be drawn. Default value: 1. Value range: 0, 1
getter/setter pair
textOpacityExpression ↔ List<Object>?
The opacity at which the text will be drawn. Default value: 1. Value range: 0, 1
getter/setter pair
textOptional ↔ bool?
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not. Default value: false.
getter/setter pair
textOptionalExpression ↔ List<Object>?
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not. Default value: false.
getter/setter pair
textPadding ↔ double?
Size of the additional area around the text bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0. The unit of textPadding is in pixels.
getter/setter pair
textPaddingExpression ↔ List<Object>?
Size of the additional area around the text bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0. The unit of textPadding is in pixels.
getter/setter pair
textPitchAlignment ↔ TextPitchAlignment?
Orientation of text when map is pitched. Default value: "auto".
getter/setter pair
textPitchAlignmentExpression ↔ List<Object>?
Orientation of text when map is pitched. Default value: "auto".
getter/setter pair
textRadialOffset ↔ 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. Default value: 0. The unit of textRadialOffset is in ems.
getter/setter pair
textRadialOffsetExpression ↔ List<Object>?
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. The unit of textRadialOffset is in ems.
getter/setter pair
textRotate ↔ double?
Rotates the text clockwise. Default value: 0. The unit of textRotate is in degrees.
getter/setter pair
textRotateExpression ↔ List<Object>?
Rotates the text clockwise. Default value: 0. The unit of textRotate is in degrees.
getter/setter pair
textRotationAlignment ↔ TextRotationAlignment?
In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto".
getter/setter pair
textRotationAlignmentExpression ↔ List<Object>?
In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto".
getter/setter pair
textSize ↔ double?
Font size. Default value: 16. Minimum value: 0. The unit of textSize is in pixels.
getter/setter pair
textSizeExpression ↔ List<Object>?
Font size. Default value: 16. Minimum value: 0. The unit of textSize is in pixels.
getter/setter pair
textSizeScaleRange ↔ List<double?>?
Limits the possible scaling range for text-size, text-halo-width, text-halo-blur properties to be within min-scale, max-scale Default value: 0.8,2. Minimum value: 0.1,0.1. Maximum value: 10,10.
getter/setter pair
textSizeScaleRangeExpression ↔ List<Object>?
Limits the possible scaling range for text-size, text-halo-width, text-halo-blur properties to be within min-scale, max-scale Default value: 0.8,2. Minimum value: 0.1,0.1. Maximum value: 10,10.
getter/setter pair
textTransform ↔ TextTransform?
Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".
getter/setter pair
textTransformExpression ↔ List<Object>?
Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".
getter/setter pair
textTranslate ↔ 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. Default value: 0,0. The unit of textTranslate is in pixels.
getter/setter pair
textTranslateAnchor ↔ TextTranslateAnchor?
Controls the frame of reference for text-translate. Default value: "map".
getter/setter pair
textTranslateAnchorExpression ↔ List<Object>?
Controls the frame of reference for text-translate. Default value: "map".
getter/setter pair
textTranslateExpression ↔ List<Object>?
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. The unit of textTranslate is in pixels.
getter/setter pair
textVariableAnchor ↔ 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. Known issue: at the moment having both appearances and text-variable-anchor in the same layer doesn't work correctly.
getter/setter pair
textVariableAnchorExpression ↔ List<Object>?
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. Known issue: at the moment having both appearances and text-variable-anchor in the same layer doesn't work correctly.
getter/setter pair
textWritingMode ↔ 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.
getter/setter pair
textWritingModeExpression ↔ List<Object>?
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.
getter/setter pair
visibility ↔ Visibility?
The visibility of the layer.
getter/setter pairinherited
visibilityExpression ↔ List<Object>?
The visibility of the layer.
getter/setter pairinherited

Methods

getType() → String
Get the type of current layer as a String.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

decode(String properties) → SymbolLayer