Adobe Illustrator CS6 Type Library JS: PageItem

Illustrator CS6

Class

PageItem

 

A page item object.

Superclass of CompoundPathItem, GraphItem, GroupItem, LegacyTextItem, MeshItem, NonNativeItem, PathItem, PlacedItem, PluginItem, RasterItem, SymbolItem, and TextFrameItem

QuickLinks

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

Hierarchy

Object
PageItem
CompoundPathItem | GraphItem | GroupItem | LegacyTextItem | MeshItem | NonNativeItem | PathItem | PlacedItem | PluginItem | RasterItem | SymbolItem | TextFrameItem

Properties

PropertyTypeAccessDescription
URLstring r/wThe value of the Adobe URL tag assigned to this artwork item.
artworkKnockoutKnockoutState:
KnockoutState.Unknown
KnockoutState.DISABLED
KnockoutState.ENABLED
KnockoutState.INHERITED
r/wIs the artwork used to create a knockout.
blendingModeBlendModes:
BlendModes.NORMAL
BlendModes.MULTIPLY
BlendModes.SCREEN
BlendModes.OVERLAY
BlendModes.SOFTLIGHT
BlendModes.HARDLIGHT
BlendModes.COLORDODGE
BlendModes.COLORBURN
BlendModes.DARKEN
BlendModes.LIGHTEN
BlendModes.DIFFERENCE
BlendModes.EXCLUSION
BlendModes.HUE
BlendModes.SATURATIONBLEND
BlendModes.COLORBLEND
BlendModes.LUMINOSITY
r/wThe mode used when compositing an object.
controlBoundsRectangle readonlyThe bounds of the artwork including stroke width and controls.
editablebool readonlyCan the art item be modified.
geometricBoundsRectangle readonlyThe bounds of the artwork excluding stroke width.
heightnumber (range: 0.0 - 16348.0) r/wThe height of the art item.
hiddenbool r/wIs this artwork item hidden?
isIsolatedbool r/wIs the artwork isolated.
layerLayer readonlyThe layer to which this artwork belongs.
leftnumber r/wThe left position of the art item.
lockedbool r/wIs this artwork item locked?
namestring r/wThe item's name.
notestring r/wThe note assigned to this artwork item.
opacitynumber (range: 0.0 - 100.0) r/wThe object's opacity (between 0.0 and 100.0)
parentObject readonlyThe object's container.
pixelAlignedbool r/wIs this artwork item aligned to Pixel Grid?
positionPoint r/wThe position of the top left corner of the art item.
selectedbool r/wIs this artwork item selected?
slicedbool r/wIs the art item sliced (default: false)
tagsTags Tag readonlyThe collection of tags associated with this page item.
topnumber r/wThe top position of the art item.
typenamestring readonlyThe class name of the object.
visibilityVariableany r/wThe visibility variable bound to this page item.
visibleBoundsRectangle readonlyThe visible bounds of the artwork including stroke width.
widthnumber (range: 0.0 - 16348.0) r/wThe width of the art item.
wrapInsidebool r/wShould the text frame object be wrapped inside this object?
wrapOffsetnumber r/wUse this offset when wrapping text around this object.
wrappedbool r/wWrap text frame objects around this object (text frame must be above the object)
zOrderPositionInt32 readonlyThe drawing order of the art within it's group or layer.

Methods

Instances

void applyEffect (liveEffectXML: string)
Apply effect to selected artItem.

ParameterTypeDescription
liveEffectXMLstring

void bringInPerspective (positionX: number, positionY: number, perspectiveGridPlane: PerspectiveGridPlaneType)
Place art object(s)in perspective grid at spedified perspective plane and coordinate.

ParameterTypeDescription
positionXnumberPosition towards X direction of specified or active perspective grid plane.
positionYnumberPosition towards Y direction of specified or active perspective grid plane.
perspectiveGridPlanePerspectiveGridPlaneType:
PerspectiveGridPlaneType.NOPLANE
PerspectiveGridPlaneType.LEFTPLANE
PerspectiveGridPlaneType.RIGHTPLANE
PerspectiveGridPlaneType.FLOORPLANE
Type of perspective grid plane.

PageItem duplicate (relativeObject: Object, insertionLocation: ElementPlacement)
Duplicate this object.

ParameterTypeDescription
relativeObjectObject
insertionLocationElementPlacement

PageItem move (relativeObject: Object, insertionLocation: ElementPlacement)
Move the object.

ParameterTypeDescription
relativeObjectObject
insertionLocationElementPlacement

void remove ()
Deletes this object.

void removeAll ()
Deletes all elements.

void resize (scaleX: number, scaleY: number[, changePositions: bool=true][, changeFillPatterns: bool=true][, changeFillGradients: bool=true][, changeStrokePattern: bool=true][, changeLineWidths: number=100.0][, scaleAbout: Transformation=Transformation.CENTER])
Scale art object(s)

