Adobe Illustrator CS5 Type Library JS: PathItem

Illustrator CS5

Class

PathItem

 An artwork path item. Base Class: PageItem

QuickLinks

duplicate, move, remove, removeAll, setEntirePath

Hierarchy

Object
PageItem
PathItem

Properties

PropertyTypeAccessDescription
areanumber readonlyThe area of this path in square points.
clippingbool r/wShould this be used as a clipping path?
closedbool r/wIs this path closed?
evenoddbool r/wShould the even-odd rule be used to determine insideness?
fillColorColor r/wFill color.
fillOverprintbool r/wWill art beneath a filled object be overprinted?
filledbool r/wShould the path be filled?
guidesbool r/wIs this path a guide object?
lengthnumber readonlyThe length of this path in points.
parentObject readonlyThe object's container.
pathPointsPathPoints readonly
polarityPolarityValues:
PolarityValues.POSITIVE
PolarityValues.NEGATIVE
r/wThe polarity the path.
resolutionnumber r/wThe resolution of the path.
selectedPathPointsObjectArray readonlyAll the selected points in the path.
strokeCapStrokeCap:
StrokeCap.BUTTENDCAP
StrokeCap.ROUNDENDCAP
StrokeCap.PROJECTINGENDCAP
r/wType of line capping.
strokeColorColor r/wStroke color.
strokeDashOffsetnumber r/wThe default distance into the dash pattern at which the pattern should be started.
strokeDashes Array of number r/wDash lengths (set to {} for a solid line)
strokeJoinStrokeJoin:
StrokeJoin.MITERENDJOIN
StrokeJoin.ROUNDENDJOIN
StrokeJoin.BEVELENDJOIN
r/wType of joints.
strokeMiterLimitnumber r/wWhether a join is mitered (pointed) or beveled (squared-off)
strokeOverprintbool r/wWill art beneath a stroked object be overprinted?
strokeWidthnumber r/wWidth of stroke.
strokedbool r/wShould the path be stroked?
typenamestring readonlyThe class name of the object.

Methods

Instances

PathItem duplicate (relativeObject: Object, insertionLocation: ElementPlacement)
Duplicate this object.

ParameterTypeDescription
relativeObjectObject
insertionLocationElementPlacement

PathItem move (relativeObject: Object, insertionLocation: ElementPlacement)
Move the object.

ParameterTypeDescription
relativeObjectObject
insertionLocationElementPlacement

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.

ParameterTypeDescription
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: int=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: int=5][, reversed: bool=false])

Jongware, 27-Jun-2010 v3.0.3dContents :: Index