Skip to content

Class: Rect ​

Defined in: src/helpers/geometry.ts:4

Constructors ​

Constructor ​

ts
new Rect(
   x0, 
   y0, 
   x1, 
   y1): Rect;

Defined in: src/helpers/geometry.ts:5

Parameters ​

x0 ​

number

y0 ​

number

x1 ​

number

y1 ​

number

Returns ​

Rect

Properties ​

x0 ​

ts
x0: number;

Defined in: src/helpers/geometry.ts:6


x1 ​

ts
x1: number;

Defined in: src/helpers/geometry.ts:8


y0 ​

ts
y0: number;

Defined in: src/helpers/geometry.ts:7


y1 ​

ts
y1: number;

Defined in: src/helpers/geometry.ts:9

Accessors ​

area ​

Get Signature ​

ts
get area(): number;

Defined in: src/helpers/geometry.ts:48

Returns ​

number


br ​

Get Signature ​

ts
get br(): Point;

Defined in: src/helpers/geometry.ts:36

Returns ​

Point


height ​

Get Signature ​

ts
get height(): number;

Defined in: src/helpers/geometry.ts:24

Returns ​

number


irect ​

Get Signature ​

ts
get irect(): Rect;

Defined in: src/helpers/geometry.ts:39

Returns ​

Rect


isEmpty ​

Get Signature ​

ts
get isEmpty(): boolean;

Defined in: src/helpers/geometry.ts:27

Returns ​

boolean


isValid ​

Get Signature ​

ts
get isValid(): boolean;

Defined in: src/helpers/geometry.ts:30

Returns ​

boolean


tl ​

Get Signature ​

ts
get tl(): Point;

Defined in: src/helpers/geometry.ts:33

Returns ​

Point


width ​

Get Signature ​

ts
get width(): number;

Defined in: src/helpers/geometry.ts:21

Returns ​

number

Methods ​

addDelta() ​

ts
addDelta(
   dx0, 
   dy0, 
   dx1, 
   dy1): Rect;

Defined in: src/helpers/geometry.ts:118

Parameters ​

dx0 ​

number

dy0 ​

number

dx1 ​

number

dy1 ​

number

Returns ​

Rect


clone() ​

ts
clone(): Rect;

Defined in: src/helpers/geometry.ts:136

Returns ​

Rect


contains() ​

ts
contains(o): boolean;

Defined in: src/helpers/geometry.ts:52

Parameters ​

o ​

BBox | Rect | readonly number[] | Point | Pt

Returns ​

boolean


equals() ​

ts
equals(o): boolean;

Defined in: src/helpers/geometry.ts:131

Parameters ​

o ​

BBox | Rect

Returns ​

boolean


inflate() ​

ts
inflate(d): Rect;

Defined in: src/helpers/geometry.ts:114

Parameters ​

d ​

number

Returns ​

Rect


intersect() ​

ts
intersect(o): Rect;

Defined in: src/helpers/geometry.ts:81

Parameters ​

o ​

BBox | Rect | readonly number[]

Returns ​

Rect


intersects() ​

ts
intersects(o): boolean;

Defined in: src/helpers/geometry.ts:75

Parameters ​

o ​

BBox | Rect | readonly number[]

Returns ​

boolean


normalize() ​

ts
normalize(): Rect;

Defined in: src/helpers/geometry.ts:122

Returns ​

Rect


toString() ​

ts
toString(): string;

Defined in: src/helpers/geometry.ts:144

Returns ​

string


toTuple() ​

ts
toTuple(): BBox;

Defined in: src/helpers/geometry.ts:140

Returns ​

BBox


union() ​

ts
union(o): Rect;

Defined in: src/helpers/geometry.ts:92

Parameters ​

o ​

BBox | Rect | readonly number[]

Returns ​

Rect


unionInPlace() ​

ts
unionInPlace(o): this;

Defined in: src/helpers/geometry.ts:104

Parameters ​

o ​

BBox | Rect | readonly number[]

Returns ​

this


empty() ​

ts
static empty(): Rect;

Defined in: src/helpers/geometry.ts:17

Returns ​

Rect


from() ​

ts
static from(a): Rect;

Defined in: src/helpers/geometry.ts:12

Parameters ​

a ​

BBox | Rect | readonly number[]

Returns ​

Rect

AGPL-3.0-or-later — inherited from PyMuPDF and pymupdf4llm.