Type Definitions
Area
Area object.
{left: number, top: number, right: number, bottom: number}
| Name | Type | Description |
|---|---|---|
left | number | Left coordinate |
top | number | Top coordinate |
right | number | Right coordinate |
bottom | number | Bottom coordinate |
BBox
Bounding box object.
{x: number, y: number, width: number, height: number}
| Name | Type | Description |
|---|---|---|
x | number | X coordinate |
y | number | Y coordinate |
width | number | Width of bounding box |
height | number | Height of bounding box |
Intersect
Intersect object.
{pts: Point[], ts1: number[], ts2: number[]}
| Name | Type | Description |
|---|---|---|
pts | Point[] | An array of intersected points, or an empty array if no intersections. |
ts | Array.<number[]> | Two arrays (0 === first segment, 1 === second segment) of T values for the intersected points. |
PathList
Path segment list. Contains an array of objects in the following format:
{type: string, x: number, y: number, x1: number, y1: number, x2: number, y2: number}
| Name | Type | Attributes | Description |
|---|---|---|---|
type | string | Valid svg path command limited to M, L, C, Q, Z | |
x | number | X coordinate | |
y | number | Y coordinate | |
x1 | number | optional | X control point for quadratic and bezier curve |
y1 | number | optional | Y control point for quadratic and bezier curve |
x2 | number | optional | Second X control point for bezier curve |
y2 | number | optional | Second Y control point for bezier curve |
length | number | The number of items in the path segment list |
Point
Point object.
{x: number, y: number}
| Name | Type | Description |
|---|---|---|
x | number | X coordinate |
y | number | Y coordinate |
Methods
.globalize(x, y, [target]) Returns: Object
Globalize a point in current shape's coordinate system to a target's coordinate system. Target could be either Vecta.Page or Vecta.Shape. If not given, defaults to Vecta.activePage
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
x | number|string | Coordinate point of x | ||
y | number|string | Coordinate point of y | ||
target | Vecta.Page|Vecta.Shape | optional | Vecta.activePage | Target could be either Vecta.Page or Vecta.Shape. If not supplied, will default to Vecta.activePage. |
Returns:
Converted target coordinates in {x: number|string, y: number|string}.
.localize(x, y, [source]) Returns: Object
Localize a point in a source's coordinate system to current shape's coordinate system. Source could be either Vecta.Page or Vecta.Shape. If not given, defaults to Vecta.activePage
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
x | number|string | Coordinate point of x | ||
y | number|string | Coordinate point of y | ||
source | Vecta.Page|Vecta.Shape | optional | Vecta.activePage | Source could be either Vecta.Page or Vecta.Shape. If not supplied, will default to Vecta.activePage. |
Returns:
Converted source coordinates in {x: number|string, y: number|string}.