Polygon(rings)

The polygon class contains logic relating to polygons. A polygon is an area defined by a closed ring of locations. A simple polygon consists of an array of Location objects that form a boundary. This is useful for showing an area of interest on a map.

In some applications there may be a need to for more complex polygons, such as polygons that have a hole in them.

The first array of locations in a polygon represent the main border and is often called the exterior ring. All additional arrays of locations in a polygon are used to represent holes in the main polygon and are often called interior rings.

When creating a polygon at least one array of Location objects must be passed as an argument to the constructor. An array of Location arrays can be passed in when creating complex polygons. Learn more about how to implement polygons in our Polygon tutorial.

Constructor

# new Polygon(rings)

Parameters:

Name	Type	Description
`rings`	Array.<Array.<Location>>	Array of array locations (rings) Location objects Array of linear rings that define the polygon. The first linear ring of the array defines the outer-boundary or surface of the polygon. Each subsequent linear ring defines a hole in the surface of the polygon. A linear ring is an array of vertices' coordinates where the first coordinate and the last are equivalent.

Tutorials:

Polygon

Example

Create simple Polygon

const polygon = new Vexcel.Geometry.Polygon([
[
      new Vexcel.Geometry.Location(32.36140331527543, -84.44091796875),
      new Vexcel.Geometry.Location(32.36140331527543, -82.529296875),
      new Vexcel.Geometry.Location(33.87041555094183, -82.529296875),
      new Vexcel.Geometry.Location(33.87041555094183, -84.44091796875),
      new Vexcel.Geometry.Location(32.36140331527543, -84.44091796875),
  ]
 ]);

Classes

Polygon

Methods

# clone() → (non-null) {Polygon}

Make a complete copy of the polygon.

Returns:

Clone.

Type: Polygon

# getArea() → {number}

Return the area of the polygon on projected plane.

Returns:

Area (on projected plane).

Type: number

# getLocations() → {Array.<Array.<Location>>}

Return array of Location

Returns:

array with location object with latitude and longitude

Type: Array.<Array.<Location>>

# setLocations(rings)

Update polygon rings

Parameters:

Name	Type	Description
`rings`	Array.<Array.<Location>>	Array of array locations (rings) Location objects Array of linear rings that define the polygon. The first linear ring of the array defines the outer-boundary or surface of the polygon. Each subsequent linear ring defines a hole in the surface of the polygon. A linear ring is an array of vertices' coordinates where the first coordinate and the last are equivalent.

# toGeoJSON() → {string}

Convert geometry to GeoJSON string with xy coordinates [long, lat]

Returns:

Type: string

# toWKT() → {string}

Convert geometry to WKT string with xy coordinates [long, lat]

Returns:

Type: string