Adobe Illustrator CS4 Type Library JS: PathItems

Illustrator CS4

Class

PathItems

 A collection of path items.

QuickLinks

[], add, ellipse, getByName, polygon, rectangle, removeAll, roundedRectangle, star

Hierarchy

Object
PathItems

Properties

PropertyTypeAccessDescription
lengthint readonlyNumber of elements in the collection.
parentObject readonlyThe object's container.
typenamestring readonlyThe class name of the object.

Methods

Instances

PathItem [] (index: uint)
Get an element in the collection with the provided index.

ParameterTypeDescription
indexuint

PathItem add ()
Create a path.

PathItem ellipse ([top: number=100][, left: number=100][, width: number=50][, height: number=100][, reversed: bool=false][, inscribed: bool=true])
Create an elliptical path item.

ParameterTypeDescription
topnumberThe ellipse's bounds. (default: 100) (Optional)
leftnumberThe ellipse's bounds. (default: 100) (Optional)
widthnumberThe ellipse's bounds. (default: 50) (Optional)
heightnumberThe height of the ellipse. (default: 100) (Optional)
reversedboolIs the ellipse path reversed? (default: false) (Optional)
inscribedboolIs the ellipse path inscribed? (default: true) (Optional)

PathItem getByName (name: string)
Get the first element in the collection with the provided name.

ParameterTypeDescription
namestring

PathItem polygon ([centerX: number=200][, centerY: number=300][, radius: number=50][, sides: int=8][, reversed: bool=false])
Used to create a regular polygon path item. Not for path item access.

ParameterTypeDescription
centerXnumber (default: 200) (Optional)
centerYnumber (default: 300) (Optional)
radiusnumberThe radius of the polygon points. (default: 50) (Optional)
sidesintThe number of sides on the polygon. (default: 8) (Optional)
reversedboolIs the polygon path reversed? (default: false) (Optional)

PathItem rectangle (top: number, left: number, width: number, height: number[, reversed: bool=false])
Used to create a rectangular path item. Not for path item access.

ParameterTypeDescription
topnumberThe top coordinate of the rectangle's bounds.
leftnumberThe left coordinate of the rectangle's bounds.
widthnumberThe width of the rectangle.
heightnumberThe height of the rectangle.
reversedboolIs the rectangle path reversed? (default: false) (Optional)

void removeAll ()
Deletes all elements.

PathItem roundedRectangle (top: number, left: number, width: number, height: number[, horizontalRadius: number=15][, verticalRadius: number=20][, reversed: bool=false])
Used to create a rounded-corner rectangular path item. Not for path item access.

ParameterTypeDescription
topnumber
leftnumber
widthnumber
heightnumber
horizontalRadiusnumberHorizontal corner radius. (default: 15) (Optional)
verticalRadiusnumberVertical corner radius. (default: 20) (Optional)
reversedboolIs the rectangle path reversed? (default: false) (Optional)

PathItem star ([centerX: number=200][, centerY: number=300][, radius: number=50][, innerRadius: number=20][, points: int=5][, reversed: bool=false])
Used to create a star-shaped path item. Not for path item access.

ParameterTypeDescription
centerXnumber (default: 200) (Optional)
centerYnumber (default: 300) (Optional)
radiusnumberThe outside radius of the star points. (default: 50) (Optional)
innerRadiusnumberThe inside radius of the star points. (default: 20) (Optional)
pointsintThe number of points on the star. (default: 5) (Optional)
reversedboolIs the star path reversed? (default: false) (Optional)

Element of

CompoundPathItem.pathItems

Document.pathItems

GroupItem.pathItems

Layer.pathItems

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