Class LineString

A LineString geometry contains a number of LatLngs.

Access by calling const {Data} = await google.maps.importLibrary("maps"). See https://developers.google.com/maps/documentation/javascript/libraries.

Hierarchy

LineString

Implements

Geometry

Index

Constructors

constructor

Methods

Constructors

constructor

new LineString(elements: (LatLng | LatLngLiteral)[]): LineString

A LineString geometry contains a number of LatLngs.

Access by calling const {Data} = await google.maps.importLibrary("maps"). See https://developers.google.com/maps/documentation/javascript/libraries.

Parameters
- elements: (LatLng | LatLngLiteral)[]
Returns LineString

Methods

forEachLatLng

forEachLatLng(callback: ((a: LatLng) => void)): void

Implementation of Geometry.forEachLatLng

Repeatedly invokes the given function, passing a point from the geometry to the function on each invocation.

Parameters
- callback: ((a: LatLng) => void)
  - - (a: LatLng): void
    - Parameters
      - a: LatLng
      Returns void
Returns void

getArray

getArray(): LatLng[]

Returns an array of the contained LatLngs. A new array is returned each time getArray() is called.

Returns LatLng[]

getAt

getAt(n: number): LatLng

Returns the n-th contained LatLng.

Parameters
- n: number
Returns LatLng

getLength

getLength(): number

Returns the number of contained LatLngs.

Returns number

getType

getType(): string

Implementation of Geometry.getType

Returns the string "LineString".

Returns string

Generated using TypeDoc