Packagecom.adobe.illustrator
Classpublic class PathItem
InheritancePathItem Inheritance PageItem Inheritance IllustratorHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

An artwork path item.



Public Properties
 PropertyDefined By
  area : Number
[read-only] The area of this path in square points.
PathItem
 InheritedartworkKnockout : KnockoutState
Is the artwork used to create a knockout.
PageItem
 InheritedblendingMode : BlendModes
The mode used when compositing an object.
PageItem
  clipping : Boolean
Should this be used as a clipping path?
PathItem
  closed : Boolean
Is this path closed?
PathItem
 InheritedcontrolBounds : Array
[read-only] The bounds of the artwork including stroke width and controls.
PageItem
 Inheritededitable : Boolean
[read-only] Can the art item be modified.
PageItem
  evenodd : Boolean
Should the even-odd rule be used to determine insideness?
PathItem
  fillColor : Color
Fill color.
PathItem
  filled : Boolean
Should the path be filled?
PathItem
  fillOverprint : Boolean
Will art beneath a filled object be overprinted?
PathItem
 InheritedgeometricBounds : Array
[read-only] The bounds of the artwork excluding stroke width.
PageItem
  guides : Boolean
Is this path a guide object?
PathItem
 Inheritedheight : Number
The height of the art item.
PageItem
 Inheritedhidden : Boolean
Is this artwork item hidden?
PageItem
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
 InheritedisIsolated : Boolean
Is the artwork isolated.
PageItem
 Inheritedlayer : Layer
[read-only] The layer to which this artwork belongs.
PageItem
 Inheritedleft : Number
The left position of the art item.
PageItem
  length : Number
[read-only] The length of this path in points.
PathItem
 Inheritedlocked : Boolean
Is this artwork item locked?
PageItem
 Inheritedname : String
The item's name.
PageItem
 Inheritednote : String
The note assigned to this artwork item.
PageItem
 Inheritedopacity : Number
The object's opacity (between 0.0 and 100.0) ( 0.0 - 100.0 )
PageItem
 Inheritedparent : *
[read-only]
IllustratorHostObject
  pathPoints : PathPoints
[read-only]
PathItem
 InheritedpixelAligned : Boolean
is this artwork item aligned to Pixel Grid?
PageItem
  polarity : PolarityValues
The polarity the path.
PathItem
 Inheritedposition : Array
The position of the top left corner of the art item.
PageItem
  resolution : Number
The resolution of the path.
PathItem
 Inheritedselected : Boolean
Is this artwork item selected?
PageItem
  selectedPathPoints : Array
[read-only] All the selected points in the path.
PathItem
 Inheritedsliced : Boolean
Is the art item sliced (default: false)
PageItem
  strokeCap : StrokeCap
Type of line capping.
PathItem
  strokeColor : Color
Stroke color.
PathItem
  stroked : Boolean
Should the path be stroked?
PathItem
  strokeDashes : Array
Dash lengths (set to {} for a solid line)
PathItem
  strokeDashOffset : Number
The default distance into the dash pattern at which the pattern should be started.
PathItem
  strokeJoin : StrokeJoin
Type of joints.
PathItem
  strokeMiterLimit : Number
Whether a join is mitered (pointed) or beveled (squared-off)
PathItem
  strokeOverprint : Boolean
Will art beneath a stroked object be overprinted?
PathItem
  strokeWidth : Number
Width of stroke.
PathItem
 Inheritedtags : Tags
[read-only] The collection of tags associated with this page item.
PageItem
 Inheritedtop : Number
The top position of the art item.
PageItem
 InheriteduRL : String
The value of the Adobe URL tag assigned to this artwork item.
PageItem
 InheritedvisibilityVariable : Object
The visibility variable bound to this page item.
PageItem
 InheritedvisibleBounds : Array
[read-only] The visible bounds of the artwork including stroke width.
PageItem
 Inheritedwidth : Number
The width of the art item.
PageItem
 InheritedwrapInside : Boolean
Should the text frame object be wrapped inside this object?
PageItem
 InheritedwrapOffset : Number
Use this offset when wrapping text around this object.
PageItem
 Inheritedwrapped : Boolean
Wrap text frame objects around this object (text frame must be above the object)
PageItem
 InheritedzOrderPosition : Number
[read-only] The drawing order of the art within it's group or layer.
PageItem
Public Methods
 MethodDefined By
 Inherited
bringInPerspective(positionX:Number, positionY:Number, perspectiveGridPlane:PerspectiveGridPlaneType = null):void
Place art object(s)in perspective grid at spedified perspective plane and coordinate
PageItem
 Inherited
duplicate(relativeObject:Object = null, insertionLocation:ElementPlacement = null):PageItem
create a duplicate of the object
PageItem
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
move(relativeObject:Object, insertionLocation:ElementPlacement):void
move the object
PageItem
 Inherited
remove():void
delete the object
PageItem
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
resize(scaleX:Number, scaleY:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, scaleAbout:Transformation = null):void
Scale art object(s)
PageItem
 Inherited
