Options
All
  • Public
  • Public/Protected
  • All
Menu

PolylineOptions object used to define the properties that can be set on a Polyline.

Hierarchy

  • PolylineOptions

Index

Properties

Optional clickable

clickable?: null | boolean

Indicates whether this Polyline handles mouse events.

defaultvalue

true

Optional draggable

draggable?: null | boolean

If set to true, the user can drag this shape over the map. The geodesic property defines the mode of dragging.

defaultvalue

false

Optional editable

editable?: null | boolean

If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.

defaultvalue

false

Optional geodesic

geodesic?: null | boolean

When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the surface of the earth.

defaultvalue

false

Optional icons

icons?: null | IconSequence[]

The icons to be rendered along the polyline.

Optional map

map?: null | Map

Map on which to display Polyline.

Optional path

path?: null | (LatLng | LatLngLiteral)[] | MVCArray<LatLng>

The ordered sequence of coordinates of the Polyline. This path may be specified using either a simple array of LatLngs, or an MVCArray of LatLngs. Note that if you pass a simple array, it will be converted to an MVCArray Inserting or removing LatLngs in the MVCArray will automatically update the polyline on the map.

Optional strokeColor

strokeColor?: null | string

The stroke color. All CSS3 colors are supported except for extended named colors.

Optional strokeOpacity

strokeOpacity?: null | number

The stroke opacity between 0.0 and 1.0.

Optional strokeWeight

strokeWeight?: null | number

The stroke width in pixels.

Optional visible

visible?: null | boolean

Whether this polyline is visible on the map.

defaultvalue

true

Optional zIndex

zIndex?: null | number

The zIndex compared to other polys.

Generated using TypeDoc