Options
All
  • Public
  • Public/Protected
  • All
Menu

A Polygon geometry contains a number of Data.LinearRings. The first linear-ring must be the polygon exterior boundary and subsequent linear-rings must be interior boundaries, also known as holes. See the sample polygon with a hole.

Hierarchy

  • Polygon

Implements

Index

Constructors

constructor

  • A Polygon geometry contains a number of Data.LinearRings. The first linear-ring must be the polygon exterior boundary and subsequent linear-rings must be interior boundaries, also known as holes. See the sample polygon with a hole.

    Parameters

    Returns Polygon

Methods

forEachLatLng

  • forEachLatLng(callback: (a: LatLng) => void): void
  • Repeatedly invokes the given function, passing a point from the geometry to the function on each invocation.

    Parameters

    Returns void

getArray

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

    Returns LinearRing[]

getAt

  • Returns the n-th contained Data.LinearRing.

    Parameters

    • n: number

    Returns LinearRing

getLength

  • getLength(): number
  • Returns the number of contained Data.LinearRings.

    Returns number

getType

  • getType(): string
  • Returns the string "Polygon".

    Returns string

Generated using TypeDoc