Sg2.0
Art
Packages
About
News
Gallery
Scripts
Download
Documentation
Reference
Forum
Users
 

Art

Properties

alphaIsShape
Returns:
Boolean
blendMode
The art item's blend mode as specified by the Art.BLEND_* staticproperties.
Returns:
Number
bounds
Read-only.The bounds of the art item including stroke width.
Returns:
centerVisible
Returns:
Boolean
children
Read-only.An array of art items contained within this art item
Returns:
Array of Art
clipMask
A boolean value that specifies whether the art item defines a clip mask.This can only be set on paths, compound paths, and text frame objects,and only if the item is already contained within a clip group.Sample code:
var group = new Group();group.appendChild(path);group.clipped = true;path.clipMask = true;
Returns:
Boolean
controlBounds
Read-only.The bounds of the art item including stroke width and controls.
Returns:
dictionary
Returns:
Object
document
Read-only.Returns the document that the art item belongs to.
Returns:
editable
Read-only.
Returns:
Boolean
firstChild
Read-only.Returns the first art item contained within this art item.
Returns:
Art
fullySelected
A boolean value that specifies whether the art item is fullyselected. For paths this means that all segments are selected,for container objects all children are selected.
Returns:
Boolean
geometricBounds
Read-only.The bounds of the art item excluding stroke width.
Returns:
hidden
A boolean value that specifies whether the art item is hidden.Sample code:
var path = new Path();print(path.hidden) // returns falsepath.hidden = true; // hides the pathprint(path.hidden) // returns true
Returns:
Boolean
isolated
Returns:
Boolean
knockout
Returns:
Boolean
knockoutInherited
Read-only.
Returns:
Boolean
lastChild
Read-only.Returns the last art item contained within this art item.
Returns:
Art
locked
A boolean value that specifies whether the art item is locked.Sample code:
var path = new Path();print(path.locked) // returns falsepath.locked = true; // locks the pathprint(path.locked) // returns true
Returns:
Boolean
millis
Read-only.
Returns:
Number
name
The name of the art item as it appears in the layers palette.Sample code:
var layer = new Layer(); // a layer is an art itemprint(layer.name); // returns '<Layer 2>'layer.name = "A nice name";print(layer.name); // returns 'A nice name'
Returns:
String
nextSibling
Read-only.Returns the next art item on the same level as this art item.
Returns:
Art
opacity
A value between 0 and 1 that specifies the opacity of the art item.
Returns:
Number
parent
Read-only.Returns the art item that this art item is contained within.
Returns:
Art
previousSibling
Read-only.Returns the previous art item on the same level as this art item.
Returns:
Art
selected
A boolean value that specifies whether an art item is selected.Returns true if the art item is selected or partially selected (groups withsome selected objects/partially selected paths), false otherwise.Sample code:
print(activeDocument.selectedItems.length) // returns 0var path = new Path(); // new art items are always created in the active layerpath.selected = true; // select the pathprint(activeDocument.selectedItems.length) // returns 1
Returns:
Boolean
style
Returns:
valid
Read-only.
Returns:
Boolean
ATTR_EXPANDED
Returns:
Number
ATTR_FULLY_SELECTED
Returns:
Number
ATTR_HAS_ACTIVE_STYLE
Returns:
Number
ATTR_HAS_SIMPLE_STYLE
Returns:
Number
ATTR_HIDDEN
Returns:
Number
ATTR_IS_CLIPMASK
Returns:
Number
ATTR_IS_TEXTWRAP
Returns:
Number
ATTR_LOCKED
Returns:
Number
ATTR_PART_OF_COMPOUND
Returns:
Number
ATTR_SELECTED
Returns:
Number
ATTR_SELECTED_LAYERS
Returns:
Number
ATTR_STYLE_IS_DIRTY
Returns:
Number
ATTR_TARGETED
Returns:
Number
BLEND_COLOR
Returns:
Number
BLEND_COLORBURN
Returns:
Number
BLEND_COLORDODGE
Returns:
Number
BLEND_DARKEN
Returns:
Number
BLEND_DIFFERENCE
Returns:
Number
BLEND_EXCLUSION
Returns:
Number
BLEND_HARDLIGHT
Returns:
Number
BLEND_HUE
Returns:
Number
BLEND_LIGHTEN
Returns:
Number
BLEND_LUMINOSITY
Returns:
Number
BLEND_MULTIPLY
Returns:
Number
BLEND_NORMAL
Returns:
Number
BLEND_NUMS
Returns:
Number
BLEND_OVERLAY
Returns:
Number
BLEND_SATURATION
Returns:
Number
BLEND_SCREEN
Returns:
Number
BLEND_SOFTLIGHT
Returns:
Number
EXPAND_GRADIENTTOMESH
Returns:
Number
EXPAND_GRADIENTTOPATHS
Returns:
Number
EXPAND_LOCKEDOBJECTS
Returns:
Number
EXPAND_ONEATATIME
Returns:
Number
EXPAND_PATTERN
Returns:
Number
EXPAND_PLUGINART
Returns:
Number
EXPAND_SHOWPROGRESS
Returns:
Number
EXPAND_STROKE
Returns:
Number
EXPAND_SYMBOLINSTANCES
Returns:
Number
EXPAND_TEXT
EXPAND_TEXT
Returns:
Number
KNOCKOUT_INHERIT
Returns:
Number
KNOCKOUT_OFF
Returns:
Number
KNOCKOUT_ON
Returns:
Number
KNOCKOUT_UNKNOWN
Returns:
Number
ORDER_ABOVE
Returns:
Number
ORDER_ANCHESTOR
Returns:
Number
ORDER_BELOW
Returns:
Number
ORDER_INSIDE
Returns:
Number
ORDER_UNKNOWN
Returns:
Number
TRANSFORM_CHILDREN
Returns:
Number
TRANSFORM_FILL_GRADIENTS
Returns:
Number
TRANSFORM_FILL_PATTERNS
Returns:
Number
TRANSFORM_LINES
Returns:
Number
TRANSFORM_LINKED_MASKS
Returns:
Number
TRANSFORM_OBJECTS
Returns:
Number
TRANSFORM_SELECTION_ONLY
Returns:
Number
TRANSFORM_STROKE_PATTERNS
Returns:
Number

