Box • tldraw Docs

Table of contents

aspectRatio
bottom
center
corners
cornersAndCenter
h
height
left
maxX
maxY
midX
midY
minX
minY
point
right
sides
size
top
w
width
x
y
Properties
Methods
- Collides
- Common
- Contains
- ContainsApproximately
- ContainsPoint
- Equals
- Expand
- ExpandBy
- From
- FromCenter
- FromPoints
- Includes
- Resize
- Sides
- ZeroFix
- clone
- collides
- contains
- containsPoint
- equals
- expand
- expandBy
- getHandlePoint
- includes
- isValid
- resize
- scale
- set
- setTo
- snapToGrid
- toFixed
- toJson
- translate
- union
- zeroFix

class Box {}

Constructor

Constructs a new instance of the Box class

Parameters

Name	Description
`x`	`number;`
`y`	`number;`
`w`	`number;`
`h`	`number;`

Properties

aspectRatio

readonly

get aspectRatio(): number;

bottom

readonly

get bottom(): number;

center

get center(): Vec;

set center(v: Vec);

corners

readonly

get corners(): Vec[];

cornersAndCenter

readonly

get cornersAndCenter(): Vec[];

h

h: number;

height

get height(): number;

set height(n: number);

left

readonly

get left(): number;

maxX

readonly

get maxX(): number;

maxY

readonly

get maxY(): number;

midX

readonly

get midX(): number;

midY

readonly

get midY(): number;

minX

get minX(): number;

set minX(n: number);

minY

get minY(): number;

set minY(n: number);

point

get point(): Vec;

set point(val: Vec);

right

readonly

get right(): number;

sides

readonly

get sides(): Array<[Vec, Vec]>;

size

readonly

get size(): Vec;

top

readonly

get top(): number;

w

w: number;

width

get width(): number;

set width(n: number);

x

x: number;

y

y: number;

Methods

Collides( )

static

static Collides(A: Box, B: Box): boolean;

Parameters

Name	Description
`A`	`Box;`
`B`	`Box;`

Returns

boolean;

Common( )

static

static Common(boxes: Box[]): Box;

Parameters

Name	Description
`boxes`	`Box[];`

Returns

Box;

Contains( )

static

static Contains(A: Box, B: Box): boolean;

Parameters

Name	Description
`A`	`Box;`
`B`	`Box;`

Returns

boolean;

ContainsApproximately( )

static

static ContainsApproximately(A: Box, B: Box, precision?: number): boolean;

Parameters

Name	Description
`A`	`Box;`
`B`	`Box;`
`precision`	`number;`

Returns

boolean;

ContainsPoint( )

static

static ContainsPoint(A: Box, B: VecLike, margin?: number): boolean;

Parameters

Name	Description
`A`	`Box;`
`B`	`VecLike;`
`margin`	`number;`

Returns

boolean;

Equals( )

static

static Equals(a: Box | BoxModel, b: Box | BoxModel): boolean;

Parameters

Name	Description
`a`	`Box \| BoxModel;`
`b`	`Box \| BoxModel;`

Returns

boolean;

Expand( )

static

static Expand(A: Box, B: Box): Box;

Parameters

Name	Description
`A`	`Box;`
`B`	`Box;`

Returns

Box;

ExpandBy( )

static

static ExpandBy(A: Box, n: number): Box;

Parameters

Name	Description
`A`	`Box;`
`n`	`number;`

Returns

Box;

From( )

static

static From(box: BoxModel): Box;

Parameters

Name	Description
`box`	`BoxModel;`

Returns

Box;

FromCenter( )

static

static FromCenter(center: VecLike, size: VecLike): Box;

Parameters

Name	Description
`center`	`VecLike;`
`size`	`VecLike;`

Returns

Box;

FromPoints( )

static

static FromPoints(points: VecLike[]): Box;

Parameters

Name	Description
`points`	`VecLike[];`

Returns

Box;

Includes( )

static

static Includes(A: Box, B: Box): boolean;

Parameters

Name	Description
`A`	`Box;`
`B`	`Box;`

Returns

boolean;

Resize( )

static

static Resize(
  box: Box,
  handle: SelectionCorner | SelectionEdge | string,
  dx: number,
  dy: number,
  isAspectRatioLocked?: boolean,
): {
  box: Box;
  scaleX: number;
  scaleY: number;
};

Parameters

Name	Description
`box`	`Box;`
`handle`	`SelectionCorner \| SelectionEdge \| string;`
`dx`	`number;`
`dy`	`number;`
`isAspectRatioLocked`	`boolean;`

Returns

{
  box: Box;
  scaleX: number;
  scaleY: number;
};

Sides( )

static

static Sides(A: Box, inset?: number): Vec[][];

Parameters

Name	Description
`A`	`Box;`
`inset`	`number;`

Returns

Vec[][];

ZeroFix( )

static

static ZeroFix(other: Box | BoxModel): Box;

Parameters

Name	Description
`other`	`Box \| BoxModel;`

Returns

Box;

clone( )

clone(): Box;

collides( )

collides(B: Box): boolean;

Parameters

Name	Description
`B`	`Box;`

Returns

boolean;

contains( )

contains(B: Box): boolean;

Parameters

Name	Description
`B`	`Box;`

Returns

boolean;

containsPoint( )

containsPoint(V: VecLike, margin?: number): boolean;

Parameters

Name	Description
`V`	`VecLike;`
`margin`	`number;`

Returns

boolean;

equals( )

equals(other: Box | BoxModel): boolean;

Parameters

Name	Description
`other`	`Box \| BoxModel;`

Returns

boolean;

expand( )

expand(A: Box): this;

Parameters

Name	Description
`A`	`Box;`

Returns

this;

expandBy( )

expandBy(n: number): this;

Parameters

Name	Description
`n`	`number;`

Returns

this;

getHandlePoint( )

getHandlePoint(handle: SelectionCorner | SelectionEdge): Vec;

Parameters

Name	Description
`handle`	`SelectionCorner \| SelectionEdge;`

Returns

Vec;

includes( )

includes(B: Box): boolean;

Parameters

Name	Description
`B`	`Box;`

Returns

boolean;

isValid( )

isValid(): boolean;

resize( )

resize(
  handle: SelectionCorner | SelectionEdge | string,
  dx: number,
  dy: number,
): void;

Parameters

Name	Description
`handle`	`SelectionCorner \| SelectionEdge \| string;`
`dx`	`number;`
`dy`	`number;`

Returns

void;

scale( )

scale(n: number): this;

Parameters

Name	Description
`n`	`number;`

Returns

this;

set( )

set(x?: number, y?: number, w?: number, h?: number): this;

Parameters

Name	Description
`x`	`number;`
`y`	`number;`
`w`	`number;`
`h`	`number;`

Returns

this;

setTo( )

setTo(B: Box): this;

Parameters

Name	Description
`B`	`Box;`

Returns

this;

snapToGrid( )

snapToGrid(size: number): void;

Parameters

Name	Description
`size`	`number;`

Returns

void;

toFixed( )

toFixed(): this;

toJson( )

toJson(): BoxModel;

translate( )

translate(delta: VecLike): this;

Parameters

Name	Description
`delta`	`VecLike;`

Returns

this;

union( )

union(box: BoxModel): this;

Parameters

Name	Description
`box`	`BoxModel;`

Returns

this;

zeroFix( )

zeroFix(): this;