Class: SvgPath

Methods

join

▸ Static join(paths, close?, options?): SvgPath

Parameters

Name	Type	Default value	Description
paths	SvgPath[]	undefined
close	boolean	false
options?	SvgPathOptions	undefined

Returns

SvgPath

Defined in

svg/SvgPath.ts:71

---

position

▸ position(pos): SvgPath

Parameters

Name	Type	Description
pos	number

Returns

SvgPath

Defined in

svg/SvgPath.ts:100

▸ position(): number

Returns

number

Defined in

svg/SvgPath.ts:101

---

remove

▸ remove(count): SvgPath

Parameters

Name	Type	Description
count	number

Returns

SvgPath

Defined in

svg/SvgPath.ts:116

---

move

▸ move(x, y, relative?, data?): SvgPath

Parameters

Name	Type	Default value	Description
x	number	undefined
y	number	undefined
relative	boolean	false
data?	SegmentData	undefined

Returns

SvgPath

Defined in

svg/SvgPath.ts:129

---

line

▸ line(x, y, relative?, data?): SvgPath

Parameters

Name	Type	Default value	Description
x	number	undefined
y	number	undefined
relative	boolean	false
data?	SegmentData	undefined

Returns

SvgPath

Defined in

svg/SvgPath.ts:152

---

curve

▸ curve(x1, y1, x2, y2, x, y, relative?, data?): SvgPath

Parameters

Name	Type	Default value	Description
x1	number	undefined
y1	number	undefined
x2	number	undefined
y2	number	undefined
x	number	undefined
y	number	undefined
relative	boolean	false
data?	SegmentData	undefined

Returns

SvgPath

Defined in

svg/SvgPath.ts:179

---

arc

▸ arc(rx, ry, xAr, lAf, sf, x, y, relative?, data?): SvgPath

Parameters

Name	Type	Default value	Description
rx	number	undefined
ry	number	undefined
xAr	number	undefined
lAf	number	undefined
sf	number	undefined
x	number	undefined
y	number	undefined
relative	boolean	false
data?	SegmentData	undefined

Returns

SvgPath

Defined in

svg/SvgPath.ts:220

---

parse

▸ parse(path): SvgPath

Parameters

Name	Type	Description
path	string

Returns

SvgPath

Defined in

svg/SvgPath.ts:255

---

stringify

▸ stringify(): string

Returns

string

Defined in

svg/SvgPath.ts:304

---

scale

▸ scale(x, y): SvgPath

Parameters

Name	Type	Description
x	number
y	number

Returns

SvgPath

Defined in

svg/SvgPath.ts:330

---

translate

▸ translate(x, y): SvgPath

Parameters

Name	Type	Description
x	number
y	number

Returns

SvgPath

Defined in

svg/SvgPath.ts:343

---

transform

▸ transform(transformFnc): SvgPath

Parameters

Name	Type	Description
transformFnc	<T>(cmd: PathCommand<T>, param: keyof T, cmdIndex: number, paramIndex: number, cmds: PathCommand<T>[]) => number | void

Returns

SvgPath

Defined in

svg/SvgPath.ts:360

---

clone

▸ clone(close?): SvgPath

Parameters

Name	Type	Default value	Description
close	boolean	false

Returns

SvgPath

Defined in

svg/SvgPath.ts:391

---

splitByCommand

▸ splitByCommand(command): SvgPath[]

Parameters

Name	Type	Description
command	string

Returns

SvgPath[]

Defined in

svg/SvgPath.ts:405

Properties

pathElements

• pathElements: PathCommand<PathParams>[] = []

Defined in

svg/SvgPath.ts:82

---

pos

• Private pos: number = 0

Defined in

svg/SvgPath.ts:83

---

options

• Private options: Required<SvgPathOptions>

Defined in

svg/SvgPath.ts:84

Constructors

constructor

• new SvgPath(close?, options?)

Parameters

Name	Type	Default value	Description
close	boolean	false
options?	SvgPathOptions	undefined

Defined in

svg/SvgPath.ts:91