LiveMap API
Loading...
Searching...
No Matches
livemap.layer.marker.options.PathOptions Class Reference

A set of options shared between vector overlays
(Polygon, Polyline, Circle, etc.). More...

Inheritance diagram for livemap.layer.marker.options.PathOptions:
Collaboration diagram for livemap.layer.marker.options.PathOptions:

Properties

bool? Stroke [get, set]
 Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles.
Color? Color [get, set]
 Stroke color.
int? Weight [get, set]
 Stroke width, in pixels.
Opacity? Opacity [get, set]
 Stroke opacity.
string? LineCap [get, set]
 A string that defines shape to be used at the end of the stroke.
string? LineJoin [get, set]
 A string that defines shape to be used at the corners of the stroke.
string? DashArray [get, set]
 A string that defines the stroke dash pattern.
string? DashOffset [get, set]
 A string that defines the distance into the dash pattern to start the dash.
bool? Fill [get, set]
 Whether to fill the path with color. Set it to false to disable filling on polygons or circles.
ColorFillColor [get, set]
 Fill color.
OpacityFillOpacity [get, set]
 Fill opacity.
string? FillRule [get, set]
 A string that defines how the inside of a shape is determined.
Properties inherited from livemap.layer.marker.options.InteractiveLayerOptions
bool? BubblingMouseEvents [get, set]
 When true, a mouse event on this marker will trigger the same event on the map.
bool? Interactive [get, set]
 If false, this marker will not emit mouse events and will act as a part of the underlying map.
Properties inherited from livemap.layer.marker.options.LayerOptions
string? Pane [get, set]
 Map pane where this marker will be added.
string? Attribution [get, set]
 String to be shown in the attribution control.

Detailed Description

A set of options shared between vector overlays
(Polygon, Polyline, Circle, etc.).

Do not use it directly

Property Documentation

◆ Color

Color? livemap.layer.marker.options.PathOptions.Color
getset

Stroke color.

Defaults to 0x3388FF if not set

◆ DashArray

string? livemap.layer.marker.options.PathOptions.DashArray
getset

A string that defines the stroke dash pattern.

Defaults to null if not set

MDN Web Docs

◆ DashOffset

string? livemap.layer.marker.options.PathOptions.DashOffset
getset

A string that defines the distance into the dash pattern to start the dash.

Defaults to null if not set

MDN Web Docs

◆ Fill

bool? livemap.layer.marker.options.PathOptions.Fill
getset

Whether to fill the path with color. Set it to false to disable filling on polygons or circles.

Defaults to true if not set, except for Polyline

◆ FillColor

Color? livemap.layer.marker.options.PathOptions.FillColor
getset

Fill color.

Defaults to the value of the Color option if not set

◆ FillOpacity

Opacity? livemap.layer.marker.options.PathOptions.FillOpacity
getset

Fill opacity.

Defaults to 0.2 (0x33) if not set

◆ FillRule

string? livemap.layer.marker.options.PathOptions.FillRule
getset

A string that defines how the inside of a shape is determined.

Defaults to "evenodd" if not set

MDN Web Docs

◆ LineCap

string? livemap.layer.marker.options.PathOptions.LineCap
getset

A string that defines shape to be used at the end of the stroke.

Defaults to "round" if not set

MDN Web Docs

◆ LineJoin

string? livemap.layer.marker.options.PathOptions.LineJoin
getset

A string that defines shape to be used at the corners of the stroke.

Defaults to "round" if not set

MDN Web Docs

◆ Opacity

Opacity? livemap.layer.marker.options.PathOptions.Opacity
getset

Stroke opacity.

Defaults to 1.0 (0xFF) if not set

◆ Stroke

bool? livemap.layer.marker.options.PathOptions.Stroke
getset

Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles.

Defaults to true if not set

◆ Weight

int? livemap.layer.marker.options.PathOptions.Weight
getset

Stroke width, in pixels.

Defaults to 3 if not set


The documentation for this class was generated from the following file: