SymbolItem
SymbolItem
Section titled “SymbolItem”app.activeDocument.symbolItems[index]
Description
Section titled “Description”An art item made reusable by adding it to the Symbols palette.
A SymbolItem is linked to the Symbol from which it was created and changes if you modify the associated Symbol object.
Properties
Section titled “Properties”SymbolItem.artworkKnockout
Section titled “SymbolItem.artworkKnockout”app.activeDocument.symbolItems[index].artworkKnockout
Description
Section titled “Description”Is this object used to create a knockout, and if so, what kind of knockout.
SymbolItem.blendingMode
Section titled “SymbolItem.blendingMode”app.activeDocument.symbolItems[index].blendingMode
Description
Section titled “Description”The blend mode used when compositing an object.
SymbolItem.controlBounds
Section titled “SymbolItem.controlBounds”app.activeDocument.symbolItems[index].controlBounds
Description
Section titled “Description”The bounds of the object including stroke width and controls.
Array of 4 Numbers; read-only.
SymbolItem.editable
Section titled “SymbolItem.editable”app.activeDocument.symbolItems[index].editable
Description
Section titled “Description”If true, this item is editable.
Boolean; read-only.
SymbolItem.geometricBounds
Section titled “SymbolItem.geometricBounds”app.activeDocument.symbolItems[index].geometricBounds
Description
Section titled “Description”The bounds of the object excluding stroke width.
Array of 4 Numbers; read-only.
SymbolItem.height
Section titled “SymbolItem.height”app.activeDocument.symbolItems[index].height
Description
Section titled “Description”The height of the group item.
Number (double)
SymbolItem.hidden
Section titled “SymbolItem.hidden”app.activeDocument.symbolItems[index].hidden
Description
Section titled “Description”If true, this item is hidden.
Boolean
SymbolItem.isIsolated
Section titled “SymbolItem.isIsolated”app.activeDocument.symbolItems[index].isIsolated
Description
Section titled “Description”If true, this object is isolated.
Boolean
SymbolItem.layer
Section titled “SymbolItem.layer”app.activeDocument.symbolItems[index].layer
Description
Section titled “Description”The layer to which this item belongs.
Layer; read-only.
SymbolItem.left
Section titled “SymbolItem.left”app.activeDocument.symbolItems[index].left
Description
Section titled “Description”The position of the left side of the item (in points, measured from the left side of the page).
Number (double)
SymbolItem.locked
Section titled “SymbolItem.locked”app.activeDocument.symbolItems[index].locked
Description
Section titled “Description”If true, this item is locked.
Boolean
SymbolItem.name
Section titled “SymbolItem.name”app.activeDocument.symbolItems[index].name
Description
Section titled “Description”The name of this item.
String
SymbolItem.note
Section titled “SymbolItem.note”app.activeDocument.symbolItems[index].note
Description
Section titled “Description”The note assigned to this item.
String
SymbolItem.opacity
Section titled “SymbolItem.opacity”app.activeDocument.symbolItems[index].opacity
Description
Section titled “Description”The opacity of the object.
Range: 0.0 to 100.0
Number (double)
SymbolItem.parent
Section titled “SymbolItem.parent”app.activeDocument.symbolItems[index].parent
Description
Section titled “Description”The parent of this object.
Layer or GroupItem; read-only.
SymbolItem.position
Section titled “SymbolItem.position”app.activeDocument.symbolItems[index].position
Description
Section titled “Description”The position (in points) of the top left corner of the symbolItem object in the format [x, y]. Does not include stroke weight.
Array of 2 Numbers
SymbolItem.selected
Section titled “SymbolItem.selected”app.activeDocument.symbolItems[index].selected
Description
Section titled “Description”If true, this item is selected.
Boolean
SymbolItem.sliced
Section titled “SymbolItem.sliced”app.activeDocument.symbolItems[index].sliced
Description
Section titled “Description”If true, the item sliced.
Default: false
Boolean
SymbolItem.symbol
Section titled “SymbolItem.symbol”app.activeDocument.symbolItems[index].symbol
Description
Section titled “Description”The symbol that was used to create this symbolItem.
SymbolItem.tags
Section titled “SymbolItem.tags”app.activeDocument.symbolItems[index].tags
Description
Section titled “Description”The tags contained in this item.
Tags; read-only.
SymbolItem.top
Section titled “SymbolItem.top”app.activeDocument.symbolItems[index].top
Description
Section titled “Description”The position of the top of the item (in points, measured from the bottom of the page).
Number (double)
SymbolItem.typename
Section titled “SymbolItem.typename”app.activeDocument.symbolItems[index].typename
Description
Section titled “Description”The class name of the referenced object.
String; read-only.
SymbolItem.uRL
Section titled “SymbolItem.uRL”app.activeDocument.symbolItems[index].uRL
Description
Section titled “Description”The value of the Adobe URL tag assigned to this item.
String
SymbolItem.visibilityVariable
Section titled “SymbolItem.visibilityVariable”app.activeDocument.symbolItems[index].visibilityVariable
Description
Section titled “Description”The visibility variable bound to the item.
Variable
SymbolItem.visibleBounds
Section titled “SymbolItem.visibleBounds”app.activeDocument.symbolItems[index].visibleBounds
Description
Section titled “Description”The visible bounds of the item including stroke width.
Array of 4 Numbers; read-only.
SymbolItem.width
Section titled “SymbolItem.width”app.activeDocument.symbolItems[index].width
Description
Section titled “Description”The width of the item.
Number (double)
SymbolItem.wrapInside
Section titled “SymbolItem.wrapInside”app.activeDocument.symbolItems[index].wrapInside
Description
Section titled “Description”If true, the text frame object should be wrapped inside this object.
Boolean
SymbolItem.wrapOffset
Section titled “SymbolItem.wrapOffset”app.activeDocument.symbolItems[index].wrapOffset
Description
Section titled “Description”The offset to use when wrapping text around this object.
Number (double)
SymbolItem.wrapped
Section titled “SymbolItem.wrapped”app.activeDocument.symbolItems[index].wrapped
Description
Section titled “Description”If true, wrap text frame objects around this object (text frame must be above the object).
Boolean
SymbolItem.zOrderPosition
Section titled “SymbolItem.zOrderPosition”app.activeDocument.symbolItems[index].zOrderPosition
Description
Section titled “Description”The position of this item within the stacking order of the group or layer (parent) that contains the item.
Number; read-only.
Methods
Section titled “Methods”SymbolItem.duplicate()
Section titled “SymbolItem.duplicate()”app.activeDocument.symbolItems[index].duplicate([relativeObject][, insertionLocation])
Description
Section titled “Description”Creates a duplicate of the selected object.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
relativeObject | Object, optional | Object to duplicate to |
insertionLocation | ElementPlacement, optional | Location to insert element |
Returns
Section titled “Returns”SymbolItem.move()
Section titled “SymbolItem.move()”app.activeDocument.symbolItems[index].move(relativeObject, insertionLocation)
Description
Section titled “Description”Moves the object.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
relativeObject | Object | Object to move element within |
insertionLocation | ElementPlacement, optional | Location to move element to |
Returns
Section titled “Returns”SymbolItem.remove()
Section titled “SymbolItem.remove()”app.activeDocument.symbolItems[index].remove()
Description
Section titled “Description”Deletes this object.
Returns
Section titled “Returns”Nothing.
SymbolItem.resize()
Section titled “SymbolItem.resize()”app.activeDocument.symbolItems[index].resize( scaleX, scaleY [,changePositions] [,changeFillPatterns] [,changeFillGradients] [,changeStrokePattern] [,changeLineWidths] [,scaleAbout])Description
Section titled “Description”Scales the art item where scaleX is the horizontal scaling factor and scaleY is the vertical scaling factor. 100.0 = 100%.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
scaleX | Number (double) | Horizontal scaling factor |
scaleY | Number (double) | Vertical scaling factor |
changePositions | Boolean, optional | Whether to effect art object positions and orientations |
changeFillPatterns | Boolean, optional | Whether to transform fill patterns |
changeFillGradients | Boolean, optional | Whether to transform fill gradients |
changeStrokePattern | Boolean, optional | Whether to transform stroke patterns |
changeLineWidths | Number (double), optional | The amount to scale line widths |
scaleAbout | Transformation, optional | The point to use as anchor, to transform about |
Returns
Section titled “Returns”Nothing.
SymbolItem.rotate()
Section titled “SymbolItem.rotate()”app.activeDocument.symbolItems[index].rotate( angle [,changePositions] [,changeFillPatterns] [,changeFillGradients] [,changeStrokePattern] [,rotateAbout])Description
Section titled “Description”Rotates the art item relative to the current rotation.
The object is rotated counter-clockwise if the angle value is positive, clockwise if the value is negative.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
angle | Number (double) | The angle amount to rotate the element |
changePositions | Boolean, optional | Whether to effect art object positions and orientations |
changeFillPatterns | Boolean, optional | Whether to transform fill patterns |
changeFillGradients | Boolean, optional | Whether to transform fill gradients |
changeStrokePattern | Boolean, optional | Whether to transform stroke patterns |
rotateAbout | Transformation, optional | The point to use as anchor, to transform about |
Returns
Section titled “Returns”Nothing.
SymbolItem.transform()
Section titled “SymbolItem.transform()”app.activeDocument.symbolItems[index].transform( transformationMatrix [, changePositions] [, changeFillPatterns] [, changeFillGradients] [, changeStrokePattern] [, changeLineWidths] [, transformAbout])Description
Section titled “Description”Transforms the art item by applying a transformation matrix.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
transformationMatrix | Matrix | Transformation matrix to apply |
changePositions | Boolean, optional | Whether to change Positions |
changeFillPatterns | Boolean, optional | Whether to change Fill Patterns |
changeFillGradients | Boolean, optional | Whether to change Fill Gradients |
changeStrokePattern | Boolean, optional | Whether to change Stroke Pattern |
changeLineWidths | Number (double), optional | The amount to scale line widths |
transformAbout | Transformation, optional | The point to use as anchor, to transform about |
Returns
Section titled “Returns”Nothing.
SymbolItem.translate()
Section titled “SymbolItem.translate()”app.activeDocument.symbolItems[index].translate( [deltaX] [, deltaY] [, transformObjects] [, transformFillPatterns] [, transformFillGradients] [, transformStrokePatterns])Description
Section titled “Description”Repositions the art item relative to the current position, where deltaX is the horizontal offset and deltaY is the vertical offset.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
deltaX | Number (double), optional | Horizontal offset |
deltaY | Number (double), optional | Vertical offset |
transformObjects | Boolean, optional | Whether to transform Objects |
transformFillPatterns | Boolean, optional | Whether to transform Fill Patterns |
transformFillGradients | Boolean, optional | Whether to transform Fill Gradients |
transformStrokePatterns | Boolean, optional | Whether to transform Stroke Patterns |
Returns
Section titled “Returns”Nothing.
SymbolItem.zOrder()
Section titled “SymbolItem.zOrder()”app.activeDocument.symbolItems[index].zOrder(zOrderCmd)
Description
Section titled “Description”Arranges the art item’s position in the stacking order of the group or layer (parent) of this object.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
zOrderCmd | ZOrderMethod | Stacking order arrangement method |
Returns
Section titled “Returns”Nothing.