@baku89/pave - v0.4.1 / Path

Namespace: Path

Functions for manipulating paths represented as Path.

Classes

• Pen

Interfaces

• CircleFromPointsOptions
• DistortOptions
• FormulaOptions
• OffsetOptions
• OffsetStrokeOptions
• ReverseOptions
• SpawnOptions

Primitives

arc

▸ arc(center, radius, startAngle, endAngle, options?): Path

Creates an arc path.

Parameters

Name	Type	Description
center	vec2	The center of the arc
radius	number	The radius of the arc
startAngle	number	The start angle in radians
endAngle	number	The end angle in radians
options	ArcOptions	-

Returns

Path

The newly created path

Example

Defined in

Path.ts:527

---

arcByPoints

▸ arcByPoints(start, through, end): Path

Creates an arc path from the given three points. If the points are collinear, it will create a straight line path.

Parameters

Name	Type	Description
start	vec2	The start point
through	vec2	The point that the arc passes through
end	vec2	The end point

Returns

Path

The newly created path

Defined in

Path.ts:572

---

arcByPointsAngle

▸ arcByPointsAngle(start, end, angle): Path<Vertex>

Creates an arc path from two points and an angle.

Parameters

Name	Type	Description
start	vec2	The start point
end	vec2	The end point
angle	number	The angle of arc in degrees. If the angle is positive, the arc will be drawn in the sweep direction (clockwise in Y-down coordinate system).

Returns

Path<Vertex>

The newly created path

Defined in

Path.ts:678

---

arcByPointsTangent

▸ arcByPointsTangent(start, startTangent, end): Path

Creates an arc path from start point, start tangent, and end point.

Parameters

Name	Type	Description
start	vec2	The start point
startTangent	vec2	The tangent at the start point
end	vec2	The end point

Returns

Path

A newly created open arc path

Defined in

Path.ts:643

---

circle

▸ circle(center, radius): Path

Creates a circle path from the given center and radius.

Parameters

Name	Type	Description
center	vec2	The center of the circle
radius	number	The radius of the circle

Returns

Path

The newly created path

Example

Defined in

Path.ts:292

---

circleFromPoints

▸ circleFromPoints(p1, p2?, p3?, «destructured»?): Path

Creates a circle path which passes through the given points.

Parameters

Name	Type	Description
p1	vec2	The first point
p2?	null | vec2	The second point
p3?	null | vec2	The third point
«destructured»	CircleFromPointsOptions	-

Returns

Path

The circle path, whose first point matches to p1. After duplicating points are removed, if there are only one point, creates a circle with zero radius. For two points, creates a circle from the two points as the diameter. Otherwise, creates a circle that passes through the three points.

Example

Defined in

Path.ts:370

---

cubicBezier

▸ cubicBezier(start, control1, control2, point): Path

Creates a path consisting of a single C command.

Parameters

Name	Type	Description
start	vec2	The start point
control1	vec2	The first control point
control2	vec2	The second control point
point	vec2	The end point

Returns

Path

The newly created path

Defined in

Path.ts:925

---

dot

▸ dot(point): PathL

Creates a “dot“ path, which consists of only a M command to the specified point followed by Z command. This will be rendered only if the lineCap of the drawing context is set to 'round' or 'square'.

Parameters

Name	Type	Description
point	vec2	The center point of the dot

Returns

PathL

The newly created paths

Example

Defined in

Path.ts:792

---

ellipse

▸ ellipse(center, radius): Path

Creates an ellipse path from the given center and radius.

Parameters

Name	Type	Description
center	vec2	The center of the ellipse
radius	vec2	The radius of the ellipse

Returns

Path

The newly created path

Example

Defined in

Path.ts:467

---

empty

• Const empty: Path

Empty path.

Defined in

Path.ts:158

---

fan

▸ fan(center, innerRadius, outerRadius, startAngle, endAngle): Path

Creates a fan path.

Parameters

Name	Type	Description
center	vec2	The center of the fan
innerRadius	number	The inner radius of the fan
outerRadius	number	The outer radius of the fan
startAngle	number	The start angle in radians
endAngle	number	The end angle in radians

Returns

Path

The newly created path

Example

Defined in

Path.ts:742

---

formula

▸ formula(f, iter, «destructured»?): Path

