PathItem
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| area | number | readonly | The area of this path in square points. |
| clipping | bool | r/w | Should this be used as a clipping path? |
| closed | bool | r/w | Is this path closed? |
| evenodd | bool | r/w | Should the even-odd rule be used to determine insideness? |
| fillColor | Color | r/w | Fill color. |
| fillOverprint | bool | r/w | Will art beneath a filled object be overprinted? |
| filled | bool | r/w | Should the path be filled? |
| guides | bool | r/w | Is this path a guide object? |
| length | number | readonly | The length of this path in points. |
| parent | Object | readonly | The object's container. |
| pathPoints | PathPoints PathPoint | readonly | |
| polarity | PolarityValues: PolarityValues.POSITIVE PolarityValues.NEGATIVE |
r/w | The polarity the path. |
| resolution | number | r/w | The resolution of the path. |
| selectedPathPoints | ObjectArray | readonly | All the selected points in the path. |
| strokeCap | StrokeCap: StrokeCap.BUTTENDCAP StrokeCap.ROUNDENDCAP StrokeCap.PROJECTINGENDCAP |
r/w | Type of line capping. |
| strokeColor | Color | r/w | Stroke color. |
| strokeDashOffset | number | r/w | The default distance into the dash pattern at which the pattern should be started. |
| strokeDashes | Array of number | r/w | Dash lengths (set to {} for a solid line) |
| strokeJoin | StrokeJoin: StrokeJoin.MITERENDJOIN StrokeJoin.ROUNDENDJOIN StrokeJoin.BEVELENDJOIN |
r/w | Type of joints. |
| strokeMiterLimit | number | r/w | Whether a join is mitered (pointed) or beveled (squared-off) |
| strokeOverprint | bool | r/w | Will art beneath a stroked object be overprinted? |
| strokeWidth | number | r/w | Width of stroke. |
| stroked | bool | r/w | Should the path be stroked? |
| typename | string | readonly | The class name of the object. |
Methods
Instances
PathItem duplicate (relativeObject:
Object, insertionLocation:
ElementPlacement)
Duplicate this object.
| Parameter | Type | Description |
|---|---|---|
| relativeObject | Object | |
| insertionLocation | ElementPlacement |
PathItem move (relativeObject:
Object, insertionLocation:
ElementPlacement)
Move the object.
| Parameter | Type | Description |
|---|---|---|
| relativeObject | Object | |
| insertionLocation | ElementPlacement |
void remove ()
Deletes this object.
void removeAll ()
Deletes all elements.
void setEntirePath (pathPoints:
Array of any)
Set the path using the provided array of path point (x, y) coordinate pairs.
| Parameter | Type | Description |
|---|---|---|
| pathPoints | Array of any | Array of (x, y) coordinate pairs for the path points. |
Used in:
TextFrameItem TextFrameItems.areaText (textPath: PathItem[, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])
TextFrameItem TextFrameItems.pathText (textPath: PathItem[, startTValue: number=0.0][, endTValue: number=0.0][, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])
Return
PathItem PathItem.duplicate (relativeObject: Object, insertionLocation: ElementPlacement)
PathItem PathItem.move (relativeObject: Object, insertionLocation: ElementPlacement)
PathItem PathItems.add ()
PathItem PathItems.ellipse ([top: number=100][, left: number=100][, width: number=50][, height: number=100][, reversed: bool=false][, inscribed: bool=true])
PathItem PathItems.getByName (name: string)
PathItem PathItems.polygon ([centerX: number=200][, centerY: number=300][, radius: number=50][, sides: Int32=8][, reversed: bool=false])
PathItem PathItems.rectangle (top: number, left: number, width: number, height: number[, reversed: bool=false])
PathItem PathItems.roundedRectangle (top: number, left: number, width: number, height: number[, horizontalRadius: number=15][, verticalRadius: number=20][, reversed: bool=false])
PathItem PathItems.star ([centerX: number=200][, centerY: number=300][, radius: number=50][, innerRadius: number=20][, points: Int32=5][, reversed: bool=false])
| Jongware, 25-Nov-2012 v3.0.3i | Contents :: Index |