tldraw SDK

Table of contents

area
bounds
center
debugColor
ignore
isClosed
isFilled
isLabel
length
vertices
Properties
Methods

abstract class Geometry2d {}

Constructor

Constructs a new instance of the Geometry2d class

Parameters

Name	Description
`opts`	`Geometry2dOptions`

Properties

area

readonly

get area(): number

bounds

readonly

get bounds(): Box

center

readonly

get center(): Vec

debugColor

optional

debugColor?: string

ignore

optional

ignore?: boolean

isClosed

isClosed: boolean

isFilled

isFilled: boolean

isLabel

isLabel: boolean

length

readonly

get length(): number

vertices

readonly

get vertices(): Vec[]

Methods

distanceToLineSegment()

distanceToLineSegment(A: Vec, B: Vec): number

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`

Returns

number

distanceToPoint()

distanceToPoint(point: Vec, hitInside?: boolean): number

Parameters

Name	Description
`point`	`Vec`
`hitInside`	`boolean`

Returns

number

getArea()

getArea(): number

getBounds()

getBounds(): Box

getLength()

getLength(): number

getSvgPathData()

abstract getSvgPathData(first: boolean): string

Parameters

Name	Description
`first`	`boolean`

Returns

string

getVertices()

abstract getVertices(): Vec[]

hitTestLineSegment()

hitTestLineSegment(A: Vec, B: Vec, distance?: number): boolean

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`
`distance`	`number`

Returns

boolean

hitTestPoint()

hitTestPoint(point: Vec, margin?: number, hitInside?: boolean): boolean

Parameters

Name	Description
`point`	`Vec`
`margin`	`number`
`hitInside`	`boolean`

Returns

boolean

isPointInBounds()

isPointInBounds(point: Vec, margin?: number): boolean

Parameters

Name	Description
`point`	`Vec`
`margin`	`number`

Returns

boolean

nearestPoint()

abstract nearestPoint(point: Vec): Vec

Parameters

Name	Description
`point`	`Vec`

Returns

Vec

nearestPointOnLineSegment()

nearestPointOnLineSegment(A: Vec, B: Vec): Vec

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`

Returns

Vec

toSimpleSvgPath()

toSimpleSvgPath(): string