Creates a path from the given formula, which maps a parameter t to a point. The tangent will be automatically calculated by the derivative function, which is computed using Euler’s method with given delta. If the formula has cusps, you need to appropriately specify the range to put t at the cusp.

Parameters

Name	Type	Description
f	(t: number) => vec2	The formula to create the path
iter	Iterable<number>	-
«destructured»	FormulaOptions	-

Returns

Path

The newly created path

Defined in

Path.ts:1062

---

fromSegment

▸ fromSegment(segment): Path

Creates an open path consist of only a single command.

Parameters

Name	Type	Description
segment	Segment	The segment to create

Returns

Path

The newly created path

Defined in

Path.ts:1019

---

grid

▸ grid(rect, divs): PathL

Parameters

Name	Type
rect	Rect
divs	vec2

Returns

PathL

Defined in

Path.ts:885

---

halfLine

▸ halfLine(point, through, distance?): Path

Creates a half-line, infinite line in one direction from a starting point and a point that the line passes through. It is not actually an inifinite, but one with a very large length.

Parameters

Name	Type	Default value	Description
point	vec2	undefined	The starting point
through	vec2	undefined	The point that the line passes through
distance	number	1e8	The length of the half-line

Returns

Path

The half-line path

Defined in

Path.ts:335

---

infiniteLine

▸ infiniteLine(point0, point1, distance?): Path

Creates an infinite line path from the given two points. Unlike line, the line will be drawn nearly infinitely in both directions.

Parameters

Name	Type	Default value	Description
point0	vec2	undefined	The first point
point1	vec2	undefined	The second point
distance	number	1e8	The length of the infinite line for each direction

Returns

Path

The infinite line path

Defined in

Path.ts:316

---

line

▸ line(start, end): PathL

Creates a linear path from two points describing a line.

Parameters

Name	Type	Description
start	vec2	The line’s starting point
end	vec2	The line’s ending point

Returns

PathL

The newly created path

Example

Defined in

Path.ts:767

---

nBezier

▸ nBezier(points): Path<Vertex>

Create a path consisting of cubic Bézier curves approximating the arbitrary higher-order Bézier curve.

Parameters

Name	Type	Description
points	vec2[]	The control points of the Bézier curve

Returns

Path<Vertex>

The newly created path

Defined in

Path.ts:968

---

ngon

▸ ngon(center, radius, sides): PathL

Alias for regularPolygon

Parameters

Name	Type
center	vec2
radius	number
sides	number

Returns

PathL

Defined in

Path.ts:880

---

polygon

▸ polygon(...points): PathL

Creates a closed polyline from the given points.

Parameters

Name	Type	Description
...points	vec2[]	The points describing the polygon

Returns

PathL

The newly created path

Example

Defined in

Path.ts:836

---

polyline

▸ polyline(...points): PathL

Creates a open polyline from the given points.

Parameters

Name	Type	Description
...points	vec2[]	The points describing the polygon

Returns

PathL

The newly created path

Example

Defined in

Path.ts:814

---

quadraticBezier

▸ quadraticBezier(start, control, point): Path

Creates a quadratic Bézier curve path from the given points.

Parameters

Name	Type	Description
start	vec2	The start point
control	vec2	The control point
point	vec2	The end point

Returns

Path

THe newly created path

Defined in

Path.ts:952

---

rect

▸ rect(start, end): Path

Alias for rectangle

Parameters

Name	Type
start	vec2
end	vec2

Returns

Path

Defined in

Path.ts:194

---

rectFromCenter

▸ rectFromCenter(center, size): Path

Creates a rectangle path from the given center and size.

Parameters

Name	Type	Description
center	vec2	The center of the rectangle
size	vec2	The size of the rectangle

Returns

Path

The newly created path

Defined in

Path.ts:203

---

rectangle

▸ rectangle(start, end): Path

Creates a rectangle path from the given two points.

Parameters

Name	Type	Description
start	vec2	The first point defining the rectangle
end	vec2	The second point defining the rectangle

Returns

Path

The newly created path

Example

Defined in

Path.ts:174

---

regularPolygon

▸ regularPolygon(center, radius, sides): PathL

Creates a regular polygon. The first vertex will be placed at the +X axis relative to the center.

Parameters

Name	Type	Description
center	vec2	The center of the polygon
radius	number	The radius of the circumcircle of the polygon
sides	number	The number o sides of the polygon

Returns

PathL

The newly created path

Example

Defined in

Path.ts:860

---

roundRect

