Rect

Defined in: geometry/Rect.ts:7

A 2D rectangle defined by position (x, y) and size (width, height).

Constructors

Constructor

new Rect(x, y, width, height): Rect

Defined in: geometry/Rect.ts:13

Parameters

x

number

y

number

width

number

height

number

Returns

Rect

Properties

height

height: number

Defined in: geometry/Rect.ts:11

---

width

width: number

Defined in: geometry/Rect.ts:10

---

x

x: number

Defined in: geometry/Rect.ts:8

---

y

y: number

Defined in: geometry/Rect.ts:9

Accessors

bottom

Get Signature

get bottom(): number

Defined in: geometry/Rect.ts:194

Get the bottom edge y coordinate.

Returns

number

---

bottomLeft

Get Signature

get bottomLeft(): object

Defined in: geometry/Rect.ts:134

Get the bottom-left corner.

Returns

object

x

x: number

y

y: number

---

bottomRight

Get Signature

get bottomRight(): object

Defined in: geometry/Rect.ts:139

Get the bottom-right corner.

Returns

object

x

x: number

y

y: number

---

center

Get Signature

get center(): object

Defined in: geometry/Rect.ts:144

Get the center point.

Returns

object

x

x: number

y

y: number

---

centerX

Get Signature

get centerX(): number

Defined in: geometry/Rect.ts:149

GoJS-compatible: The x coordinate of the center of this rect.

Returns

number

---

centerY

Get Signature

get centerY(): number

Defined in: geometry/Rect.ts:154

GoJS-compatible: The y coordinate of the center of this rect.

Returns

number

---

left

Get Signature

get left(): number

Defined in: geometry/Rect.ts:179

Get the left edge x coordinate.

Returns

number

---

position

Get Signature

get position(): Point

Defined in: geometry/Rect.ts:159

GoJS-compatible: The position (top-left) as a Point.

Returns

Point

Set Signature

set position(pos): void

Defined in: geometry/Rect.ts:163

Parameters

pos

Point

Returns

void

---

right

Get Signature

get right(): number

Defined in: geometry/Rect.ts:184

Get the right edge x coordinate.

Returns

number

---

size

Get Signature

get size(): Size

Defined in: geometry/Rect.ts:169

GoJS-compatible: The size as a Size.

Returns

Size

Set Signature

set size(size): void

Defined in: geometry/Rect.ts:173

Parameters

size

Size

Returns

void

---

top

Get Signature

get top(): number

Defined in: geometry/Rect.ts:189

Get the top edge y coordinate.

Returns

number

---

topLeft

Get Signature

get topLeft(): object

Defined in: geometry/Rect.ts:124

Get the top-left corner.

Returns

object

x

x: number

y

y: number

---

topRight

Get Signature

get topRight(): object

Defined in: geometry/Rect.ts:129

Get the top-right corner.

Returns

object

x

x: number

y

y: number

Methods

area()

area(): number

Defined in: geometry/Rect.ts:199

Get the area.

Returns

number

---

clone()

clone(): Rect

Defined in: geometry/Rect.ts:69

Return a copy of this rect.

Returns

Rect

---

computeSides()

computeSides(margin): Rect

Defined in: geometry/Rect.ts:91

GoJS-compatible: Inset the rect on all sides by a margin value or {left,top,right,bottom}.

Parameters

margin

number | { bottom: number; left: number; right: number; top: number; }

Returns

Rect

---

containsPoint()

containsPoint(point): boolean

Defined in: geometry/Rect.ts:214

Check if this rect contains a point.

Parameters

point

x

number

y

number

Returns

boolean

---

containsRect()

containsRect(other): boolean

Defined in: geometry/Rect.ts:224

Check if this rect contains another rect.

Parameters

other

Rect

Returns

boolean

---

copy()

copy(): Rect

Defined in: geometry/Rect.ts:74

GoJS-compatible: Return a copy of this rect.

Returns

Rect

---

deflate()

deflate(dx, dy?): Rect

Defined in: geometry/Rect.ts:290

Shrink this rect by the given margin on all sides.

Parameters

dx

number

dy?

number

Returns

Rect

