tldraw SDK

Table of contents

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

Extends Geometry2d.

class Polyline2d extends Geometry2d {}

Constructor

Constructs a new instance of the Polyline2d class

Parameters

Name	Description
`config`	`Omit< Geometry2dOptions, 'isClosed' \| 'isFilled' > & { points: Vec[] }`

Properties

area

readonly

from Geometry2d

get area(): number

bounds

readonly

from Geometry2d

get bounds(): Box

center

readonly

from Geometry2d

get center(): Vec

debugColor

optional

from Geometry2d

debugColor?: string

ignore

optional

from Geometry2d

ignore?: boolean

isClosed

from Geometry2d

isClosed: boolean

isFilled

from Geometry2d

isFilled: boolean

isLabel

from Geometry2d

isLabel: boolean

length

readonly

from Geometry2d

get length(): number

points

points: Vec[]

segments

readonly

get segments(): Edge2d[]

vertices

readonly

from Geometry2d

get vertices(): Vec[]

Methods

distanceToLineSegment()

from Geometry2d

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

Parameters

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

Returns

number

distanceToPoint()

from Geometry2d

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

Parameters

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

Returns

number

getArea()

from Geometry2d

getArea(): number

getBounds()

from Geometry2d

getBounds(): Box

getLength()

getLength(): number

getSvgPathData()

getSvgPathData(): string

getVertices()

getVertices(): Vec[]

hitTestLineSegment()

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

Parameters

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

Returns

boolean

hitTestPoint()

from Geometry2d

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

Parameters

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

Returns

boolean

isPointInBounds()

from Geometry2d

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

Parameters

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

Returns

boolean

nearestPoint()

nearestPoint(A: Vec): Vec

Parameters

Name	Description
`A`	`Vec`

Returns

Vec

nearestPointOnLineSegment()

from Geometry2d

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

Parameters

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

Returns

Vec

toSimpleSvgPath()

from Geometry2d

toSimpleSvgPath(): string