box

Creates a rectangular Polygon geometry from bounding box coordinates.

Polygon is oriented clockwise.

Type Parameters

• P

Parameters

Name	Type	Description
bbox	number[]	Array of four numbers [ xMin, yMin, xMax, yMax ]
options?	object	Optional geometry options
options.id?	number | string	Optional identifier to be assigned to the geometry instance.
options.properties?	P	Optional data to be assigned to the geometry instance.

Returns

Polygon<P>

A new Polygon geometry

Throws

• GEOSError when box is degenerated: width or height is 0

See also

• bounds calculates bounding box of an existing geometry

Examples

const a = box([ 0, 0, 4, 4 ]); // <POLYGON ((0 0, 0 4, 4 4, 4 0, 0 0))>
const b = box([ 5, 0, 8, 1 ]); // <POLYGON ((5 0, 5 1, 8 1, 8 0, 5 0))>

const a = box([ 0, 0, 4, 4 ]); // <POLYGON ((0 0, 0 4, 4 4, 4 0, 0 0))> const b = box([ 5, 0, 8, 1 ]); // <POLYGON ((5 0, 5 1, 8 1, 8 0, 5 0))>