Path represents a vector geometry which is formed by individual subpaths combined together via boolean operations.
| Property | Type | Required |
|---|---|---|
| id | string | Required |
| name | string | Optional |
| isLocked | boolean | Required |
| visible | boolean | Required |
| contextSettings | GraphicsContextSettings | Required |
| style | Style | Required |
| bounds | Rect | Required |
| frame | Rect | Required |
| matrix | Matrix | Required |
| alphaMaskBy | Array<AlphaMask> | Required |
| outlineMaskBy | Array<string> | Required |
| maskType | integer | Required |
| styleEffectMaskArea | integer | Required |
| maskShowType | integer | Optional |
| maskBoundsBorder | Border | Optional |
| overflow | integer | Required |
| class | const | Required |
| pathType | integer | Optional |
| shape | Shape | Required |
Description
This property of path itself is meaningless, and is represented by its style, such as stroke, fill, etc.
Description
This property records the bounds information of the object before it is matrixed.
Type
Description
An enclosing rectangle for the object. This property stores information about the object after the matrix transformation.
Type
Description
Matrix, as defined in PostScript Language Reference Manual, Second Edition.
Type
Description
The result of the outline mask area is the intersection of multiple outline mask object results.
Type
Array<string>
Description
Describes the mask type of the object.
Type
integer
Value
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
0 | not mask |
1 | outline mask |
2 | alpha mask |
Description
no description
Type
integer
Value
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
0 | The style and visible of the object not affects the area of the mask. The area of mask depends on bound. |
1 | The style of the object not affects the area of the mask. The visible of the object affects the area of the mask. |
2 | The style and visible of the object affects the area of the mask. |
Description
Decide how the mask object should be displayed.
Type
integer
Value
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
0 | depends on the style. (default value for outline mask) |
1 | only show bounds. (default value for alpha mask when it alphaType equal 0) |
2 | not show. (default for other condition) |
Description
Used to draw the bounds of the mask. Only applies if the mask show type is 1. if omit, use r = g = b = 1 position = outside thickness = 1 opacity = 1 blend-mode = normal style = solid
Type
Description
Sets what happens when a child element of a parent overflows its space.
Type
integer
Value
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
1 | hidden: Anything outside the scope of the container will be cropped and invisible. |
2 | visible: Contents outside the scope of the container will not be cropped and will be visible. |
3 | scroll: Content that is out of scope of the container is cropped and a scroll bar is displayed to view the content that is out of scope. |
Description
no description
Type
const
Value
constant: the value of this property must be equal to:
json"path"
Description
The type of path is described.
Type
integer
Value
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
0 | rectangle |
1 | line |
2 | arrow |
3 | ellipse |
4 | polygon |
5 | star |
6 | vector |
