PageItem

A page item object.

Go to Property Listing | Method Listing

Methods:

applyEffect, bringInPerspective, duplicate, move, remove, removeAll, resize, rotate, sendScriptMessage, transform, translate, zOrder

Objects:

BlendModes, Boolean, KnockoutState, Layer, Number, Point, String, Tags,

Property Listing

Property	Type	Access	Description
URL	String	read/write	The value of the Adobe URL tag assigned to this artwork item.
absoluteZOrderPosition	Int32	readonly	The absolute drawing order of the layer.
artworkKnockout	KnockoutState KnockoutState.DISABLED KnockoutState.ENABLED KnockoutState.INHERITED KnockoutState.Unknown	read/write	Is the artwork used to create a knockout.
blendingMode	BlendModes BlendModes.COLORBLEND BlendModes.COLORBURN BlendModes.COLORDODGE BlendModes.DARKEN BlendModes.DIFFERENCE BlendModes.EXCLUSION BlendModes.HARDLIGHT BlendModes.HUE BlendModes.LIGHTEN BlendModes.LUMINOSITY BlendModes.MULTIPLY BlendModes.NORMAL BlendModes.OVERLAY BlendModes.SATURATIONBLEND BlendModes.SCREEN BlendModes.SOFTLIGHT	read/write	The mode used when compositing an object.
controlBounds	Rect	readonly	The bounds of the artwork including stroke width and controls.
editable	Boolean	readonly	Can the art item be modified.
geometricBounds	Rect	readonly	The bounds of the artwork excluding stroke width.
height	Number (range 0.0 - 16348.0)	read/write	The height of the art item.
hidden	Boolean	read/write	Is this artwork item hidden?
isIsolated	Boolean	read/write	Is the artwork isolated.
layer	Layer	readonly	The layer to which this artwork belongs.
left	Number	read/write	The left position of the art item.
locked	Boolean	read/write	Is this artwork item locked?
name	String	read/write	The item's name.
note	String	read/write	The note assigned to this artwork item.
opacity	Number (range 0.0 - 100.0)	read/write	The object's opacity (between 0.0 and 100.0)
parent		readonly	The object's container.
pixelAligned	Boolean	read/write	Is this artwork item aligned to Pixel Grid?
position	Point	read/write	The position of the top left corner of the art item.
selected	Boolean	read/write	Is this artwork item selected?
sliced	Boolean	read/write	Is the art item sliced (default: false)
tags	Tags Tag	readonly	The collection of tags associated with this page item.
top	Number	read/write	The top position of the art item.
typename	String	readonly	The class name of the object.
uuid	String	readonly	The item's unique identifier.
visibilityVariable	Varies	read/write	The visibility variable bound to this page item.
visibleBounds	Rect	readonly	The visible bounds of the artwork including stroke width.
width	Number (range 0.0 - 16348.0)	read/write	The width of the art item.
wrapInside	Boolean	read/write	Should the text frame object be wrapped inside this object?
wrapOffset	Number	read/write	Use this offset when wrapping text around this object.
wrapped	Boolean	read/write	Wrap text frame objects around this object (text frame must be above the object)
zOrderPosition	Int32	readonly	The drawing order of the art within it's group or layer.

Method Listing

undefined applyEffect (liveEffectXML:String)

Apply effect to selected artItem.

Parameter	Type	Description
liveEffectXML	String

undefined bringInPerspective (positionX:Number, positionY:Number, perspectiveGridPlane:PerspectiveGridPlaneType)

Place art object(s)in perspective grid at spedified perspective plane and coordinate.

Parameter	Type	Description
positionX	Number	Position towards X direction of specified or active perspective grid plane.
positionY	Number	Position towards Y direction of specified or active perspective grid plane.
perspectiveGridPlane	PerspectiveGridPlaneType PerspectiveGridPlaneType.FLOORPLANE PerspectiveGridPlaneType.LEFTPLANE PerspectiveGridPlaneType.NOPLANE PerspectiveGridPlaneType.RIGHTPLANE	Type of perspective grid plane.

Parameter

Type

Description

positionX

Number

Position towards X direction of specified or active perspective grid plane.

positionY

Number

Position towards Y direction of specified or active perspective grid plane.

perspectiveGridPlane

PerspectiveGridPlaneType

PerspectiveGridPlaneType.FLOORPLANE

PerspectiveGridPlaneType.LEFTPLANE

PerspectiveGridPlaneType.NOPLANE

PerspectiveGridPlaneType.RIGHTPLANE

Type of perspective grid plane.

PageItem duplicate (relativeObject:Object, insertionLocation:ElementPlacement)

Duplicate this object.

Parameter	Type	Description
relativeObject	Object
insertionLocation	ElementPlacement

PageItem 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 resize (scaleX:Number, scaleY:Number, [changePositions:Boolean=Boolean], [changeFillPatterns:Boolean=Boolean], [changeFillGradients:Boolean=Boolean], [changeStrokePattern:Boolean=Boolean], [changeLineWidths:Number=Number], [scaleAbout:Transformation=Transformation])

Scale art object(s)

