Constructor
new SVGPathVCommand(y, isRelative)
Create a new SVGPathVCommand object
IMPORTANT: Remember that a VERTICAL LINE command is a shorthand command for a LINE command. As a consequence its
xcoordinate will always be0, but for absolute VERTICAL LINE command it's inacurate and its real value must be computed out of the previous command end point.
Parameters:
| Name | Type | Description |
|---|---|---|
y |
number |
The y coordinate for the command's end point |
isRelative |
boolean |
Indicates if the command is relative or not |
- Source:
Extends
Members
coordinates :SVGCoordinates
Indicate the coordinates of the command end point
- Overrides:
- Source:
isRelative :boolean
Indicate if the command is relative or absolute
- Overrides:
- Source:
x :number
Direct access the the command end point x coordinate
- Overrides:
- Source:
y :number
Direct access the the command end point y coordinate
- Overrides:
- Source:
Methods
(generator) @@iterator()
Implementation of the Iterator protocol.
For the VERTICAL LINE command, the provided iterable will yield, in order:
- The command name (either
'v'or'V') - The
ycoordinate
- Overrides:
- Source:
toAbsolute(origin) → {SVGPathCommand}
Mutate a relative command to make it absolute
Parameters:
| Name | Type | Description |
|---|---|---|
origin |
SVGCoordinates |
The coordinates to resolve the current relative coordinates |
- Overrides:
- Source:
toJSON() → {Array}
Turn the command into a proper JSON representation
A command JSON representation is an Array containing all the components
of the command in the same order as the one defined by the SVG2
specification.
- Overrides:
- Source:
toRelative(origin) → {SVGPathCommand}
Mutate an absolute command to make it relative
Parameters:
| Name | Type | Description |
|---|---|---|
origin |
SVGCoordinates |
The coordinates to be relative to. |
- Overrides:
- Source:
toString() → {string}
Turn the command into a proper string representation
A command string representation is a valid SVG path command string.
- Overrides:
- Source: