PolylineOptions | MapGL | 2GIS Documentation
MapGL JS API

PolylineOptions

Polyline initialization options.

Properties
undefinedstring

The line color in hexadecimal RGB (#ff0000) or RGBA (#ff0000ff) format.

undefinedstring

The second line color in hexadecimal RGB (#ff0000) or RGBA (#ff0000ff) format.

[DEPRECATED] Will be removed in the next major release, use additional Polyline to draw an extra line with a different color.

undefinedstring

The third line color in hexadecimal RGB (#ff0000) or RGBA (#ff0000ff) format.

[DEPRECATED] Will be removed in the next major release, use additional Polyline to draw an extra line with a different color.

number[][]

An array of polyline coordinates: [firstPoint, secondPoint, ...]. Each point is a geographical point: [longitude, latitude].

The length of the dash in pixels. If no dash length is specified, a polyline will be drawn.

undefinedstring

The gap color in hexadecimal RGB (#ff0000) or RGBA (#ff0000ff) format.

The length of the gap in pixels. The default gap length is equal to the dash length.

undefinedstring

The color of a line section that is hidden by other objects in '3d' rendering mode in RGB hexadecimal (#ff0000) or RGBA (#ff0000ff) format.

undefinedstring

The gap color of a line section that is hidden by other objects in '3d' rendering mode in RGB hexadecimal (#ff0000) or RGBA (#ff0000ff) format.

undefinedfalsetrue

Allows the polyline to emit events (like mouseover). true by default.

undefinednumber

Maximum display styleZoom.

undefinednumber

Minimum display styleZoom.

Rendering mode. '2d' is default.

any

User specific data.

The line width in pixels.

The second line width in pixels.

[DEPRECATED] Will be removed in the next major release, use additional Polyline to draw an extra line with a different width.

The third line width in pixels.

[DEPRECATED] Will be removed in the next major release, use additional Polyline to draw an extra line with a different width.

undefinednumber

Draw order of the first line.

undefinednumber

Draw order of second line.

[DEPRECATED] Will be removed in the next major release, use additional Polyline to draw an extra line with a different zIndex.

undefinednumber

Draw order of third line.

[DEPRECATED] Will be removed in the next major release, use additional Polyline to draw an extra line with a different zIndex.