SymbolLayer class

An icon or a text label.

Inheritance

• Object
• Layer
• SymbolLayer

Constructors

SymbolLayer({required dynamic id, dynamic visibility, dynamic minZoom, dynamic maxZoom, required String sourceId, String? sourceLayer, bool? iconAllowOverlap, IconAnchor? iconAnchor, bool? iconIgnorePlacement, String? iconImage, bool? iconKeepUpright, List<double?>? iconOffset, bool? iconOptional, double? iconPadding, IconPitchAlignment? iconPitchAlignment, double? iconRotate, IconRotationAlignment? iconRotationAlignment, double? iconSize, IconTextFit? iconTextFit, List<double?>? iconTextFitPadding, bool? symbolAvoidEdges, SymbolPlacement? symbolPlacement, double? symbolSortKey, double? symbolSpacing, SymbolZOrder? symbolZOrder, bool? textAllowOverlap, TextAnchor? textAnchor, List<String?>? textFont, bool? textIgnorePlacement, TextJustify? textJustify, bool? textKeepUpright, double? textLetterSpacing, double? textLineHeight, double? textMaxAngle, double? textMaxWidth, List<double?>? textOffset, bool? textOptional, double? textPadding, TextPitchAlignment? textPitchAlignment, double? textRadialOffset, double? textRotate, TextRotationAlignment? textRotationAlignment, double? textSize, TextTransform? textTransform, List<String?>? textVariableAnchor, List<String?>? textWritingMode, int? iconColor, double? iconHaloBlur, int? iconHaloColor, double? iconHaloWidth, double? iconOpacity, List<double?>? iconTranslate, IconTranslateAnchor? iconTranslateAnchor, int? textColor, double? textHaloBlur, int? textHaloColor, double? textHaloWidth, double? textOpacity, List<double?>? textTranslate, TextTranslateAnchor? textTranslateAnchor})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

iconAllowOverlap ↔ bool?

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

getter/setter pair

iconAnchor ↔ IconAnchor?

Part of the icon placed closest to the anchor.

getter/setter pair

iconColor ↔ int?

The color of the icon. This can only be used with sdf icons.

getter/setter pair

iconHaloBlur ↔ double?

Fade out the halo towards the outside.

getter/setter pair

iconHaloColor ↔ int?

The color of the icon's halo. Icon halos can only be used with SDF icons.

getter/setter pair

iconHaloWidth ↔ double?

Distance of halo to the icon outline.

getter/setter pair

iconIgnorePlacement ↔ bool?

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

getter/setter pair

iconImage ↔ String?

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.

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.

getter/setter pair

iconOpacity ↔ double?

The opacity at which the icon will be drawn.

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.

getter/setter pair

iconPadding ↔ double?

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

getter/setter pair

iconPitchAlignment ↔ IconPitchAlignment?

Orientation of icon when map is pitched.

getter/setter pair

iconRotate ↔ double?

Rotates the icon clockwise.

getter/setter pair

iconRotationAlignment ↔ IconRotationAlignment?

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

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.

getter/setter pair

iconTextFit ↔ IconTextFit?

Scales the icon to fit around the associated text.

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.

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.

getter/setter pair

iconTranslateAnchor ↔ IconTranslateAnchor?

Controls the frame of reference for icon-translate.

getter/setter pair

id ↔ String

The ID of the Layer.

getter/setter pair, inherited

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 pair, inherited

minZoom ↔ double?

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

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.

getter/setter pair

symbolPlacement ↔ SymbolPlacement?

Label placement relative to its geometry.

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

symbolSpacing ↔ double?

Distance between two symbol anchors.

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.

getter/setter pair

textAllowOverlap ↔ bool?

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

getter/setter pair

textAnchor ↔ TextAnchor?

Part of the text placed closest to the anchor.

getter/setter pair

textColor ↔ int?

The color with which the text will be drawn.

getter/setter pair

textFont ↔ List<String?>?

Font stack to use for displaying text.

getter/setter pair

textHaloBlur ↔ double?

The halo's fadeout distance towards the outside.

getter/setter pair

textHaloColor ↔ int?

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

getter/setter pair

textHaloWidth ↔ double?

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

getter/setter pair

textIgnorePlacement ↔ bool?

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

getter/setter pair

textJustify ↔ TextJustify?

Text justification options.

getter/setter pair

textKeepUpright ↔ bool?

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

getter/setter pair

textLetterSpacing ↔ double?

Text tracking amount.

getter/setter pair

textLineHeight ↔ double?

Text leading value for multi-line text.

getter/setter pair

textMaxAngle ↔ double?

Maximum angle change between adjacent characters.

getter/setter pair

textMaxWidth ↔ double?

The maximum line width for text wrapping.

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.

getter/setter pair

textOpacity ↔ double?

The opacity at which the text will be drawn.

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.

getter/setter pair

textPadding ↔ double?

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

getter/setter pair

textPitchAlignment ↔ TextPitchAlignment?

Orientation of text when map is pitched.

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.

getter/setter pair

textRotate ↔ double?

Rotates the text clockwise.

getter/setter pair

textRotationAlignment ↔ TextRotationAlignment?

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

getter/setter pair

textSize ↔ double?

Font size.

getter/setter pair

textTransform ↔ TextTransform?

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

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.

getter/setter pair

textTranslateAnchor ↔ TextTranslateAnchor?

Controls the frame of reference for text-translate.

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.

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. The order of elements in an array define priority order for the placement of an orientation variant.

getter/setter pair

visibility ↔ Visibility?

The visibility of the layer.

getter/setter pair, inherited

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