LineLayer class

A stroked line.

Inheritance

• Object
• Layer
• LineLayer

Constructors

LineLayer({required String id, Visibility? visibility, double? minZoom, double? maxZoom, String? slot, required String sourceId, String? sourceLayer, LineCap? lineCap, LineJoin? lineJoin, double? lineMiterLimit, double? lineRoundLimit, double? lineSortKey, double? lineBlur, int? lineBorderColor, double? lineBorderWidth, int? lineColor, List<double?>? lineDasharray, double? lineDepthOcclusionFactor, double? lineEmissiveStrength, double? lineGapWidth, int? lineGradient, double? lineOffset, double? lineOpacity, String? linePattern, List<double?>? lineTranslate, LineTranslateAnchor? lineTranslateAnchor, List<double?>? lineTrimOffset, double? lineWidth})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ String

The ID of the Layer.

getter/setter pair, inherited

lineBlur ↔ double?

Blur applied to the line, in pixels.

getter/setter pair

lineBorderColor ↔ int?

The color of the line border. If line-border-width is greater than zero and the alpha value of this color is 0 (default), the color for the border will be selected automatically based on the line color.

getter/setter pair

lineBorderWidth ↔ double?

The width of the line border. A value of zero means no border.

getter/setter pair

lineCap ↔ LineCap?

The display of line endings.

getter/setter pair

lineColor ↔ int?

The color with which the line will be drawn.

getter/setter pair

lineDasharray ↔ List<double?>?

Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.

getter/setter pair

lineDepthOcclusionFactor ↔ double?

Decrease line layer opacity based on occlusion from 3D objects. Value 0 disables occlusion, value 1 means fully occluded.

getter/setter pair

lineEmissiveStrength ↔ double?

Controls the intensity of light emitted on the source features.

getter/setter pair

lineGapWidth ↔ double?

Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.

getter/setter pair

lineGradient ↔ int?

A gradient used to color a line feature at various distances along its length. Defined using a step or interpolate expression which outputs a color for each corresponding line-progress input value. line-progress is a percentage of the line feature's total length as measured on the webmercator projected coordinate plane (a number between 0 and 1). Can only be used with GeoJSON sources that specify "lineMetrics": true.

getter/setter pair

lineJoin ↔ LineJoin?

The display of lines when joining.

getter/setter pair

lineMiterLimit ↔ double?

Used to automatically convert miter joins to bevel joins for sharp angles.

getter/setter pair

lineOffset ↔ double?

The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

getter/setter pair

lineOpacity ↔ double?

The opacity at which the line will be drawn.

getter/setter pair

linePattern ↔ String?

Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

getter/setter pair

lineRoundLimit ↔ double?

Used to automatically convert round joins to miter joins for shallow angles.

getter/setter pair

lineSortKey ↔ double?

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

getter/setter pair

lineTranslate ↔ List<double?>?

The geometry's offset. Values are x, y where negatives indicate left and up, respectively.

getter/setter pair

lineTranslateAnchor ↔ LineTranslateAnchor?

Controls the frame of reference for line-translate.

getter/setter pair

lineTrimOffset ↔ List<double?>?

The line part between trim-start, trim-end will be marked as transparent to make a route vanishing effect. The line trim-off offset is based on the whole line range 0.0, 1.0.

getter/setter pair

lineWidth ↔ double?

Stroke thickness.

getter/setter pair

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

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

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) → LineLayer