▸ roundRect(start, end, radii): Path

Creates a rounded rectangle. The arguments are almost the same as the CanvasRenderingContext2D’s roundRect method.

Parameters

Name	Type
start	vec2
end	vec2
radii	number | [allCorner: number] | [topLeftAndBottomRight: number, topRightAndBottomLeft: number] | [topLeft: number, topRightAndBottomLeft: number, bottomRight: number] | [topLeft: number, topRight: number, bottomRight: number, bottomLeft: number]

Returns

Path

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/roundRect

Defined in

Path.ts:215

---

semicircle

▸ semicircle(start, end, closed?): Path

Creates a semicircle path from the given start and end points.

Parameters

Name	Type	Default value
start	vec2	undefined
end	vec2	undefined
closed	boolean	true

Returns

Path

Defined in

Path.ts:300

Properties

area

▸ area(arg): number

Calculates an area of the given path.

Parameters

Name	Type
arg	Path<Vertex>

Returns

number

The area of the path

Defined in

Path.ts:1142

---

bounds

▸ bounds(arg): Rect

Calculates the bound of the given path.

Parameters

Name	Type
arg	Path<Vertex>

Returns

Rect

The rect of the path

Example

Defined in

Path.ts:1132

---

derivative

▸ derivative(path, loc): vec2

Calculates the normalized tangent vector of the path at the given location.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to calcuate
loc	PathLocation	-

Returns

vec2

The tangent vector

Defined in

Path.ts:1376

---

length

▸ length(arg): number

Returns the length of the given path. The returned value is memoized.

Parameters

Name	Type
arg	Path<Vertex>

Returns

number

The length of the path

Defined in

Path.ts:1102

---

normal

▸ normal(path, loc): vec2

Calculates the normalized tangent vector of the path at the given location.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to calcuate
loc	PathLocation	-

Returns

vec2

The tangent vector

Defined in

Path.ts:1400

---

orientation

▸ orientation(path, loc): mat2d

Calculates the transformation matrix of the path at the given location. The x-axis of the matrix is the tangent vector and the y-axis is the normal vector, and the translation is the point on the path.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to calculate
loc	PathLocation	-

Returns

mat2d

The transformation matrix at the given offset

Defined in

Path.ts:1412

---

point

▸ point(path, loc): vec2

Calculates the position on the path at the given location.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to calculate
loc	PathLocation	The location on the path

Returns

vec2

The position at the given offset

Defined in

Path.ts:1364

---

segment

▸ segment(path, curveIndex, segmentIndex?): Segment

Returns the segment of the path by indices. If the segmentIndex is omitted, the curveIndex is treated as the linear segment index of the whole path. It also supports negative indices, which count from the end of the path or curve.

Parameters

Name	Type	Description
path	Path<Vertex>	The path that contains the segment
curveIndex	number	The index of the curve.
segmentIndex?	number	The index of the segment in the curve.

Returns

Segment

The segment

Defined in

Path.ts:1167

---

segmentCount

▸ segmentCount(arg): number

Returns the count of segments in the given path.

Parameters

Name	Type
arg	Path<Vertex>

Returns

number

The count of segments in the path

Defined in

Path.ts:1152

---

segments

▸ segments(arg): Segment[]

Returns all segmentse

Parameters

Name	Type
arg	Path<Vertex>

Returns

Segment[]

Defined in

Path.ts:2154

---

tangent

▸ tangent(path, loc): vec2

Calculates the normalized tangent vector of the path at the given location.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to calcuate
loc	PathLocation	-

Returns

vec2

The tangent vector

Defined in

Path.ts:1388

Modifiers

distort

▸ distort(path, transform, «destructured»?): Path<Vertex>

Distorts path by the given transformation function. It assumes that the continuity of transformation is smooth in the spatial domain and has no singularities or cusps.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to distort
transform	(position: vec2) => mat2d	The distort function that maps a point coordinate to a transformation matrix. The translation component is absolute, and affects points of Bézier curves. The rotation, scaling, and skewing components affect the orientation of two handles.
«destructured»	DistortOptions	-

Returns

Path<Vertex>

The newly created path

Example

Defined in

Path.ts:1975

---

flatten

▸ flatten(path, flatness?): Path

Flattens the curves in path to straight lines.

Parameters

Name	Type	Default value	Description
path	Path<Vertex>	undefined	The path to flatten
flatness	number	0.25	The maximum distance between the path and the flattened path

