@technobuddha > library > Geometry > Rectangle

Function: toSquare()

function toSquare(rect: Rect): Rect;

Defined in: to-square.ts:23

Converts a Rect to the largest possible square that fits within it, centered along the longer dimension. If the rectangle is already a square, it returns the original rectangle.

Parameters

Parameter	Type	Description
rect	Rect	The Rect.

Returns

Rect

A square shaped Rect.

Example

toSquare({ x: 1, y: 2, width: 6, height: 4 });
// { x: 2, y: 2, width: 4, height: 4 }

toSquare({ x: 1, y: 2, width: 3, height: 7 });
// { x: 1, y: 4, width: 3, height: 3 }

toSquare({ x: 0, y: 0, width: 5, height: 5 });
// { x: 0, y: 0, width: 5, height: 5 }