PathItem¶
app.activeDocument.pathItems[index]
Description
Specifies a path item, which contains PathPoint objects that define its geometry.
The PathItem class gives you complete access to paths in Illustrator.
The setEntirePath method provides an extremely efficient way to create paths comprised of straight lines.
Properties¶
PathItem.area¶
app.activeDocument.pathItems[index].area
Description
The area of this path in square points.
If the area is negative, the path is wound counterclockwise.
Self-intersecting paths can contain sub-areas that cancel each other out, which makes this value zero even though the path has apparent area.
Type
Number (double); read-only.
PathItem.artworkKnockout¶
app.activeDocument.pathItems[index].artworkKnockout
Description
Is this object used to create a knockout, and if so, what kind of knockout.
Type
PathItem.blendingMode¶
app.activeDocument.pathItems[index].blendingMode
Description
The blend mode used when compositing an object.
Type
PathItem.clipping¶
app.activeDocument.pathItems[index].clipping
Description
If true, this path should be used as a clipping path.
Type
Boolean
PathItem.closed¶
app.activeDocument.pathItems[index].closed
Description
If true, this path is closed.
Type
Boolean
PathItem.controlBounds¶
app.activeDocument.pathItems[index].controlBounds
Description
The bounds of the object including stroke width and controls.
Type
Array of 4 numbers; read-only.
PathItem.editable¶
app.activeDocument.pathItems[index].editable
Description
If true, this item is editable.
Type
Boolean; read-only.
PathItem.evenodd¶
app.activeDocument.pathItems[index].evenodd
Description
If true, the even-odd rule should be used to determine “insideness.”
Type
Boolean
PathItem.fillColor¶
app.activeDocument.pathItems[index].fillColor
Description
The fill color of the path.
Type
PathItem.filled¶
app.activeDocument.pathItems[index].filled
Description
If true, the path is filled.
Type
Boolean
PathItem.fillOverprint¶
app.activeDocument.pathItems[index].fillOverprint
Description
If true, the art beneath a filled object should be overprinted.
Type
Boolean
PathItem.geometricBounds¶
app.activeDocument.pathItems[index].geometricBounds
Description
The bounds of the object excluding stroke width.
Type
Array of 4 numbers; read-only.
PathItem.guides¶
app.activeDocument.pathItems[index].guides
Description
If true, this path is a guide object.
Type
Boolean
PathItem.height¶
app.activeDocument.pathItems[index].height
Description
The height of the group item.
Type
Number (double)
PathItem.isIsolated¶
app.activeDocument.pathItems[index].isIsolated
Description
If true, this object is isolated.
Type
Boolean
PathItem.layer¶
app.activeDocument.pathItems[index].layer
Description
The layer to which this item belongs.
Type
Layer; read-only.
PathItem.left¶
app.activeDocument.pathItems[index].left
Description
The position of the left side of the item (in points, measured from the left side of the page).
Type
Number (double)
PathItem.length¶
app.activeDocument.pathItems[index].length
Description
The length of this path in points.
Type
Number (double)
PathItem.locked¶
app.activeDocument.pathItems[index].locked
Description
If true, this item is locked.
Type
Boolean
PathItem.name¶
app.activeDocument.pathItems[index].name
Description
The name of this item.
Type
String
PathItem.note¶
app.activeDocument.pathItems[index].note
Description
The note assigned to this item.
Type
String
PathItem.opacity¶
app.activeDocument.pathItems[index].opacity
Description
The opacity of the object. Range: 0.0 to 100.0
Type
Number (double)
PathItem.parent¶
app.activeDocument.pathItems[index].parent
Description
The parent of this object.
Type
PathItem.pathPoints¶
app.activeDocument.pathItems[index].pathPoints
Description
The path points contained in this path item.
Type
PathPoints; read-only.
PathItem.pixelAligned¶
app.activeDocument.pathItems[index].pixelAligned
Description
true if this item is aligned to the pixel grid.
Type
Boolean
PathItem.polarity¶
app.activeDocument.pathItems[index].polarity
Description
The polarity of the path.
Type
PathItem.position¶
app.activeDocument.pathItems[index].position
Description
The position (in points) of the top left corner of the pluginItem object in the format [x, y]. Does not include stroke weight.
Type
Array of 2 numbers; read-only.
PathItem.resolution¶
app.activeDocument.pathItems[index].resolution
Description
The resolution of the path in dots per inch (dpi).
Type
Number (double)
PathItem.selected¶
app.activeDocument.pathItems[index].selected
Description
If true, this item is selected.
Type
Boolean
PathItem.selectedPathPoints¶
app.activeDocument.pathItems[index].selectedPathPoints
Description
All of the selected path points in the path.
Type
PathPoints; read-only.
PathItem.sliced¶
app.activeDocument.pathItems[index].sliced
Description
If true, the item sliced.
Default: false
Type
Boolean
PathItem.strokeCap¶
app.activeDocument.pathItems[index].strokeCap
Description
The type of line capping.
Type
PathItem.strokeColor¶
app.activeDocument.pathItems[index].strokeColor
Description
The stroke color for the path.
Type
PathItem.stroked¶
app.activeDocument.pathItems[index].stroked
Description
If true, the path should be stroked.
Type
Boolean
PathItem.strokeDashes¶
app.activeDocument.pathItems[index].strokeDashes
Description
Dash lengths. Set to an empty object, {}, for a solid line.
Type
Object
PathItem.strokeDashOffset¶
app.activeDocument.pathItems[index].strokeDashOffset
Description
The default distance into the dash pattern at which the pattern should be started.
Type
Number (double)
PathItem.strokeJoin¶
app.activeDocument.pathItems[index].strokeJoin
Description
Type of joints for the path.
Type
PathItem.strokeMiterLimit¶
app.activeDocument.pathItems[index].strokeMiterLimit
Description
When a default stroke join is set to mitered, this property specifies when the join will be converted to beveled (squared-off ) by default. The default miter limit of 4 means that when the length of the point reaches four times the stroke weight, the join switches from a miter join to a bevel join. A value of 1 specifies a bevel join. Range: 1 to 500. Default: 4
Type
Number (double)
PathItem.strokeOverprint¶
app.activeDocument.pathItems[index].strokeOverprint
Description
If true, the art beneath a stroked object should be overprinted.
Type
Boolean
PathItem.strokeWidth¶
app.activeDocument.pathItems[index].strokeWidth
Description
The width of the stroke (in points).
Type
Number (double)
PathItem.top¶
app.activeDocument.pathItems[index].top
Description
The position of the top of the item (in points, measured from the bottom of the page).
Type
Number (double)
PathItem.typename¶
app.activeDocument.pathItems[index].typename
Description
The class name of the referenced object.
Type
String; read-only.
PathItem.uRL¶
app.activeDocument.pathItems[index].uRL
Description
The value of the Adobe URL tag assigned to this item.
Type
String
PathItem.visibilityVariable¶
app.activeDocument.pathItems[index].visibilityVariable
Description
The visibility variable bound to the item.
Type
PathItem.visibleBounds¶
app.activeDocument.pathItems[index].visibleBounds
Description
The visible bounds of the item including stroke width.
Type
Array of 4 numbers; read-only.
PathItem.width¶
app.activeDocument.pathItems[index].width
Description
The width of the item.
Type
Number (double)
PathItem.wrapInside¶
app.activeDocument.pathItems[index].wrapInside
Description
If true, the text frame object should be wrapped inside this object.
Type
Boolean
PathItem.wrapOffset¶
app.activeDocument.pathItems[index].wrapOffset
Description
The offset to use when wrapping text around this object.
Type
Number (double)
PathItem.wrapped¶
app.activeDocument.pathItems[index].wrapped
Description
If true, wrap text frame objects around this object (text frame must be above the object).
Type
Boolean
PathItem.zOrderPosition¶
app.activeDocument.pathItems[index].zOrderPosition
Description
The position of this item within the stacking order of the group or layer (parent) that contains the item.
Type
Number; read-only.
Methods¶
PathItem.duplicate()¶
app.activeDocument.pathItems[index].duplicate([relativeObject][, insertionLocation])
Description
Creates a duplicate of the selected object.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Object, optional |
Object to duplicate to |
|
ElementPlacement, optional |
Location to insert element |
Returns
PathItem.move()¶
app.activeDocument.pathItems[index].move(relativeObject, insertionLocation)
Description
Moves the object.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Object |
Object to move element within |
|
ElementPlacement, optional |
Location to move element to |
Returns
PathItem.remove()¶
app.activeDocument.pathItems[index].remove()
Description
Deletes this object.
Returns
Nothing.
PathItem.resize()¶
app.activeDocument.pathItems[index].resize(scaleX, scaleY[,changePositions][,changeFillPatterns][,changeFillGradients][,changeStrokePattern][,changeLineWidths][,scaleAbout])
Description
Scales the art item where scaleX is the horizontal scaling factor and scaleY is the vertical scaling factor. 100.0 = 100%.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Number (double) |
Horizontal scaling factor |
|
Number (double) |
Vertical scaling factor |
|
Boolean, optional |
Whether to effect art object positions and orientations |
|
Boolean, optional |
Whether to transform fill patterns |
|
Boolean, optional |
Whether to transform fill gradients |
|
Boolean, optional |
Whether to transform stroke patterns |
|
Number (double), optional |
The amount to scale line widths |
|
Transformation, optional |
The point to use as anchor, to transform about |
Returns
Nothing.
PathItem.rotate()¶
app.activeDocument.pathItems[index].rotate(angle[,changePositions][,changeFillPatterns][,changeFillGradients][,changeStrokePattern][,rotateAbout])
Description
Rotates the art item relative to the current rotation.
The object is rotated counter-clockwise if the angle value is positive, clockwise if the value is negative.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Number (double) |
The angle amount to rotate the element |
|
Boolean, optional |
Whether to effect art object positions and orientations |
|
Boolean, optional |
Whether to transform fill patterns |
|
Boolean, optional |
Whether to transform fill gradients |
|
Boolean, optional |
Whether to transform stroke patterns |
|
Transformation, optional |
The point to use as anchor, to transform about |
Returns
Nothing.
PathItem.setEntirePath()¶
app.activeDocument.pathItems[index].setEntirePath(pathPoints)
Description
Sets the path using an array of [x, y] coordinate pairs.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Array of [x, y] coordinate pairs |
Array of point coordinates to set |
Returns
Nothing.
PathItem.transform()¶
app.activeDocument.pathItems[index].transform(transformationMatrix[, changePositions][, changeFillPatterns][, changeFillGradients][, changeStrokePattern][, changeLineWidths][, transformAbout])
Description
Transforms the art item by applying a transformation matrix.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Transformation matrix to apply |
|
|
Boolean, optional |
Whether to change Positions |
|
Boolean, optional |
Whether to change Fill Patterns |
|
Boolean, optional |
Whether to change Fill Gradients |
|
Boolean, optional |
Whether to change Stroke Pattern |
|
Number (double), optional |
The amount to scale line widths |
|
Transformation, optional |
The point to use as anchor, to transform about |
Returns
Nothing.
PathItem.translate()¶
app.activeDocument.pathItems[index].translate([deltaX][, deltaY][, transformObjects][, transformFillPatterns][, transformFillGradients][, transformStrokePatterns])
Description
Repositions the art item relative to the current position, where deltaX is the horizontal offset and deltaY is the vertical offset.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Number (double), optional |
Horizontal offset |
|
Number (double), optional |
Vertical offset |
|
Boolean, optional |
Whether to transform Objects |
|
Boolean, optional |
Whether to transform Fill Patterns |
|
Boolean, optional |
Whether to transform Fill Gradients |
|
Boolean, optional |
Whether to transform Stroke Patterns |
Returns
Nothing.
PathItem.zOrder()¶
app.activeDocument.pathItems[index].zOrder(zOrderCmd)
Description
Arranges the art item’s position in the stacking order of the group or layer (parent) of this object.
Parameters
Parameter |
Type |
Description |
|---|---|---|
|
Stacking order arrangement method |
Returns
Nothing.
Example¶
Setting colors in a path¶
// Sets the stroke and fill of a path item to colors of a randomly selected swatch
if (app.documents.length > 0 && app.activeDocument.pathItems.length > 0) {
var doc = app.activeDocument;
for (var i = 0; i < doc.pathItems.length; i++) {
var pathRef = doc.pathItems[i];
pathRef.filled = true;
pathRef.stroked = true;
var swatchIndex = Math.round(Math.random() * (doc.swatches.length - 1));
pathRef.fillColor = doc.swatches[swatchIndex].color;
pathRef.strokeColor = doc.swatches[swatchIndex].color;
}
}
Creating a path from straight lines¶
// This script illustrates the use of the setEntirePath method.
// Creates a new open path consisting of 10 straight lines
if (app.documents.length > 0) {
var lineList = [];
for (i = 0; i < lineList.length; i++) {
lineList.push([i * 10 + 50, ((i - 5) ^ 2) * 5 + 50];
}
app.defaultStroked = true;
newPath = app.activeDocument.pathItems.add();
newPath.setEntirePath(lineList);
}