Returns

Path

The flattened path consists of only M, L, and Z commands

See

http://paperjs.org/reference/path/#flatten

Example

Defined in

Path.ts:1886

---

join

▸ join(paths): Path

Joins the given paths into a single open paths.

Parameters

Name	Type	Description
paths	Path<Vertex>[]	The paths to join

Returns

Path

The joined path

Defined in

Path.ts:1849

---

merge

▸ merge(pathOrCurves): Path

Merges the given paths into a single path. Unlike join or unite, the vertices are not connected, and it simply returns compound path.

Parameters

Name	Type
pathOrCurves	(Curve | Path<Vertex>)[]

Returns

Path

Defined in

Path.ts:1864

---

offset

▸ offset(path, offset, options?): Path

Creates an offset path from the given path.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to offset
offset	number	The width of offset
options?	OffsetOptions	The options

Returns

Path

The newly created path

Example

Defined in

Path.ts:1786

---

offsetStroke

▸ offsetStroke(path, width, options?): Path<Vertex>

Creates an offset path from the given path.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to offset
width	number	The width of stroke
options?	OffsetStrokeOptions	The options

Returns

Path<Vertex>

The newly created path

Example

Defined in

Path.ts:1825

---

reduce

▸ reduce(path, options?): Path

Cleans up the path by removing redundant vertices and

Parameters

Name	Type
path	Path<Vertex>
options	ReduceOptions

Returns

Path

Defined in

Path.ts:2760

---

reverse

▸ reverse(path, options:?): Path

Reverses the given path.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to reverse
options:	ReverseOptions	The options

Returns

Path

The reversed path

Defined in

Path.ts:1626

---

spawn

▸ spawn(path, fn, «destructured»?): Path

Maps each segments in the path to a path and create a new path concatinating those paths.

Parameters

Name	Type
path	Path<Vertex>
fn	(seg: Segment, segmentIndex: number, curve: Curve) => Path<Vertex>
«destructured»	SpawnOptions

Returns

Path

Defined in

Path.ts:1502

---

spawnCurve

▸ spawnCurve<V1, V2>(path, fn): Path<V2>

Maps each curves in the path to a single or array of curves and creates a new path concatinating those curves. Unlike spawnVertex, you can also change the number of curves, or open/close state of the curves.

Type parameters

Name	Type
V1	extends Vertex = Vertex
V2	extends Vertex = Vertex

Parameters

Name	Type	Description
path	Path<V1>	The path to map
fn	(curve: Curve<V1>, curveIndex: number) => Curve<V2> | Curve<V2>[]	The curve mapping function.

Returns

Path<V2>

The newly created path

Defined in

Path.ts:1478

---

spawnVertex

▸ spawnVertex<V1, V2>(path, fn): Path<V2>

Maps each segment in the path to a single or array of vertices and creates a new path concatinating those vertices. you can change the type of commands, and change the number of them in the path, but you cannot change the topology of the path. The segments that were originally continuous remains connected, and vice versa.

Type parameters

Name	Type
V1	extends Vertex = Vertex
V2	extends Vertex = Vertex

Parameters

Name	Type	Description
path	Path<V1>	The path to map
fn	(segment: Segment<V1>, index: number, curve: Curve) => V2 | V2[]	The vertex mapping function. It takes a Segment and returns a single or array of vertices.

Returns

Path<V2>

The newly created path

Defined in

Path.ts:1424

---

split

▸ split(path, locs): Path[]

Splits the path into multiple paths at the given locations.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to split
locs	Iterable<PathLocation>	The locations to split

Returns

Path[]

The splitted paths

Defined in

Path.ts:1932

---

subdivide

▸ subdivide(path, division): Path

Subdivides each segment in the path into specific number of sub-segments.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to subdivide
division	number	The number of division for each segment

Returns

Path

The newly created path

Defined in

Path.ts:1899

---

toCubicBezier

▸ toCubicBezier(path, unarcAngle?): PathC

Converts all commands in the path to cubic Bézier curve commands.

Parameters

Name	Type	Default value	Description
path	Path<Vertex>	undefined	The path to convert
unarcAngle	number	90	The angle step for approximating arc commands with cubic Béziers

Returns

PathC

The new path with only cubic Bézier curve commands

Defined in

Path.ts:1733

---

transform

▸ transform(path, matrix): Path

