Package | com.adobe.illustrator |
Class | public class PathItem |
Inheritance | PathItem ![]() ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
area : Number [read-only]
The area of this path in square points. | PathItem | ||
![]() | artworkKnockout : KnockoutState
Is the artwork used to create a knockout. | PageItem | |
![]() | blendingMode : 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 | ||
![]() | controlBounds : Array [read-only]
The bounds of the artwork including stroke width and controls. | PageItem | |
![]() | editable : 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 | ||
![]() | geometricBounds : Array [read-only]
The bounds of the artwork excluding stroke width. | PageItem | |
guides : Boolean
Is this path a guide object?
| PathItem | ||
![]() | height : Number
The height of the art item. | PageItem | |
![]() | hidden : Boolean
Is this artwork item hidden?
| PageItem | |
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
![]() | isIsolated : Boolean
Is the artwork isolated. | PageItem | |
![]() | layer : Layer [read-only]
The layer to which this artwork belongs. | PageItem | |
![]() | left : Number
The left position of the art item. | PageItem | |
length : Number [read-only]
The length of this path in points. | PathItem | ||
![]() | locked : Boolean
Is this artwork item locked?
| PageItem | |
![]() | name : String
The item's name. | PageItem | |
![]() | note : String
The note assigned to this artwork item. | PageItem | |
![]() | opacity : Number
The object's opacity (between 0.0 and 100.0) ( 0.0 - 100.0 )
| PageItem | |
![]() | parent : * [read-only] | IllustratorHostObject | |
pathPoints : PathPoints [read-only]
| PathItem | ||
![]() | pixelAligned : Boolean
is this artwork item aligned to Pixel Grid?
| PageItem | |
polarity : PolarityValues
The polarity the path. | PathItem | ||
![]() | position : Array
The position of the top left corner of the art item. | PageItem | |
resolution : Number
The resolution of the path. | PathItem | ||
![]() | selected : Boolean
Is this artwork item selected?
| PageItem | |
selectedPathPoints : Array [read-only]
All the selected points in the path. | PathItem | ||
![]() | sliced : 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 | ||
![]() | tags : Tags [read-only]
The collection of tags associated with this page item. | PageItem | |
![]() | top : Number
The top position of the art item. | PageItem | |
![]() | uRL : String
The value of the Adobe URL tag assigned to this artwork item. | PageItem | |
![]() | visibilityVariable : Object
The visibility variable bound to this page item. | PageItem | |
![]() | visibleBounds : Array [read-only]
The visible bounds of the artwork including stroke width. | PageItem | |
![]() | width : Number
The width of the art item. | PageItem | |
![]() | wrapInside : Boolean
Should the text frame object be wrapped inside this object?
| PageItem | |
![]() | wrapOffset : Number
Use this offset when wrapping text around this object. | PageItem | |
![]() | wrapped : Boolean
Wrap text frame objects around this object (text frame must be above the object)
| PageItem | |
![]() | zOrderPosition : Number [read-only]
The drawing order of the art within it's group or layer. | PageItem |
Method | Defined By | ||
---|---|---|---|
![]() | bringInPerspective(positionX:Number, positionY:Number, perspectiveGridPlane:PerspectiveGridPlaneType = null):void
Place art object(s)in perspective grid at spedified perspective plane and coordinate
| PageItem | |
![]() |
create a duplicate of the object
| PageItem | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | |
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | |
![]() | move(relativeObject:Object, insertionLocation:ElementPlacement):void
move the object
| PageItem | |
![]() | remove():void
delete the object
| PageItem | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | 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 | |
![]() | 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 | ||
![]() | 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 | |
![]() | 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 | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject | |
![]() | zOrder(zOrderCmd:ZOrderMethod):void
Arranges the art relative to other art in the group or layer. | PageItem |
area | property |
area:Number
[read-only] Since : | CS5 |
The area of this path in square points.
public function get area():Number
clipping | property |
clipping:Boolean
Since : | CS5 |
Should this be used as a clipping path?
public function get clipping():Boolean
public function set clipping(value:Boolean):void
closed | property |
closed:Boolean
Since : | CS5 |
Is this path closed?
public function get closed():Boolean
public function set closed(value:Boolean):void
evenodd | property |
evenodd:Boolean
Since : | CS5 |
Should the even-odd rule be used to determine insideness?
public function get evenodd():Boolean
public function set evenodd(value:Boolean):void
fillColor | property |
fillColor:Color
Since : | CS5 |
Fill color.
public function get fillColor():Color
public function set fillColor(value:Color):void
filled | property |
filled:Boolean
Since : | CS5 |
Should the path be filled?
public function get filled():Boolean
public function set filled(value:Boolean):void
fillOverprint | property |
fillOverprint:Boolean
Since : | CS5 |
Will art beneath a filled object be overprinted?
public function get fillOverprint():Boolean
public function set fillOverprint(value:Boolean):void
guides | property |
guides:Boolean
Since : | CS5 |
Is this path a guide object?
public function get guides():Boolean
public function set guides(value:Boolean):void
length | property |
length:Number
[read-only] Since : | CS5 |
The length of this path in points.
public function get length():Number
pathPoints | property |
pathPoints:PathPoints
[read-only] Since : | CS5 |
public function get pathPoints():PathPoints
polarity | property |
polarity:PolarityValues
Since : | CS5 |
The polarity the path.
public function get polarity():PolarityValues
public function set polarity(value:PolarityValues):void
resolution | property |
resolution:Number
Since : | CS5 |
The resolution of the path.
public function get resolution():Number
public function set resolution(value:Number):void
selectedPathPoints | property |
selectedPathPoints:Array
[read-only] Since : | CS5 |
All the selected points in the path.
public function get selectedPathPoints():Array
strokeCap | property |
strokeCap:StrokeCap
Since : | CS5 |
Type of line capping.
public function get strokeCap():StrokeCap
public function set strokeCap(value:StrokeCap):void
strokeColor | property |
strokeColor:Color
Since : | CS5 |
Stroke color.
public function get strokeColor():Color
public function set strokeColor(value:Color):void
stroked | property |
stroked:Boolean
Since : | CS5 |
Should the path be stroked?
public function get stroked():Boolean
public function set stroked(value:Boolean):void
strokeDashes | property |
strokeDashes:Array
Since : | CS5 |
Dash lengths (set to {} for a solid line)
public function get strokeDashes():Array
public function set strokeDashes(value:Array):void
strokeDashOffset | property |
strokeDashOffset:Number
Since : | CS5 |
The default distance into the dash pattern at which the pattern should be started.
public function get strokeDashOffset():Number
public function set strokeDashOffset(value:Number):void
strokeJoin | property |
strokeJoin:StrokeJoin
Since : | CS5 |
Type of joints.
public function get strokeJoin():StrokeJoin
public function set strokeJoin(value:StrokeJoin):void
strokeMiterLimit | property |
strokeMiterLimit:Number
Since : | CS5 |
Whether a join is mitered (pointed) or beveled (squared-off)
public function get strokeMiterLimit():Number
public function set strokeMiterLimit(value:Number):void
strokeOverprint | property |
strokeOverprint:Boolean
Since : | CS5 |
Will art beneath a stroked object be overprinted?
public function get strokeOverprint():Boolean
public function set strokeOverprint(value:Boolean):void
strokeWidth | property |
strokeWidth:Number
Since : | CS5 |
Width of stroke.
public function get strokeWidth():Number
public function set strokeWidth(value:Number):void
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.
|