Functions

appendChild(art)
Appends the specified art item as a child of this art item.
You can use this function for groups, compound paths and layers.
Sample code:
 var group = new Group();
 var path = new Path();
 group.appendChild(path);
 print(path.isInside(group)) // returns true
Parameters:
art: Art - The art item that will be appended as a child
Returns:
Boolean
clone()
Clones the art item within the same document.
Returns:
Object - the newly cloned art object
copyTo(document)
Copies the art item to another document, or duplicates it within the same document.
Parameters:
document: Document - the document to copy the art item to
Returns:
Art - the new copy of the art item
copyTo(art)
Copies the art item into the specified art item.
Parameters:
art: Art
Returns:
Art
expand(flags, steps)
Breaks artwork up into individual parts and works just like calling "expand" from the Object menu in Illustrator.
It outlines stroked lines, text objects, gradients, patterns, etc.
The art item itself is removed, and the newly created item containing the expanded artwork is returned.
Parameters:
flags: Number - #EXPAND_*
steps: Number
Returns:
Art - the newly created item containing the expanded artwork
hasChildren()
Checks if the art object has children.
Returns:
Boolean - true if it has one or more children, false otherwise
hitTest(point[, type[, tolerance]])
Parameters:
point: Point
type: Number
tolerance: Number
Returns:
isAbove(art)
Checks if this art item is above the specified art item in the stacking order of the document.
Sample code:
 var firstPath = new Path();
 var secondPath = new Path();
 print(secondPath.isAbove(firstPath)) // returns true
Parameters:
art: Art - The art item to check against
Returns:
Boolean - true if it is above the specified art item, false otherwise
isAncestor(art)
Checks if this art item is an ancestor of the specified art item.
Sample code:
 var group = new Group();
 var path = new Path();
 group.appendChild(path);
 print(group.isAncestor(path)) // returns true
Parameters:
art: Art - the art item to check against
Returns:
Boolean - true if it is an ancestor of the specified art item, false otherwise
isBelow(art)
Checks if the art item is below the specified art item in the stacking order of the document Sample code:
 var firstPath = new Path();
 var secondPath = new Path();
 print(firstPath.isBelow(secondPath)) // returns true
Parameters:
art: Art - The art item to check against
Returns:
Boolean - true if it is below the specified art item, false otherwise
isDefaultName()
Checks if the art item's name as it appears in the layers palette is a default descriptive name, rather then a user-assigned name.
Returns:
Boolean - true if it's name is default, false otherwise.
isInside(art)
Checks if the art item is contained within the specified art item Sample code:
 var group = new Group();
 var path = new Path();
 group.appendChild(path);
 print(path.isInside(group)) // returns true
Parameters:
art: Art - The art item to check against
Returns:
Boolean - true if it is inside the specified art item, false otherwise
moveAbove(art)
Moves this art item above the specified art item.
Sample code:
 var firstPath = new Path();
 var secondPath = new Path();
 print(firstPath.isAbove(secondPath)) // returns false
 firstPath.moveAbove(secondPath);
 print(firstPath.isAbove(secondPath)) // returns true
Parameters:
art: Art - The art item above which it should be moved
Returns:
Boolean - true if it was moved, false otherwise
moveBelow(art)
Moves the art item below the specified art object.
 var firstPath = new Path();
 var secondPath = new Path();
 print(secondPath.isBelow(firstPath)) // returns false
 secondPath.moveBelow(firstPath);
 print(secondPath.isBelow(firstPath)) // returns true
Parameters:
art: Art - the art item below which it should be moved
Returns:
Boolean - true if it was moved, false otherwise
rasterize(type[, resolution, antialiasing[, width, height]])
Parameters:
type: Number
resolution: Number
antialiasing: Number
width: Number
height: Number
Returns:
remove()
Removes the art item from the document. If the art item has children, they are also removed.
Returns:
Boolean - true if the art item was removed, false otherwise
rotate(theta[, x, y])
Rotates the art item around an anchor point by a given angle.
Parameters:
theta: Number - the rotation angle in radians
x: Number
y: Number
See also:Matrix
rotate(theta, anchor)
Parameters:
theta: Number
anchor: Point
scale(scale[, sy])
Scales the art item by creating a scale Matrix and executing transform()
Parameters:
sx: Number
sy: Number
See also:scale(scale)
shear(shx, shy)
Shears the art item with a given amount.
Parameters:
shx: Number
shy: Number
See also:shear(shearX, shearY)
transform(matrix[, flags])
Transforms the art item with custom flags to be set.
Parameters:
matrix: Matrix
flags: Number - Art. TRANSFORM_*
translate(tx, ty)
Translates (moves) the art item by the given offsets.
Parameters:
tx: Number
ty: Number
See also:translate(pt)
translate(t)
Translates (moves) the art item by the given offset point.
Parameters:
t: Point