rotate(angle:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, rotateAbout:Transformation = null):void
Rotate art object(s)
PageItem
  
setEntirePath(pathPoints:Object):void
Set the path using the provided array of path point (x, y) coordinate pairs.
PathItem
 Inherited
transform(transformationMatrix:Matrix, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, transformAbout:Transformation = null):void
Transform art object(s) using a transformation matrix.
PageItem
 Inherited
translate(deltaX:Number = 0.0, deltaY:Number = 0.0, transformObjects:Boolean = true, transformFillPatterns:Boolean = true, transformFillGradients:Boolean = true, transformStrokePattern:Boolean = true):void
Reposition art object(s)
PageItem
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
 Inherited
zOrder(zOrderCmd:ZOrderMethod):void
Arranges the art relative to other art in the group or layer.
PageItem
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
areaproperty
area:Number  [read-only]

Since : CS5

The area of this path in square points.


Implementation
    public function get area():Number
clippingproperty 
clipping:Boolean

Since : CS5

Should this be used as a clipping path?


Implementation
    public function get clipping():Boolean
    public function set clipping(value:Boolean):void
closedproperty 
closed:Boolean

Since : CS5

Is this path closed?


Implementation
    public function get closed():Boolean
    public function set closed(value:Boolean):void
evenoddproperty 
evenodd:Boolean

Since : CS5

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


Implementation
    public function get evenodd():Boolean
    public function set evenodd(value:Boolean):void
fillColorproperty 
fillColor:Color

Since : CS5

Fill color.


Implementation
    public function get fillColor():Color
    public function set fillColor(value:Color):void
filledproperty 
filled:Boolean

Since : CS5

Should the path be filled?


Implementation
    public function get filled():Boolean
    public function set filled(value:Boolean):void
fillOverprintproperty 
fillOverprint:Boolean

Since : CS5

Will art beneath a filled object be overprinted?


Implementation
    public function get fillOverprint():Boolean
    public function set fillOverprint(value:Boolean):void
guidesproperty 
guides:Boolean

Since : CS5

Is this path a guide object?


Implementation
    public function get guides():Boolean
    public function set guides(value:Boolean):void
lengthproperty 
length:Number  [read-only]

Since : CS5

The length of this path in points.


Implementation
    public function get length():Number
pathPointsproperty 
pathPoints:PathPoints  [read-only]

Since : CS5


Implementation
    public function get pathPoints():PathPoints
polarityproperty 
polarity:PolarityValues

Since : CS5

The polarity the path.


Implementation
    public function get polarity():PolarityValues
    public function set polarity(value:PolarityValues):void
resolutionproperty 
resolution:Number

Since : CS5

The resolution of the path.


Implementation
    public function get resolution():Number
    public function set resolution(value:Number):void
selectedPathPointsproperty 
selectedPathPoints:Array  [read-only]

Since : CS5

All the selected points in the path.


Implementation
    public function get selectedPathPoints():Array
strokeCapproperty 
strokeCap:StrokeCap

Since : CS5

Type of line capping.


Implementation
    public function get strokeCap():StrokeCap
    public function set strokeCap(value:StrokeCap):void
strokeColorproperty 
strokeColor:Color

Since : CS5

Stroke color.


Implementation
    public function get strokeColor():Color
    public function set strokeColor(value:Color):void
strokedproperty 
stroked:Boolean

Since : CS5

Should the path be stroked?


Implementation
    public function get stroked():Boolean
    public function set stroked(value:Boolean):void
strokeDashesproperty 
strokeDashes:Array

Since : CS5

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


Implementation
    public function get strokeDashes():Array
    public function set strokeDashes(value:Array):void
strokeDashOffsetproperty 
strokeDashOffset:Number

Since : CS5

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


Implementation
    public function get strokeDashOffset():Number
    public function set strokeDashOffset(value:Number):void
strokeJoinproperty 
strokeJoin:StrokeJoin

Since : CS5

Type of joints.


Implementation
    public function get strokeJoin():StrokeJoin
    public function set strokeJoin(value:StrokeJoin):void
strokeMiterLimitproperty 
strokeMiterLimit:Number

Since : CS5

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


Implementation
    public function get strokeMiterLimit():Number
    public function set strokeMiterLimit(value:Number):void
strokeOverprintproperty 
strokeOverprint:Boolean

Since : CS5

Will art beneath a stroked object be overprinted?


Implementation
    public function get strokeOverprint():Boolean
    public function set strokeOverprint(value:Boolean):void
strokeWidthproperty 
strokeWidth:Number

Since : CS5

Width of stroke.


Implementation
    public function get strokeWidth():Number
    public function set strokeWidth(value:Number):void
Method Detail
setEntirePath()method
public function setEntirePath(pathPoints:Object):void

Since : CS5

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

Parameters

pathPoints:Object — (Object) Array of (x, y) coordinate pairs for the path points.