Transforms the given path by the given matrix.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to transform
matrix	mat2d	The matrix to transform the path by

Returns

Path

The transformed path

Defined in

Path.ts:1589

---

trim

▸ trim(path, from, to, crossFirstPoint?): Path

Trims the path from the given location to the given location.

Parameters

Name	Type	Default value	Description
path	Path<Vertex>	undefined	The path to trim
from	PathLocation	undefined	The start location
to	PathLocation	undefined	The end location
crossFirstPoint	boolean	true	-

Returns

Path

The trimmed path

Defined in

Path.ts:1643

---

unarc

▸ unarc(path, angle?): UnarcPath

Parameters

Name	Type	Default value
path	Path<Vertex>	undefined
angle	number	90

Returns

UnarcPath

Example

Defined in

Path.ts:1716

Boolean Operations

subtract

▸ subtract(subject, tools): Path

Subtracts the tools from the subject.

Parameters

Name	Type	Description
subject	Path<Vertex>	The target path to be subtracted
tools	Path<Vertex>[]	The paths to subtract

Returns

Path

The resulting path

Defined in

Path.ts:2021

---

unite

▸ unite(paths): Path

Unites the given paths.

Parameters

Name	Type	Description
paths	Path<Vertex>[]	The paths to unite

Returns

Path

The resulting path

Defined in

Path.ts:2003

Converters

drawToCanvas

▸ drawToCanvas(path, context): void

Draws the given path to the context. It calls context.beginPath at the beginning, so please note that the sub-paths already stacked on the context are also cleared. Note that you also need to call context.stroke or context.fill to actually draw the path.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to draw
context	CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D	The Canvas context

Returns

void

Defined in

Path.ts:2443

---

fromPaperPath

▸ fromPaperPath(arg): Path<Vertex>

Creates a path from the given paper.Path instance.

Parameters

Name	Type
arg	PathItem

Returns

Path<Vertex>

The newly created path

Paper Path

The paper.Path instance to convert

Defined in

Path.ts:2527

---

fromSVG

▸ fromSVG(commands): Path

Converts an array of SVG commands to a Path.

Parameters

Name	Type	Description
commands	SVGCommand[]	The array of SVG commands

Returns

Path

The newly created path

Defined in

Path.ts:2164

---

fromSVGString

▸ fromSVGString(d): Path

Parses the given d attribute of an SVG path and creates a new path. Internally uses svgpath library.

Parameters

Name	Type	Description
d	string	The d attribute of an SVG path

Returns

Path

The newly created path

Defined in

Path.ts:2041

---

toPaperPath

▸ toPaperPath(arg): Path | CompoundPath

Converts the given path to paper.Path

Parameters

Name	Type
arg	Path<Vertex>

Returns

Path | CompoundPath

The newly created paper.Path instance

See

http://paperjs.org/reference/pathitem/

Defined in

Path.ts:2458

---

toPath2D

▸ toPath2D(arg): Path2D

Creates a Path2D instance with the given path data.

Parameters

Name	Type
arg	Path<Vertex>

Returns

Path2D

The newly created Path2D

Defined in

Path.ts:2429

---

toSVGString

▸ toSVGString(path): string

Converts the given path to a string that can be used as the d attribute of an SVG path element.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to convert

Returns

string

The string for the d attribute of the SVG path element

Defined in

Path.ts:2089

Draw Functions

addVertex

▸ addVertex(path, vertex): Path

Appends the given command to the end of the path.

Parameters

Name	Type	Description
path	Path<Vertex>	The base path
vertex	Vertex	-

Returns

Path

The newely created path

Defined in

Path.ts:2594

---

arcTo

▸ arcTo(path, radii, xAxisRotation, largeArcFlag, sweepFlag, point): Path

Returns the new path with the new A (arc) command at the end.

Parameters

Name	Type	Description
path	Path<Vertex>	The base path
radii	vec2	The radii of the ellipse used to draw the arc
xAxisRotation	number	The rotation angle of the ellipse’s x-axis relative to the x-axis of the current coordinate system, expressed in degrees
largeArcFlag	boolean	The large arc flag. If true, then draw the arc spanning greather than 180 degrees. Otherwise, draw the arc spanning less than 180 degrees.
sweepFlag	boolean	The sweep flag. If true, then draw the arc in a “positive-angle” direction in the current coordinate system. Otherwise, draw it in a “negative-angle” direction.
point	vec2	The end point of the arc