---

equals()

equals(other): boolean

Defined in: geometry/Rect.ts:49

Check if this rect equals another rect.

Parameters

other

Rect

Returns

boolean

---

equalsApprox()

equalsApprox(other, tolerance?): boolean

Defined in: geometry/Rect.ts:59

Check if this rect is approximately equal to another within a tolerance.

Parameters

other

Rect

tolerance?

number = 0.0001

Returns

boolean

---

grow()

grow(s): Rect

Defined in: geometry/Rect.ts:271

GoJS-compatible: Expand this rect by the given amount on all sides.

Parameters

s

number

Returns

Rect

---

inflate()

inflate(dx, dy?): Rect

Defined in: geometry/Rect.ts:265

Expand this rect by the given margin on all sides.

Parameters

dx

number

dy?

number

Returns

Rect

---

intersection()

intersection(other): Rect | null

Defined in: geometry/Rect.ts:244

Get the intersection of this rect with another rect.

Parameters

other

Rect

Returns

Rect | null

---

intersects()

intersects(other): boolean

Defined in: geometry/Rect.ts:234

Check if this rect intersects another rect.

Parameters

other

Rect

Returns

boolean

---

isEmpty()

isEmpty(): boolean

Defined in: geometry/Rect.ts:209

Check if this rect is empty (zero width or height).

Returns

boolean

---

isReal()

isReal(): boolean

Defined in: geometry/Rect.ts:79

GoJS-compatible: Whether the rect has finite, non-negative dimensions.

Returns

boolean

---

offset()

offset(dx, dy): Rect

Defined in: geometry/Rect.ts:295

Offset this rect by the given amounts.

Parameters

dx

number

dy

number

Returns

Rect

---

perimeter()

perimeter(): number

Defined in: geometry/Rect.ts:204

Get the perimeter.

Returns

number

---

relativeTo()

relativeTo(spot): Point

Defined in: geometry/Rect.ts:107

GoJS-compatible: Compute the point in this rect for the given spot.

Parameters

spot

offsetX

number

offsetY

number

x

number

y

number

Returns

Point

---

setTo()

setTo(x, y, width, height): this

Defined in: geometry/Rect.ts:115

GoJS-compatible: In-place mutation returning this rect.

Parameters

x

number

y

number

width

number

height

number

Returns

this

---

setToPosition()

setToPosition(pos): this

Defined in: geometry/Rect.ts:276

GoJS-compatible: In-place mutation of position returning this rect.

Parameters

pos

Point

Returns

this

---

setToSize()

setToSize(size): this

Defined in: geometry/Rect.ts:283

GoJS-compatible: In-place mutation of size returning this rect.

Parameters

size

Size

Returns

this

---

toJSON()

toJSON(): object

Defined in: geometry/Rect.ts:300

Convert to a plain object.

Returns

object

height

height: number

width

width: number

x

x: number

y

y: number

---

toString()

toString(): string

Defined in: geometry/Rect.ts:310

Returns

string

---

union()

union(other): Rect

Defined in: geometry/Rect.ts:256

Get the smallest rect that contains both rects.

Parameters

other

Rect

Returns

Rect

---

fromCorners()

static fromCorners(a, b): Rect

Defined in: geometry/Rect.ts:26

Create a Rect from two corner points.

Parameters

a

Point

b

Point

Returns

Rect

---

fromJSON()

static fromJSON(data): Rect

Defined in: geometry/Rect.ts:305

Create a Rect from a JSON string or object.

Parameters

data

string | { height: number; width: number; x: number; y: number; }

Returns

Rect

---

fromPosAndSize()

static fromPosAndSize(pos, size): Rect

Defined in: geometry/Rect.ts:21

Create a Rect from position and size.

Parameters

pos

Point

size

Size

Returns

Rect

---

parse()

static parse(value): Rect

Defined in: geometry/Rect.ts:40

GoJS-compatible: Parse a string like “x, y, w, h” or “x y w h”.

Parameters

value

string

Returns

Rect

---

zero()

static zero(): Rect

Defined in: geometry/Rect.ts:35

Create a zero rect at origin.

Returns

Rect