Module: ol/geom/Polygon

ol/geom/Polygon


Classes

Polygon

Methods

module:ol/geom/Polygon.circular(center, radius, opt_n, opt_sphereRadius){module:ol/geom/Polygon~Polygon}

geom/Polygon.js, line 348
import {circular} from 'ol/geom/Polygon';

Create an approximation of a circle on the surface of a sphere.

Name Type Description
center module:ol/coordinate~Coordinate

Center ([lon, lat] in degrees).

radius number

The great-circle distance from the center to the polygon vertices.

n number

Optional number of vertices for the resulting polygon. Default is 32.

sphereRadius number

Optional radius for the sphere (defaults to the Earth's mean radius using the WGS84 ellipsoid).

Returns:
The "circular" polygon.

module:ol/geom/Polygon.fromCircle(circle, opt_sides, opt_angle){module:ol/geom/Polygon~Polygon}

geom/Polygon.js, line 386
import {fromCircle} from 'ol/geom/Polygon';

Create a regular polygon from a circle.

Name Type Description
circle module:ol/geom/Circle~Circle

Circle geometry.

sides number

Number of sides of the polygon. Default is 32.

angle number

Start angle for the first vertex of the polygon in radians. Default is 0.

Returns:
Polygon geometry.

module:ol/geom/Polygon.fromExtent(extent){module:ol/geom/Polygon~Polygon}

geom/Polygon.js, line 366
import {fromExtent} from 'ol/geom/Polygon';

Create a polygon from an extent. The layout used is XY.

Name Type Description
extent module:ol/extent~Extent

The extent.

Returns:
The polygon.