Object

PageItem

A page item object.

Extended byCompoundPathItem·EmbedItem·GraphItem·GridRepeatItem·GroupItem·LegacyTextItem·MeshItem·NonNativeItem·PathItem·PlacedItem·PluginItem·RadialRepeatItem·RasterItem·SymbolItem·SymmetryRepeatItem·TextFrameItem

Properties

Type	Access	Description
String	read/write	The value of the Adobe URL tag assigned to this artwork item.
Int32	readonly	The absolute drawing order of the layer.
KnockoutState	read/write	Is the artwork used to create a knockout.
BlendModes +4 more	read/write	The mode used when compositing an object.
Rect	readonly	The bounds of the artwork including stroke width and controls.
Boolean	readonly	Can the art item be modified.
Rect	readonly	The bounds of the artwork excluding stroke width.
Number 0.0–16348.0	read/write	The height of the art item.
Boolean	read/write	Is this artwork item hidden?
Boolean	read/write	Is the artwork isolated.
Layer	readonly	The layer to which this artwork belongs.
Number	read/write	The left position of the art item.
Boolean	read/write	Is this artwork item locked?
String	read/write	The item's name.
String	read/write	The note assigned to this artwork item.
Number 0.0–100.0	read/write	The object's opacity (between 0.0 and 100.0)
The	readonly	The object's container.
Boolean	read/write	Is this artwork item aligned to Pixel Grid?
Point	read/write	The position of the top left corner of the art item.
Boolean	read/write	Is this artwork item selected?
Boolean	read/write	Is the art item sliced (default: false)
Tags<Tag>	readonly	The collection of tags associated with this page item.
Number	read/write	The top position of the art item.
String	readonly	The class name of the object.
String	readonly	The item's unique identifier.
Varies	read/write	The visibility variable bound to this page item.
Rect	readonly	The visible bounds of the artwork including stroke width.
Number 0.0–16348.0	read/write	The width of the art item.
Boolean	read/write	Should the text frame object be wrapped inside this object?
Number	read/write	Use this offset when wrapping text around this object.
Boolean	read/write	Wrap text frame objects around this object (text frame must be above the object)
Int32	readonly	The drawing order of the art within it's group or layer.

Methods

→ void

Apply effect to selected artItem.

liveEffectXML String

→ void

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

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 Type of perspective grid plane.

→ PageItem

Duplicate this object.

relativeObject Object

insertionLocation ElementPlacement

→ PageItem

Move the object.

relativeObject Object

insertionLocation ElementPlacement

→ void

Deletes this object.

→ void

Deletes all elements.

→ void

Scale art object(s)

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?

changeFillPatterns? Boolean Are the fill patterns assigned to paths to be transformed?

changeFillGradients? Boolean Are the fill gradients assigned to paths to be transformed?

changeStrokePattern? Boolean Are the stroke patterns assigned to paths to be transformed?

changeLineWidths? Number The amount line widths are to be scaled (expressed as a percentage)

scaleAbout? Transformation The point on the art item's bounding box to which the scale is applied.

→ void

Rotate art object(s)

angle Number Angle of rotation (in degrees). Rotation is performed counter-clock wise.

changePositions? Boolean Are art object positions and orientations effected?

changeFillPatterns? Boolean Are the fill patterns assigned to paths to be transformed?

changeFillGradients? Boolean Are the fill gradients assigned to paths to be transformed?

changeStrokePattern? Boolean Are the stroke patterns assigned to paths to be transformed?

rotateAbout? Transformation The point on the art item's bounding box to which the rotation is applied.

→ String

Sends the script message to the required plugin.

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.

→ void

Transform art object(s) using a transformation matrix.

transformationMatrix Matrix The transformation matrix to be applied to the objects.

changePositions? Boolean Are art object positions and orientations effected?

changeFillPatterns? Boolean Are the fill patterns assigned to paths to be transformed?

changeFillGradients? Boolean Are the fill gradients assigned to paths to be transformed?

changeStrokePattern? Boolean Are the stroke patterns assigned to paths to be transformed?

changeLineWidths? Number The amount line widths are to be scaled (expressed as a percentage)

transformAbout? Transformation The point on the art item's bounding box to which scale and rotation operations apply.

→ void

Reposition art object(s)

deltaX? Number Horizontal transformation.

deltaY? Number Vertical transformation.

transformObjects? Boolean Are art object positions and orientations affected?

transformFillPatterns? Boolean Are the fill patterns assigned to paths to be transformed?

transformFillGradients? Boolean Are the fill gradients assigned to paths to be transformed?

transformStrokePattern? Boolean Are the stroke patterns assigned to paths to be transformed?

→ void

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

zOrderCmd ZOrderMethod How to arrange the art.

Object of 1

Properties elsewhere that hold a PageItem.

TracingObject.sourceArt

Parameter of 1

Method parameters that accept a PageItem.

Symbols.add(sourceArt)

Return 6

Methods that return a PageItem.

Document.getPageItemFromUuid()Document.rasterize()PageItem.duplicate()PageItem.move()PageItems.getByName()TracingObject.releaseTracing()