On this page

Path2D

A 2D path.

Constructor

new Path2D(points)

Creates a new Path2D with the given points.

Parameters:

Name	Type	Description
`points`	Array.<Point2D>	The points of the path.

Source: pkg/index.js, line 2985

Classes

Path2D

Members

cubic_bezier_tuples

Returns a CubicBezierTuple at a given index.

Source: pkg/index.js, line 3204

first

Gets the first point of the Path2D.

Source: pkg/index.js, line 3233

is_empty

Returns whether the Path2D is empty.

Source: pkg/index.js, line 3068

last

Gets the last point of the Path2D.

Source: pkg/index.js, line 3241

len

Returns the length of the Path2D.

Source: pkg/index.js, line 3086

points

Returns the Point2Ds of the Path2D.

Source: pkg/index.js, line 3049

points

Sets the Point2Ds of the Path2D.

Source: pkg/index.js, line 3059

Methods

clear()

Removes all Point2Ds from the Path2D.

Source: pkg/index.js, line 3148

clone() → {Path2D}

Clones the Path2D.

Source: pkg/index.js, line 3032

Returns:

Type:: Path2D

closest_point(point) → {Point2D}

Returns the closest Point2D in the Path2D to a given Point2D.

Parameters:

Name	Type	Description
`point`	Point2D	The point to find the closest point to.

Source: pkg/index.js, line 3077

Returns:

The closest point in the path.

Type:: Point2D

get(index) → {Point2D}

Returns the Point2D at a given index.

Parameters:

Name	Type	Description
`index`	number	The index of the point.

Source: pkg/index.js, line 3095

Returns:

The first point of the path.

Type:: Point2D

insert(index, point)

Inserts a Point2D at a given index.

Parameters:

Name	Type	Description
`index`	number	The index to insert the point at.
`point`	Point2D	The point to insert.

Source: pkg/index.js, line 3131

length(samples_per_cubicopt, extra_length_per_cubicopt) → {number}

Returns an approximation of the length of the path, based on sampling points along each cubic bezier curve in the path and an optional extra length to add to each approximation.

Parameters:

Name	Type	Attributes	Description
`samples_per_cubic`	number \| null	<optional>	The number of samples to take along each cubic bezier curve.
`extra_length_per_cubic`	number \| null	<optional>	An optional extra length to add to each cubic bezier length approximation.

Source: pkg/index.js, line 3225

Returns:

An approximation of the length of the path.

Type:: number

partial_bezier_path(a, b) → {Path2D}

Returns a new Path2D representing a bezier curve portion of the Path2D.

Parameters:

Name	Type	Description
`a`	number	The start proportion of the input path. A number between 0 and 1.
`b`	number	The end proportion of the input path. A number between 0 and 1.

Source: pkg/index.js, line 3157

Returns:

A Path2D object representing the portion of the input path.

Type:: Path2D

pop() → {Point2D|undefined}

Removes the last Point2D from the Path2D.

Source: pkg/index.js, line 3122

Returns:

The last point of the path.

Type:: Point2D | undefined

push(point)

Appends a Point2D to the Path2D.

Parameters:

Name	Type	Description
`point`	Point2D	The point to append.

Source: pkg/index.js, line 3113

push_bezier(cubic_bezier)

Appends a CubicBezierTuple to the Path2D.

Parameters:

Name	Type	Description
`cubic_bezier`	CubicBezierTuple	The cubic bezier tuple to add.

Source: pkg/index.js, line 3214

remove(index) → {Point2D}

Removes a Point2D at a given index.

Parameters:

Name	Type	Description
`index`	number	The index of the point to remove.

Source: pkg/index.js, line 3141

Returns:

The removed point.

Type:: Point2D

repeat(count) → {Path2D}

Repeats the Path2D a given number of times.

Parameters:

Name	Type	Description
`count`	number	The number of times to repeat the path.

Source: pkg/index.js, line 3041

Returns:

The repeated path.

Type:: Path2D

reverse()

Reverse the Path2D.

Source: pkg/index.js, line 3176

set(index, point)

Sets the Point2D at the given index.

Parameters:

Name	Type	Description
`index`	number	The index of the point.
`point`	Point2D	The new point.

Source: pkg/index.js, line 3104

set_slice(start, end, path)

Sets a slice of the Path2D.

Parameters:

Name	Type	Description
`start`	number	The start index of the slice.
`end`	number	The end index of the slice.
`path`	Path2D	The new path.

Source: pkg/index.js, line 3185

slice(start, end) → {Path2D}

Returns a slice of the Path2D

Parameters:

Name	Type	Description
`start`	number	The start index of the slice.
`end`	number	The end index of the slice.

Source: pkg/index.js, line 3196

Returns:

A slice of the path.

Type:: Path2D

(static) fill(point, count) → {Path2D}

Creates a new Path2D by filling the Path2D with a given Point2D a given number of times.

Parameters:

Name	Type	Description
`point`	Point2D	The point to fill the path with.
`count`	number	The number of times to fill the path with the point.

Source: pkg/index.js, line 3167

Returns:

A path that is a portion of the input path.

Type:: Path2D

(static) from_anchors_and_handles(anchors_and_handles) → {Path2D}

Creates a new Path2D given a AnchorsAndHandles object.

Parameters:

Name	Type	Description
`anchors_and_handles`	AnchorsAndHandles	The AnchorsAndHandles object.

Source: pkg/index.js, line 3023

Returns:

A 2D path.

Type:: Path2D