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

Constructors

Document(file, colorModel, dialogStatus)
Opens an existing document.
Parameters:
file: File - the file to read from
colorModel: Number - the document's desired color model, Color.MODEL_* values
dialogStatus: Number - how dialogs should be handled, Document.DIALOG_* values
Document(title, width, height, colorModel, dialogStatus)
Creates a new document.
Parameters:
title: String - the title of the document
width: Number - the width of the document
height: Number - the height of the document
colorModel: Number - the document's desired color model, Color.MODEL_* values
dialogStatus: Number - how dialogs should be handled, Document.DIALOG_* values

Properties

activeLayer
Read-only.
Returns:
activeSymbol
Read-only.
Returns:
activeView
Read-only.
Returns:
compoundPathItems
Read-only.
Returns:
cropBox
Returns:
dictionary
Returns:
Object
file
Read-only.
Returns:
fileFormats
Read-only.
Returns:
Array of String
gradients
Read-only.
Returns:
groupItems
Read-only.
Returns:
layers
Read-only.
Returns:
modified
Returns:
Boolean
pageOrigin
Returns:
pathItems
Read-only.
Returns:
rasterItems
Read-only.
Returns:
rulerOrigin
Returns:
selectedItems
Read-only.
Returns:
size
Returns:
stories
Read-only.
Returns:
TextStoryList
swatches
Read-only.
Returns:
symbols
Read-only.
Returns:
textItems
Read-only.
Returns:
views
Read-only.
Returns:
DIALOG_NONE
Returns:
Number
DIALOG_OFF
Returns:
Number
DIALOG_ON
Returns:
Number
DIALOG_PARTIAL_ON
Returns:
Number

Functions

activate(focus)
Activates this document, so all newly created art objects will be placed in it.
Parameters:
focus: Boolean - When set to true, the document window is brought to the front, otherwise the window sequence remains the same.
close()
Closes the document
copy()
Copies the selected items to the clipboard
createAreaText(area[, orient])
Parameters:
area: Path
orient: Number
Returns:
createCircle(x, y, radius)
Parameters:
x: Number
y: Number
radius: Number
Returns:
createCircle(center, radius)
Parameters:
center: Point
radius: Number
Returns:
createCompoundPath(children)
Parameters:
children: ExtendedList
Returns:
createCompoundPath(children)
Parameters:
children: Array of Art
Returns:
createCompoundPath(shape)
Parameters:
shape: Shape
Returns:
createGroup(children)
Parameters:
children: ExtendedList
Returns:
createGroup(children)
Parameters:
children: Array of Art
Returns:
createLayer()
Returns:
createOval(rect[, circumscribed])
Creates an oval shaped path
Parameters:
rect: Rectangle
circumscribed: Boolean - if this is set to true the oval shaped path will be created so the rectangle fits into it. If it's set to false the oval path will fit within the rectangle.
Returns:
Path - the newly created path
createPath(segments)
Parameters:
segments: ExtendedList
Returns:
createPathText(path[, orient])
Parameters:
path: Path
orient: Number
Returns:
createPointText(point[, orient])
Parameters:
point: Point
orient: Number
Returns:
createRaster(type[, width, height])
Parameters:
type: Number
width: Number
height: Number
Returns:
createRectangle(rect)
Creates a rectangular path
Parameters:
rect: Rectangle
Returns:
Path - the newly created path
createRegularPolygon(numSides, center, radius)
Creates a regular polygon shaped path
Parameters:
numSides: Number - the number of sides of the polygon
center: Point
radius: Number
Returns:
Path - the newly created path
createRoundRectangle(rect, hor, ver)
Creates a rectangular path with rounded corners
Parameters:
rect: Rectangle
hor: Number
ver: Number
Returns:
Path - the newly created path
createSpiral(firstArcCenter, start, decayPercent, numQuarterTurns, clockwiseFromOutside)
Creates a spiral shaped path
Parameters:
firstArcCenter: Point - the center point of the first arc
start: Point - the starting point of the spiral
decayPercent: Number - the percentage by which each succeeding arc will be scaled
numQuarterTurns: Number - the number of quarter turns (arcs)
clockwiseFromOutside: Boolean - if this is set to true the spiral will spiral in a clockwise direction from the first point.
If it's set to false it will spiral in a counter clockwise direction
Returns:
Path - the newly created path
createStar(numPoints, center, radius1, radius2)
Created a star shaped path The largest of radius1 and radius2 will be the outer radius of the star. The smallest of radius1 and radius2 will be the inner radius.
Parameters:
numPoints: Number - the number of points of the star
center: Point
radius1: Number
radius2: Number
Returns:
Path - the newly created path
cut()
Cuts the selected items to the clipboard
deselectAll()
Deselects all the selected items in the document.
getMatchingItems(type, attributes)
Parameters:
type: Class
attributes: Object
Returns:
hasSelectedItems()
Checks wether the document contains any selected items.
Returns:
Boolean - true if the document contains selected items, false otherwise.
hitTest(point[, type[, tolerance]])
Parameters:
point: Point
type: Number - HitTest.TEST_*
tolerance: Number
Returns:
invalidate(x, y, width, height)
Invalidates the rectangle in artwork coordinates. This will cause all views of the document that contain the given rectangle to update at the next opportunity.
Parameters:
x: Number
y: Number
width: Number
height: Number
invalidate(rect)
Parameters:
rect: Rectangle
paste()
Pastes the selected items to the clipboard
place(file[, linked])
Places a file in the document
Parameters:
file: File - the file to place
linked: Boolean - when set to true, the placed object is a link to the file, otherwise it is embedded within the document
Returns:
Art
print(dialogStatus)
Prints the document
Parameters:
dialogStatus: Number - Document.DIALOG_*
redraw()
Forces the document to be redrawn
reflowText()
Text reflow is suspended during script execution. when reflowText() is called, the reflow of text is forced.
save()
Saves the document
setSize(width, height)
setSize only works while reading a document!
Parameters:
width: Number
height: Number
write(file[, format[, ask]])
Parameters:
file: File
format: String
ask: Boolean
Returns:
Boolean