Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathOptions

Hierarchy

Index

Properties

Optional className

className: string

Custom class name set on an element.

Default value: ''.

Optional clickable

clickable: boolean

If false, the vector will not emit mouse events and will act as a part of the underlying map.

Default value: true.

Optional color

color: string

Stroke color.

Default value: '#03f'.

Optional dashArray

dashArray: string

A string that defines the stroke dash pattern. Doesn't work on canvas-powered layers (e.g. Android 2).

Optional fill

fill: boolean

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

Optional fillColor

fillColor: string

Fill color.

Default value: same as color.

Optional fillOpacity

fillOpacity: number

Fill opacity.

Default value: 0.2.

Optional lineCap

lineCap: string

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

Default: null.

Optional lineJoin

lineJoin: string

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

Default: null.

Optional opacity

opacity: number

Stroke opacity.

Default value: 0.5.

Optional pointerEvents

pointerEvents: boolean

Sets the pointer-events attribute on the path if SVG backend is used.

Optional stroke

stroke: boolean

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

Default value: true.

Optional weight

weight: number

Stroke width in pixels.

Default value: 5.