Returns

Path

The newely created path

Defined in

Path.ts:2692

---

close

▸ close(path, «destructured»?): Path

Closes the specified curves

Parameters

Name	Type	Description
path	Path<Vertex>	The base path
«destructured»	PathCloseOptions	-

Returns

Path

The newely created path

Defined in

Path.ts:2730

---

cubicBezierTo

▸ cubicBezierTo(path, control1, control2, point): Path

Returns the new path with the new C (cubic Bézier curve) command at the end.

Parameters

Name	Type	Description
path	Path<Vertex>	The base path
control1	vec2	The first control point
control2	vec2	The second control point
point	vec2	The end point

Returns

Path

The newely created path

Defined in

Path.ts:2639

---

lineTo

▸ lineTo(path, point): Path

Returns the new path with the new L (line-to) command at the end.

Parameters

Name	Type	Description
path	Path<Vertex>	The base path
point	vec2	The point to draw a line to

Returns

Path

The newely created path

Defined in

Path.ts:2626

---

moveTo

▸ moveTo(path, point): Path

Returns the new path with the new M (move-to) command at the end.

Parameters

Name	Type	Description
path	Path<Vertex>	The base path
point	vec2	The point to move to

Returns

Path

The newely created path

Defined in

Path.ts:2574

---

pen

▸ pen(): Pen

Creates a new Path instance to begin drawing a path.

Returns

Pen

Defined in

Path.ts:2776

---

quadraticBezierTo

▸ quadraticBezierTo(path, control, point): Path

Returns the new path with the new Q (quadratic Bézier curve) command at the end.

Parameters

Name	Type	Description
path	Path<Vertex>	The base path
control	vec2	The control point
point	vec2	The end point

Returns

Path

The newely created path

Defined in

Path.ts:2660

Utilities

toTime

▸ toTime(path, location): Required<TimePathLocation> & { segment: Segment }

Retrieves the segment location information from the given path and path-based signed location.

Parameters

Name	Type	Description
path	Path<Vertex>	The path to retrieve the segment location
location	PathLocation	The path-based location

Returns

Required<TimePathLocation> & { segment: Segment }

The information of the segment location

Defined in

Path.ts:1215

---

unlinearSegmentIndex

▸ unlinearSegmentIndex(path, linearSegmentIndex): Object

Converts a signed linear segment index to a pair of curve and unsgined segment index.

Parameters

Name	Type
path	Path<Vertex>
linearSegmentIndex	number

Returns

Object

Name	Type
curveIndex	number
segmentIndex	number

Defined in

Path.ts:1333

Aliases

fromD

▸ fromD(d): Path

Alias for fromSVGString

Parameters

Name	Type
d	string

Returns

Path

Defined in

Path.ts:2081

---

subdiv

▸ subdiv(path, division): Path

Alias for subdivide

Parameters

Name	Type
path	Path<Vertex>
division	number

Returns

Path

Defined in

Path.ts:1923

---

toC

▸ toC(path, unarcAngle?): PathC

Alias for toCubicBezier

Parameters

Name	Type	Default value
path	Path<Vertex>	undefined
unarcAngle	number	90

Returns

PathC

Defined in

Path.ts:1751

---

toD

▸ toD(path): string

Alias for toSVGString

Parameters

Name	Type
path	Path<Vertex>

Returns

string

Defined in

Path.ts:2147

Options

ArcOptions

Ƭ ArcOptions: Object

An options for arc

Type declaration

Name	Type	Description
align?	ResampleOptions["align"]	The alignment of the vertices Default ts 'uniform'
count?	number	The total count of the segments in the arc. If this is specified, the step will be ignored and the arc will be deviced into the specified number of segments uniformly.
step?	number	The maximum angle step in degrees Default 360 - 1e-4

Defined in

Path.ts:496

---

PathCloseOptions

Ƭ PathCloseOptions: Object

An options for close

Type declaration

Name	Type	Description
fuse?	boolean	If true, deletes overwrapped first and last vertices. Default ts true
group?	CurveGroup	Specifies which curves to close. Default is the last curve. Default ts -1

Defined in

Path.ts:2711

---

ReduceOptions

Ƭ ReduceOptions: ReduceOptions & { removeEmptyCurves?: boolean }

An options for reduce

Defined in

Path.ts:2747

---