PathItem

An artwork path item.

Methods:

duplicate, move, remove, removeAll, setEntirePath

Objects:

Boolean, Color, Number, PathPoints, PolarityValues, String, StrokeCap, StrokeJoin

Hierarchy:

Superclass: PageItem

Class: PathItem

Property Listing

Property

Type

Access

Description

area

Number

readonly

The area of this path in square points.

clipping

Boolean

read/write

Should this be used as a clipping path?

closed

Boolean

read/write

Is this path closed?

evenodd

Boolean

read/write

Should the even-odd rule be used to determine insideness?

fillColor

Color

read/write

Fill color.

fillOverprint

Boolean

read/write

Will art beneath a filled object be overprinted?

filled

Boolean

read/write

Should the path be filled?

guides

Boolean

read/write

Is this path a guide object?

length

Number

readonly

The length of this path in points.

parent

 

readonly

The object's container.

pathPoints

PathPoints PathPoint

readonly

 

polarity

PolarityValues

PolarityValues.NEGATIVE

PolarityValues.POSITIVE

read/write

The polarity the path.

resolution

Number

read/write

The resolution of the path.

selectedPathPoints

ObjectArray

readonly

All the selected points in the path.

strokeCap

StrokeCap

StrokeCap.BUTTENDCAP

StrokeCap.PROJECTINGENDCAP

StrokeCap.ROUNDENDCAP

read/write

Type of line capping.

strokeColor

Color

read/write

Stroke color.

strokeDashOffset

Number

read/write

The default distance into the dash pattern at which the pattern should be started.

strokeDashes

Array of Number

read/write

Dash lengths (set to {} for a solid line)

strokeJoin

StrokeJoin

StrokeJoin.BEVELENDJOIN

StrokeJoin.MITERENDJOIN

StrokeJoin.ROUNDENDJOIN

read/write

Type of joints.

strokeMiterLimit

Number

read/write

Whether a join is mitered (pointed) or beveled (squared-off)

strokeOverprint

Boolean

read/write

Will art beneath a stroked object be overprinted?

strokeWidth

Number

read/write

Width of stroke.

stroked

Boolean

read/write

Should the path be stroked?

typename

String

readonly

The class name of the object.

Method Listing

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

 

undefined remove ()

Deletes this object.

undefined removeAll ()

Deletes all elements.

undefined setEntirePath (pathPoints:Array of Varies)

Set the path using the provided array of path point (x, y) coordinate pairs.

Parameter

Type

Description

pathPoints

Array of Varies

Array of (x, y) coordinate pairs for the path points.

Return

PathItems.add()

PathItems.ellipse()

PathItem.duplicate()

PathItems.getByName()

PathItem.move()

PathItems.rectangle()

PathItems.polygon()

PathItems.roundedRectangle()

PathItems.star()