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
Defined in
position
▸ position(pos
): SvgPath
Parameters
Name | Type | Description |
---|---|---|
pos | number |
Returns
Defined in
▸ position(): number
Returns
number
Defined in
remove
▸ remove(count
): SvgPath
Parameters
Name | Type | Description |
---|---|---|
count | number |
Returns
Defined in
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
Defined in
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
Defined in
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
Defined in
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
Defined in
parse
▸ parse(path
): SvgPath
Parameters
Name | Type | Description |
---|---|---|
path | string |
Returns
Defined in
stringify
▸ stringify(): string
Returns
string
Defined in
scale
▸ scale(x
, y
): SvgPath
Parameters
Name | Type | Description |
---|---|---|
x | number | |
y | number |
Returns
Defined in
translate
▸ translate(x
, y
): SvgPath
Parameters
Name | Type | Description |
---|---|---|
x | number | |
y | number |
Returns
Defined in
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
Defined in
clone
▸ clone(close?
): SvgPath
Parameters
Name | Type | Default value | Description |
---|---|---|---|
close | boolean | false |
Returns
Defined in
splitByCommand
▸ splitByCommand(command
): SvgPath
[]
Parameters
Name | Type | Description |
---|---|---|
command | string |
Returns
SvgPath
[]
Defined in
Properties
pathElements
• pathElements: PathCommand
<PathParams
>[] = []
Defined in
pos
• Private
pos: number
= 0
Defined in
options
• Private
options: Required
<SvgPathOptions
>
Defined in
Constructors
constructor
• new SvgPath(close?
, options?
)
Parameters
Name | Type | Default value | Description |
---|---|---|---|
close | boolean | false | |
options? | SvgPathOptions | undefined |