Parameter	Type	Description
scaleX	Number	Horizontal scaling factor expressed as a percentage (100 = 100%)
scaleY	Number	Vertical scaling factor expressed as a percentage (100 = 100%)
changePositions	Boolean	Are art object positions and orientations effected? (default: true)
changeFillPatterns	Boolean	Are the fill patterns assigned to paths to be transformed? (default: true)
changeFillGradients	Boolean	Are the fill gradients assigned to paths to be transformed? (default: true)
changeStrokePattern	Boolean	Are the stroke patterns assigned to paths to be transformed? (default: true)
changeLineWidths	Number	The amount line widths are to be scaled (expressed as a percentage) (default: 100.0)
scaleAbout	Transformation Transformation.BOTTOM Transformation.BOTTOMLEFT Transformation.BOTTOMRIGHT Transformation.CENTER Transformation.DOCUMENTORIGIN Transformation.LEFT Transformation.RIGHT Transformation.TOP Transformation.TOPLEFT Transformation.TOPRIGHT	The point on the art item's bounding box to which the scale is applied. (default: Transformation.CENTER)

undefined rotate (angle:Number, [changePositions:Boolean=Boolean], [changeFillPatterns:Boolean=Boolean], [changeFillGradients:Boolean=Boolean], [changeStrokePattern:Boolean=Boolean], [rotateAbout:Transformation=Transformation])

Rotate art object(s)

Parameter	Type	Description
angle	Number	Angle of rotation (in degrees). Rotation is performed counter-clock wise.
changePositions	Boolean	Are art object positions and orientations effected? (default: true)
changeFillPatterns	Boolean	Are the fill patterns assigned to paths to be transformed? (default: true)
changeFillGradients	Boolean	Are the fill gradients assigned to paths to be transformed? (default: true)
changeStrokePattern	Boolean	Are the stroke patterns assigned to paths to be transformed? (default: true)
rotateAbout	Transformation Transformation.BOTTOM Transformation.BOTTOMLEFT Transformation.BOTTOMRIGHT Transformation.CENTER Transformation.DOCUMENTORIGIN Transformation.LEFT Transformation.RIGHT Transformation.TOP Transformation.TOPLEFT Transformation.TOPRIGHT	The point on the art item's bounding box to which the rotation is applied. (default: Transformation.CENTER)

String sendScriptMessage (pluginName:String, messageSelector:String, inputString:String)

Sends the script message to the required plugin.

Parameter	Type	Description
pluginName	String	Plugin to which message needs to be sent.
messageSelector	String	Functionality that is to be executed.
inputString	String	Pass any data encoded in a string.

undefined transform (transformationMatrix:Matrix, [changePositions:Boolean=Boolean], [changeFillPatterns:Boolean=Boolean], [changeFillGradients:Boolean=Boolean], [changeStrokePattern:Boolean=Boolean], [changeLineWidths:Number=Number], [transformAbout:Transformation=Transformation])

Transform art object(s) using a transformation matrix.

Parameter	Type	Description
transformationMatrix	Matrix	The transformation matrix to be applied to the objects.
changePositions	Boolean	Are art object positions and orientations effected? (default: true)
changeFillPatterns	Boolean	Are the fill patterns assigned to paths to be transformed? (default: true)
changeFillGradients	Boolean	Are the fill gradients assigned to paths to be transformed? (default: true)
changeStrokePattern	Boolean	Are the stroke patterns assigned to paths to be transformed? (default: true)
changeLineWidths	Number	The amount line widths are to be scaled (expressed as a percentage) (default: 100.0)
transformAbout	Transformation Transformation.BOTTOM Transformation.BOTTOMLEFT Transformation.BOTTOMRIGHT Transformation.CENTER Transformation.DOCUMENTORIGIN Transformation.LEFT Transformation.RIGHT Transformation.TOP Transformation.TOPLEFT Transformation.TOPRIGHT	The point on the art item's bounding box to which scale and rotation operations apply. (default: Transformation.CENTER)

undefined translate ([deltaX:Number=Number], [deltaY:Number=Number], [transformObjects:Boolean=Boolean], [transformFillPatterns:Boolean=Boolean], [transformFillGradients:Boolean=Boolean], [transformStrokePattern:Boolean=Boolean])

Reposition art object(s)

Parameter	Type	Description
deltaX	Number	Horizontal transformation. (default: 0.0)
deltaY	Number	Vertical transformation. (default: 0.0)
transformObjects	Boolean	Are art object positions and orientations affected? (default: true)
transformFillPatterns	Boolean	Are the fill patterns assigned to paths to be transformed? (default: true)
transformFillGradients	Boolean	Are the fill gradients assigned to paths to be transformed? (default: true)
transformStrokePattern	Boolean	Are the stroke patterns assigned to paths to be transformed? (default: true)

undefined zOrder (zOrderCmd:ZOrderMethod)

Arranges the art relative to other art in the group or layer.

Parameter	Type	Description
zOrderCmd	ZOrderMethod ZOrderMethod.BRINGFORWARD ZOrderMethod.BRINGTOFRONT ZOrderMethod.SENDBACKWARD ZOrderMethod.SENDTOBACK	How to arrange the art.

Parameter

Type

Description

zOrderCmd

ZOrderMethod

ZOrderMethod.BRINGFORWARD

ZOrderMethod.BRINGTOFRONT

ZOrderMethod.SENDBACKWARD

ZOrderMethod.SENDTOBACK

How to arrange the art.

Object of

TracingObject.sourceArt

Return

PageItem.duplicate()

PageItems.getByName()

PageItem.move()

Document.rasterize()

TracingObject.releaseTracing()

Document.getPageItemFromUuid()