Skip to content

@technobuddha > library > Geometry > Polygon

Function: bounds()

ts
function bounds(vertices: Polygon): Rect;

Defined in: bounds.ts:21

Calculates the axis-aligned bounding rectangle for a given polygon.

Parameters

ParameterTypeDescription
verticesPolygonThe polygon.

Returns

Rect

A Rect representing the smallest rectangle that contains the polygon.

Throws

TypeError If the polygon has fewer than three vertices.

Example

typescript
bounds([
  { x: 0, y: 0 },
  { x: 0, y: 5 },
  { x: 10, y: 5 },
  { x: 10, y: 0 },
]);
// { x: 0, y: 0, width: 10, height: 5 }