ParameterTypeDescription
scaleXnumberHorizontal scaling factor expressed as a percentage (100 = 100%)
scaleYnumberVertical scaling factor expressed as a percentage (100 = 100%)
changePositionsboolAre art object positions and orientations effected? (default: true) (Optional)
changeFillPatternsboolAre the fill patterns assigned to paths to be transformed? (default: true) (Optional)
changeFillGradientsboolAre the fill gradients assigned to paths to be transformed? (default: true) (Optional)
changeStrokePatternboolAre the stroke patterns assigned to paths to be transformed? (default: true) (Optional)
changeLineWidthsnumberThe amount line widths are to be scaled (expressed as a percentage) (default: 100.0) (Optional)
scaleAboutTransformation:
Transformation.DOCUMENTORIGIN
Transformation.TOPLEFT
Transformation.LEFT
Transformation.BOTTOMLEFT
Transformation.TOP
Transformation.CENTER
Transformation.BOTTOM
Transformation.TOPRIGHT
Transformation.RIGHT
Transformation.BOTTOMRIGHT
The point on the art item's bounding box to which the scale is applied. (default: Transformation.CENTER) (Optional)

void rotate (angle: number[, changePositions: bool=true][, changeFillPatterns: bool=true][, changeFillGradients: bool=true][, changeStrokePattern: bool=true][, rotateAbout: Transformation=Transformation.CENTER])
Rotate art object(s)

ParameterTypeDescription
anglenumberAngle of rotation (in degrees). Rotation is performed counter-clock wise.
changePositionsboolAre art object positions and orientations effected? (default: true) (Optional)
changeFillPatternsboolAre the fill patterns assigned to paths to be transformed? (default: true) (Optional)
changeFillGradientsboolAre the fill gradients assigned to paths to be transformed? (default: true) (Optional)
changeStrokePatternboolAre the stroke patterns assigned to paths to be transformed? (default: true) (Optional)
rotateAboutTransformation:
Transformation.DOCUMENTORIGIN
Transformation.TOPLEFT
Transformation.LEFT
Transformation.BOTTOMLEFT
Transformation.TOP
Transformation.CENTER
Transformation.BOTTOM
Transformation.TOPRIGHT
Transformation.RIGHT
Transformation.BOTTOMRIGHT
The point on the art item's bounding box to which the rotation is applied. (default: Transformation.CENTER) (Optional)

string sendScriptMessage (pluginName: string, messageSelector: string, inputString: string)
Sends the script message to the required plugin.

ParameterTypeDescription
pluginNamestringPlugin to which message needs to be sent.
messageSelectorstringFunctionality that is to be executed.
inputStringstringPass any data encoded in a string.

void transform (transformationMatrix: Matrix[, changePositions: bool=true][, changeFillPatterns: bool=true][, changeFillGradients: bool=true][, changeStrokePattern: bool=true][, changeLineWidths: number=100.0][, transformAbout: Transformation=Transformation.CENTER])
Transform art object(s) using a transformation matrix.

ParameterTypeDescription
transformationMatrixMatrixThe transformation matrix to be applied to the objects.
changePositionsboolAre art object positions and orientations effected? (default: true) (Optional)
changeFillPatternsboolAre the fill patterns assigned to paths to be transformed? (default: true) (Optional)
changeFillGradientsboolAre the fill gradients assigned to paths to be transformed? (default: true) (Optional)
changeStrokePatternboolAre the stroke patterns assigned to paths to be transformed? (default: true) (Optional)
changeLineWidthsnumberThe amount line widths are to be scaled (expressed as a percentage) (default: 100.0) (Optional)
transformAboutTransformation:
Transformation.DOCUMENTORIGIN
Transformation.TOPLEFT
Transformation.LEFT
Transformation.BOTTOMLEFT
Transformation.TOP
Transformation.CENTER
Transformation.BOTTOM
Transformation.TOPRIGHT
Transformation.RIGHT
Transformation.BOTTOMRIGHT
The point on the art item's bounding box to which scale and rotation operations apply. (default: Transformation.CENTER) (Optional)

void translate ([deltaX: number=0.0][, deltaY: number=0.0][, transformObjects: bool=true][, transformFillPatterns: bool=true][, transformFillGradients: bool=true][, transformStrokePattern: bool=true])
Reposition art object(s)

ParameterTypeDescription
deltaXnumberHorizontal transformation. (default: 0.0) (Optional)
deltaYnumberVertical transformation. (default: 0.0) (Optional)
transformObjectsboolAre art object positions and orientations affected? (default: true) (Optional)
transformFillPatternsboolAre the fill patterns assigned to paths to be transformed? (default: true) (Optional)
transformFillGradientsboolAre the fill gradients assigned to paths to be transformed? (default: true) (Optional)
transformStrokePatternboolAre the stroke patterns assigned to paths to be transformed? (default: true) (Optional)

void zOrder (zOrderCmd: ZOrderMethod)
Arranges the art relative to other art in the group or layer.

ParameterTypeDescription
zOrderCmdZOrderMethod:
ZOrderMethod.BRINGTOFRONT
ZOrderMethod.BRINGFORWARD
ZOrderMethod.SENDBACKWARD
ZOrderMethod.SENDTOBACK
How to arrange the art.

Element of

TracingObject.sourceArt

Used in:

Symbol Symbols.add (sourceArt: PageItem[, registrationPoint: SymbolRegistrationPoint=SymbolRegistrationPoint.SYMBOLCENTERPOINT])

Return

PageItem Document.rasterize (sourceArt: any[, clipBounds: Rectangle][, options: RasterizeOptions])

PageItem PageItem.duplicate (relativeObject: Object, insertionLocation: ElementPlacement)

PageItem PageItem.move (relativeObject: Object, insertionLocation: ElementPlacement)

PageItem PageItems.getByName (name: string)

PageItem TracingObject.releaseTracing ()

Jongware, 25-Nov-2012 v3.0.3iContents :: Index