Classes

Alert, Application, Array, Calendar, Canvas, CanvasSizingMode, Color, ColorSpace, Console, Data, DateComponents, Decimal, Document, GraffleDocument, Email, Error, FilePicker, FileSaver, FileType, FileWrapper, FileWrapper.Type, FillType, Form, Form.Field, Form.Field.Checkbox, Form.Field.Date, Form.Field.Option, Form.Field.String, Function, Graphic, Group, Subgraph, Table, Line, Solid, Shape, GraphicView, Grid, HierarchicalDirection, HopType, HorizontalAlignment, HorizontalTextAlignment, Image, ImageReference, ImageSizing, Layer, Layout, LayoutType, LineCap, LineJoin, LineType, Locale, MenuItem, NSWindow, OGOutlineNode, Pasteboard, PlugIn, PlugIn.Action, PlugIn.Handler, PlugIn.Handler.Registration, PlugIn.Library, Point, Portfolio, Promise, Rect, Selection, ShapeCombination, Size, Stencil, StrokeDash, StrokeType, TextAutosizing, TextFlow, TimeZone, Timer, ToolbarItem, URL, Version, VerticalAlignment, VerticalTextPlacement

Alert

An alert interface for displaying information to the user, blocking further interaction until the alert is dismissed.

Constructors

new Alert(title:String, message:String)Alert

Create a new alert panel with the given title and text contents.

Instance Functions

function show(callback:Function or null)Promise

Displays the alert, unless an alert is already being displayed, in which case an error is thrown. If no options have yet been added, a default "OK" option is added. Once the user selects an option, the alert is dismissed. If a callback function was supplied, it is invoked with the zero-based index of the selected option as its argument. A Promise is returned as well, which may also be used to collect the result of the Alert.

function addOption(string:String)

Adds an option button to the alert.

Application

An object representing the OmniGraffle application itself. The type of the global variable app.

Instance Functions

function openDocument(from:Document or null, url:URL, completed:Function)

Attempts to open the specified document and return a reference to it asynchronously. If the document is already open, the reference is passed along. Note that due to platform sandboxing restrictions, opening the document may fail if the application doesn't have currently permission to access the given URL. The document, if any, that is associated with the calling script can be passed along to help grant permission to open the new document. The passed in function will be passed two argument. The first will be either either the Document or an Error. On success, the second argument is a Boolean specifying whether the document was already open.

Instance Properties

var commandKeyDownBoolean read-only

No documentation available.

var controlKeyDownBoolean read-only

No documentation available.

var nameString read-only

Application name.

var optionKeyDownBoolean read-only

No documentation available.

var platformNameString read-only

No documentation available.

var shiftKeyDownBoolean read-only

No documentation available.

var stencilsArray of Stencil read-only

List of stencils that OmniGraffle currently has available.

var versionString read-only

Application version number.

Array

A JavaScript Array.

Calendar

No documentation available.

Class Properties

var buddhistCalendar read-only

No documentation available.

var chineseCalendar read-only

No documentation available.

var copticCalendar read-only

No documentation available.

var currentCalendar read-only

The user's preferred calendar

var ethiopicAmeteAlemCalendar read-only

No documentation available.

var ethiopicAmeteMihretCalendar read-only

No documentation available.

var gregorianCalendar read-only

The Gregorian calendar.

var hebrewCalendar read-only

No documentation available.

var indianCalendar read-only

No documentation available.

var islamicCalendar read-only

No documentation available.

var islamicCivilCalendar read-only

No documentation available.

var islamicTabularCalendar read-only

No documentation available.

var islamicUmmAlQuraCalendar read-only

No documentation available.

var iso8601Calendar read-only

No documentation available.

var japaneseCalendar read-only

No documentation available.

var persianCalendar read-only

No documentation available.

var republicOfChinaCalendar read-only

No documentation available.

Instance Functions

function dateByAddingDateComponents(date:Date, components:DateComponents)Date or null

Returns a new Date by adding the given DateComponents, or null if no date could be calculated.

function dateFromDateComponents(components:DateComponents)Date or null

Returns a new Date from the given DateComponents, or null if no date could be calculated.

function dateComponentsFromDate(date:Date)DateComponents

Returns a new DateComponents for the given Date.

function dateComponentsBetweenDates(start:Date, end:Date)DateComponents

Returns the difference from the start Date to the end Date as a DateComponents.

function startOfDay(date:Date)Date

Returns a Date for the first moment of the day containing the given Date according to this Calendar.

Instance Properties

var identifierString read-only

The ISO identifier for the calendar.

var localeLocale or null read-only

The locale of the calendar.

var timeZoneTimeZone read-only

The time zone of the calendar.

Canvas

No documentation available.

Instance Functions

function layout()

Perform automatic layout of all graphics on this canvas.

function layoutGraphics(graphics:Array of Graphic)

Perform automatic layout of only the given graphics (all of which need to be on this canvas).

function addShape(shapeName:String, bounds:Rect)Shape

Create a new graphic of a given shape and place it on the first visible and unlocked layer.

function newShape()Shape

Create a zero-sized rectangle (presumably to be modified further) and place it on the first visible and unlocked layer.

function newLayer()Layer

Create a new (top-most) layer.

function addLine(start:Point, end:Point)Line

Create a new line between two points and place it on the first visible layer.

function newLine()Line

Create a new zero-length line (presumably to be modified further) and place it on the first visible layer.

function addText(text:String, origin:Point)Solid

Create a new shape containing text (with no stroke or shadow) and place it on the first visible layer.

function connect(from:Graphic, to:Graphic)Line

Create a new line connecting two existing graphics.

function duplicate(graphics:Array of Graphic)Array of Graphic

Duplicate existing graphics onto new graphics placed upon this canvas. The original graphics may be from elsewhere - such as from another canvas, a stencil, or another document.

function orderBefore(model:Canvas)

Reorder this canvas to be before another canvas in this document.

function orderAfter(model:Canvas)

Reorder this canvas to be after another canvas in this document.

function remove()

Remove this canvas from the document, deleting it.

function graphicWithId(id:Number)Graphic or null

Get the graphic with the given id, if it exists on this canvas.

function graphicWithName(name:String)Graphic or null

Get the first graphic with the given name, if any. Note that most graphics do not have names unless they are explicitly set; instead they will be displayed using a placeholder string (such as "Rectangle") in the outline.

function allGraphicsWithUserDataForKey(data:String, key:String)Array of Graphic

Get all graphics with the given data string for the user data key.

function graphicWithUserDataForKey(data:String, key:String)Graphic or null

Get the first graphic with the given data string for the user data key, if any.

function combine(shapes:Array of Shape, operation:ShapeCombination, replaceOriginal:Boolean or null)Shape or null

No documentation available.

function onGraphicChanged(handler:PlugIn.Handler)PlugIn.Handler.Registration or null

A handler called when any graphic on this canvas changes any properties.

Instance Properties

var autosizesDownBoolean

Should the canvas automatically grow when graphics are added below the current bounds.

var autosizesLeftBoolean

Should the canvas automatically grow when graphics are added to the left of the current bounds.

var autosizesRightBoolean

Should the canvas automatically grow when graphics are added to the right of the current bounds.

var autosizesUpBoolean

Should the canvas automatically grow when graphics are added above the current bounds.

var backgroundSolid read-only

A solid graphic representing the canvas background. Its fill and image properties determine the canvas background appearance.

var canvasSizeIsMeasuredInPagesBoolean

No documentation available.

var canvasSizingModeCanvasSizingMode

No documentation available.

var columnAlignmentVerticalAlignment

Setting for how graphics ought to be aligned vertically.

var graphicsArray of Graphic read-only

All graphics upon this canvas.

var gridGrid read-only

Settings for the major and minor grids, if any.

var horizontalPagesNumber

Number of printer pages wide.

var idNumber read-only

A unique (within this document) identifying number for this canvas.

var layersArray of Layer read-only

All layers of this canvas.

var layoutInfoLayout read-only

The automatic layout information describing how graphics should be arranged.

var nameString

The title of this canvas.

var outlineRootOGOutlineNode read-only

Builds a model of all shapes in the canvas as a hierarchical outline (as in hierarchical auto layout) and returns the root of that outline.

var pageSizeSize read-only

Size of each page in points.

var rowAlignmentHorizontalAlignment

Setting for how graphics ought to be aligned horizontally.

var shapesArray of Shape read-only

No documentation available.

var sizeSize

Overall size in points.

var spaceBetweenObjectsInColumnNumber

Setting for how graphics ought to be spaced out vertically.

var spaceBetweenObjectsInRowNumber

Setting for how graphics ought to be spaced out horizontally.

var verticalPagesNumber

Number of printer pages tall.

CanvasSizingMode

No documentation available.

Class Properties

var FitCanvasSizingMode read-only

Resizes to fit its contents.

var FixedCanvasSizingMode read-only

Specific size in pages or in points.

var InfiniteCanvasSizingMode read-only

No specific size and no canvas edges.

var allArray of CanvasSizingMode read-only

An array of all items of this enumeration.

Color

No documentation available.

Class Functions

function RGB(r:Number, g:Number, b:Number, a:Number or null)Color

Makes a new color in the RGB colorspace, with the given components. If the alpha component is not given, 1.0 is used.

function HSB(h:Number, s:Number, b:Number, a:Number or null)Color

Makes a new color in the HSB colorspace, with the given components. If the alpha component is not given, 1.0 is used.

function White(w:Number, a:Number or null)Color

Makes a new color in the White colorspace, with the given components. If the alpha component is not given, 1.0 is used.

Class Properties

var blackColor read-only

A color in the White colorspace with white component of 0.0.

var blueColor read-only

A color in the RGB colorspace with components (0, 0, 1, 1).

var brownColor read-only

A color in the RGB colorspace with components (0.6, 0.4, 0.2, 1).

var clearColor read-only

A color in the White colorspace with white component of 0.0 and alpha of 0.0 ("transparent black").

var cyanColor read-only

A color in the RGB colorspace with components (0, 1, 1, 1).

var darkGrayColor read-only

A color in the White colorspace with white component of 0.333.

var grayColor read-only

A color in the White colorspace with white component of 0.5.

var greenColor read-only

A color in the RGB colorspace with components (0, 1, 0, 1).

var lightGrayColor read-only

A color in the White colorspace with white component of 0.667.

var magentaColor read-only

A color in the RGB colorspace with components (1, 0, 1, 1).

var orangeColor read-only

A color in the RGB colorspace with components (1, 0.5, 0, 1).

var purpleColor read-only

A color in the RGB colorspace with components (1, 0, 1, 1).

var redColor read-only

A color in the RGB colorspace with components (1, 0, 0, 1).

var whiteColor read-only

A color in the White colorspace with white component of 1.0.

var yellowColor read-only

A color in the RGB colorspace with components (1, 1, 0, 1).

Instance Functions

function blend(otherColor:Color, fraction:Number)Color or null

Returns a new color that is a linear combination of the receiver and fraction of the other color (so, a fraction of 1.0 would just return the otherColor. If the colors cannot be blended (for example, if they cannot be converted to the same colorspace), then null is returned.

Instance Properties

var alphaNumber read-only

Returns the alpha component of the color.

var blueNumber read-only

Returns the blue component of the color, after converting to a RGB colorspace.

var brightnessNumber read-only

Returns the brightness component of the color, after converting to a HSB colorspace.

var colorSpaceColorSpace read-only

Returns the colorspace of the instance.

var greenNumber read-only

Returns the green component of the color, after converting to a RGB colorspace.

var hueNumber read-only

Returns the hue component of the color, after converting to a HSB colorspace.

var redNumber read-only

Returns the red component of the color, after converting to a RGB colorspace.

var saturationNumber read-only

Returns the saturation component of the color, after converting to a HSB colorspace.

var whiteNumber read-only

Returns the white component of the color, after converting to a White colorspace.

ColorSpace

No documentation available.

Class Properties

var CMYKColorSpace read-only

A colorspace with cyan, magenta, yellow, black, and alpha components.

var HSBColorSpace read-only

A colorspace with hue, saturation, and value (or brightness) components.

var NamedColorSpace read-only

A space for named colors, like system defined colors, or specific color palette spaces.

var PatternColorSpace read-only

A colorspace that wraps a pattern image.

var RGBColorSpace read-only

The sRGB colorspace with red, green, blue, and alpha components.

var WhiteColorSpace read-only

A colorspace with white and alpha components.

var allArray of ColorSpace read-only

An array of all items of this enumeration.

Console

The Console allows scripts to log debugging, warning, or error information where it can be viewed in the system console or in the console output area. A single instance of Console is available to scripts as the console global variable.

Instance Functions

function log(message:Object, additional:Array of Object or null)

Appends a line to the application console formed by concatenating the given message (after converting it to a String), any additional arguments separated by spaces, and finally a newline.

function error(message:Object, additional:Array of Object or null)

No documentation available.

function info(message:Object, additional:Array of Object or null)

No documentation available.

function warn(message:Object, additional:Array of Object or null)

Just calls Console.log, currently.

function clear()

Clears the console in the user-visible window.

Data

A generic bag of bytes. Mainly useful to be interpreted / converted to some other type.

Class Functions

function fromString(string:String)Data

Convert from a String to the UTF8 encoding of that string as Data

function fromBase64(string:String)Data

No documentation available.

Instance Functions

function toString()String

Convert to a String, assuming that this Data is encoded as UTF8.

function toBase64()String

Convert to a Base-64 encoded string.

Instance Properties

var lengthNumber read-only

Number of bytes in this data.

var toObjectObject or null read-only

No documentation available.

DateComponents

No documentation available.

Constructors

new DateComponents()DateComponents

No documentation available.

Instance Properties

var dateDate or null read-only

No documentation available.

var dayNumber or null

No documentation available.

var eraNumber or null

No documentation available.

var hourNumber or null

No documentation available.

var minuteNumber or null

No documentation available.

var monthNumber or null

No documentation available.

var nanosecondNumber or null

No documentation available.

var secondNumber or null

No documentation available.

var timeZoneTimeZone or null

No documentation available.

var yearNumber or null

No documentation available.

Decimal

The Decimal class provides support for operating on base-10 numbers, which may not be exactly representable by types like the built-in JavaScript Number class. Note that Decimal does not use the built-in arithmetic operations; for example, to add two Decimal instances, you must use the add() function.

Class Functions

function fromString(string:String)Decimal

Parses the given string into a Decimal. If the string cannot be parsed, notANumber is returned.

Class Properties

var maximumDecimal read-only

Returns the maximum representable Decimal value.

var minimumDecimal read-only

Returns the minimum representable Decimal value.

var notANumberDecimal read-only

Returns a Decimal that represents a non-number value. Any arithmetic operations involving non-number values will return notANumber.

var oneDecimal read-only

Returns a Decimal representing one.

var zeroDecimal read-only

Returns a Decimal representing zero.

Instance Functions

function toString()String

Converts the Decimal to a String representation.

function add(number:Decimal)Decimal

Generates a new Decimal by adding the argument and the receiver.

function subtract(number:Decimal)Decimal

Generates a new Decimal by subtracting the argument from the receiver.

function multiply(number:Decimal)Decimal

Generates a new Decimal by multiplying the argument and the receiver.

function divide(number:Decimal)Decimal

Generates a new Decimal by dividing the receiver by the argument.

function compare(number:Decimal)Number

Compares the receiver and argument. If the receiver is less than the argument, -1 is returned. If the receiver is greater than the argument, 1 is returned. Otherwise, 0 is returned. notANumber is considered less than any valid number, and equal to itself.

function equals(number:Decimal)Boolean

Returns true if the receiver and argument represent the same number (or both are notANumber), and false otherwise.

Document

No documentation available.

Class Functions

function makeNew(resultFunction:Function)

Create a new document, which can be populated with data and then presented. On iOS, if the document is not presented by the time the resultFunction returns, it will be closed. On macOS, the document will be left around and accessible to the running script. The resultFunction will be passed either the new document or an Error if there was a problem creating the document.

function makeNewAndShow(resultFunction:Function)

Create a new document and presents it. The resultFunction will be passed either the new document or an Error if there was a problem creating the document.

Instance Functions

function close(didCancel:Function or null)

Close this document. If for some reason the document cannot be closed, the didCancel function may be called at some point in the future, with the original document as the single argument. For example, on the Mac the user may review unsaved changes and may cancel the close operation. If the document is closed, the didCancel function will not be called at all.

function save()

Save this document.

function fileWrapper(type:String or null)FileWrapper

Deprecated: Please use makeFileWrapper() instead. Returns a new FileWrapper representing the contents of the document formatted as the specified type, or its current fileType if a null is passed for the type.

function makeFileWrapper(baseName:String, type:String or null)Promise

Generates a FileWrapper representing the contents of the document formatted as the specified type, or its current fileType if a null is passed for the type. Returns a Promise that will yield the file wrapper or an error. The returned file wrapper will have a name based off the given baseName and the default path extension for the requested file type.

function undo()

Undo the last done action.

function redo()

Redo the last undone action.

function show(resultFunction:Function or null)

Presents the document, ordering the window forward on macOS, and possibly closing the existing document and opening the new on on iOS.

Instance Properties

var canRedoBoolean read-only

Whether there are currently any actions that can be redone.

var canUndoBoolean read-only

Whether there are currently any actions that can be undone.

var fileTypeString or null read-only

The file type identifier the document uses when saving, if set.

var nameString or null read-only

Document name.

var writableTypesArray of String read-only

A list of all of the file types that this document can be written as.

GraffleDocument: Document

An OmniGraffle document.

Instance Functions

function addLocalizations(text:String)

No documentation available.

Instance Properties

var portfolioPortfolio read-only

No documentation available.

var windowsArray of NSWindow read-only

No documentation available.

Email

A set of parameters for generating an email.

Constructors

new Email()Email

No documentation available.

Instance Functions

function generate()

Presents the generated email to the user for them to send (or discard). On iOS, any included attachment FileWrappers that are directories will be converted to Zip files.

Instance Properties

var blindCarbonCopyString or null

No documentation available.

var bodyString or null

No documentation available.

var carbonCopyString or null

No documentation available.

var fileWrappersArray of FileWrapper

No documentation available.

var receiverString or null

No documentation available.

var subjectString or null

No documentation available.

Error

FilePicker

A FilePicker allows the user to select URLs for files via the system-supplied file picking interface.

Constructors

new FilePicker()FilePicker

Returns a new FilePicker with default settings.

Instance Functions

function show()Promise

Presents the system file selection interface to the user, allowing them to choose one or more files of the given types. The returned Promise will yield the chosen URLs on success. If the user cancels chosing, the Promise will be rejected. Note that even when picking a single file or folder, the result will be an array of URLs.

Instance Properties

var foldersBoolean

If true, then folders may be selected, but not files. In this case, types is ignored. Defaults to false.

var messageString

A message to display describing what files are being picked. This is currently only supported on macOS.

var multipleBoolean

If true, then multiple files may be selected. Defaults to false.

var typesArray of FileType or null

The file types that will be allowed. If null, all file types will be allowed. Defaults to null.

FileSaver

A FileSaver allows the user to save a FileWrapper to a URLs via the system-supplied file picking interface.

Constructors

new FileSaver()FileSaver

Returns a new FileSaver with default settings.

Instance Functions

function show(fileWrapper:FileWrapper)Promise

Presents the system file saving interface to the user, allowing them to choose a location and file name to save the file wrapper. The returned Promise will yield the chosen URL on success. If the user cancels chosing, the Promise will be rejected.

Instance Properties

var messageString

A message to display describing what file is being saved. This is currently only supported on macOS.

var nameLabelString

The label shown next to the user-editable file name field. This is currently only supported on macOS.

var promptString

The prompt shown on the the save button. This is currently only supported on macOS.

var typesArray of FileType or null

The file types that will be allowed. If null, all file types will be allowed. Defaults to null.

FileType

No documentation available.

Class Properties

var binaryPropertyListFileType read-only

The binary property list file type.

var csvFileType read-only

The comma-separated text file type.

var editableTypesArray of FileType read-only

The list of FileTypes that can be read and written natively by documents in this application.

var gifFileType read-only

The GIF image file type.

var imageFileType read-only

A generic file type that all image types conform to.

var jpegFileType read-only

The JPEG image file type.

var jsonFileType read-only

The JSON file type.

var pdfFileType read-only

The PDF file type.

var plainTextFileType read-only

The plain text file type.

var pngFileType read-only

The PNG image file type.

var propertyListFileType read-only

The generic property list file type.

var readableTypesArray of FileType read-only

The list of FileTypes that can be read by documents in this this application.

var rtfFileType read-only

The RTF file type.

var rtfdFileType read-only

The RTFD file type.

var tiffFileType read-only

The TIFF image file type.

var writableTypesArray of FileType read-only

The list of FileTypes that can be written by documents in this application (though some documents may be exportable only in a subset of these types).

var xmlPropertyListFileType read-only

The XML property list file type.

Constructors

new FileType(identifier:String)FileType

Returns a new FileType with the given identifier.

Instance Functions

function conformsTo(fileType:FileType)Boolean

Returns true if the instance is the same as the given argument or a more specific type. For example, FileType.png.conformsTo(FileType.image) will be true, but FileType.png.conformsTo(FileType.plainText) will be false.

Instance Properties

var displayNameString read-only

Returns a human-readable description of the file type.

var identifierString read-only

Returns a unique identifier for a file type, suitable for archiving or encoding in scripts.

var pathExtensionsArray of String read-only

The list of filesystem path extensions used by this file type.

FileWrapper

No documentation available.

Class Functions

function withContents(name:String or null, contents:Data)FileWrapper

Returns a new FileWrapper that represents a flat file containing the given data.

function withChildren(name:String or null, children:Array of FileWrapper)FileWrapper

Returns a new FileWrapper that represents a directory with the given child file wrappers. Each child file wrapper must have a unique name specified.

Instance Functions

function filenameForChild(child:FileWrapper)String or null

Returns the unique file name that will be used for the given child FileWrapper, or null if this file wrapper is not a child of the receiver.

Instance Properties

var childrenArray of FileWrapper read-only

Returns an Array of child FileWrappers, if this represents a directory. Otherwise, an empty array is returned.

var contentsData or null read-only

Returns the regular file contents of the wrapper, if this represents a regular file. Otherwise, null is returned.

var destinationURL or null read-only

Returns the destination if this represents a symbolic link. Otherwise, null is returned.

var filenameString or null

Returns the actual file name that was last read for this file wrapper. Depending on the names of other sibling wrappers, this may not be what file name will be written.

var preferredFilenameString or null

Returns the preferred file name that should be used when writing the file wrapper if no other file in the same parent directory wrapper is in use.

var typeFileWrapper.Type read-only

Returns the type of this FileWrapper.

FileWrapper.Type

No documentation available.

Class Properties

var DirectoryFileWrapper.Type read-only

A FileWrapper that represents a directory with zero or more child wrappers.

var FileFileWrapper.Type read-only

A FileWrapper that represents a regular file with data contents.

var LinkFileWrapper.Type read-only

A FileWrapper that represents a symbolic link to another location.

var allArray of FileWrapper.Type read-only

An array of all items of this enumeration.

FillType

No documentation available.

Class Properties

var LinearFillType read-only

Linear Gradient.

var MarkerFillType read-only

Marker.

var PlasticFillType read-only

Plastic.

var RadialFillType read-only

Radial Gradient.

var SolidFillType read-only

Solid.

var SquiggleFillType read-only

Squiggle.

var StippleFillType read-only

Stipple.

var allArray of FillType read-only

An array of all items of this enumeration.

Form

Form provides a mechanism to collect input from the user. Each form contains one or more instances of subclasses of Field, which are given a key. As the form is filled out, values object is populated with the values from the user interface.

Constructors

new Form()Form

No documentation available.

Instance Functions

function addField(field:Form.Field, index:Number or null)

Adds the new Field to the Form, at the indicated position, or at the end if no position is specified. If the field has a default value, it will be added to the values result object immediately.

function removeField(field:Form.Field)

Removes the Field from the Form. Any entry in the values` for this field will be removed as well.

function show(title:String, confirmTitle:String)Promise

Present the Form to the user, and return a Promise to be fullfilled or rejected when the user commits or cancels the form.

Instance Properties

var fieldsArray of Form.Field read-only

The current Field instances in the form, which will be visible to the user entering input.

var validateFunction or null

A function to check whether the entered values are acceptable. The form to validate is passed as the argument and the function is expected to return a boolean result. If an Error is thrown, it's message will be displayed in the form as the reason for validation failure. Note that the validation function may add or remove fields and update entries in the values object (which will cause the interface to be updated). This is called any time the user edits values, or a field is added or removed.

var valuesObject read-only

An object with the collected values for each field, stored under the key for that field.

Form.Field

A single entry for a user input value in a Form. Each field can only be added to a single Form. This class cannot be constructed directly.

Instance Properties

var displayNameString or null read-only

Human readable string used as the label for this field.

var keyString read-only

Key to use when storing the value for this field in the containing form's values object.

Form.Field.Checkbox: Form.Field

No documentation available.

Constructors

new Form.Field.Checkbox(key:String, displayName:String or null, value:Boolean or null)Form.Field.Checkbox

Returns a new Checkbox field, optionally with an initial value (which will be false if no value is specified).

Form.Field.Date: Form.Field

No documentation available.

Constructors

new Form.Field.Date(key:String, displayName:String or null, value:Date or null)Form.Field.Date

Returns a new Date field, optionally with an initial value. The user's date formatting preference will be used to display and determine component ordering when parsing dates. Relative dates like "1d", "tomorrow", "now" can also be entered.

Form.Field.Option: Form.Field

No documentation available.

Constructors

new Form.Field.Option(key:String, displayName:String or null, options:Array of Object, names:Array of String or null, selected:Object or null)Form.Field.Option

Returns a new Option field, allowing the user to pick from a list of option objects. A list of names may also be given, which must have the same length as the options array if so. If no names are given, the objects are converted to strings for display. An initially selected object (which must be a member of the options array) may also be given.

Form.Field.String: Form.Field

A field for entering a free-form String value.

Constructors

new Form.Field.String(key:String, displayName:String or null, value:String or null)Form.Field.String

Returns a new String field, optionally with an initial value.

Function

An object that represents a JavaScript function, allowing native code to call into JavaScript or JavaScript to call into native code.

Graphic

An individual graphic element on a canvas. Graphic is an abstract superclass (that is, no actual Graphic objects exist, only more specialized sub-types of Graphic such as Line and Shape).

Instance Functions

function orderAbove(graphic:Graphic)

Reorder this graphic so that it is just above the given one.

function orderBelow(graphic:Graphic)

Reorder this graphic so that it is just below the given one.

function remove()

Remove this graphic from its canvas, deleting it.

function setUserData(key:String, value:String or null)

Set the user data string attached to this graphic for a given key.

function duplicateTo(location:Point, canvas:Canvas or null)Graphic or null

A convenience method, this does the same thing as canvas.duplicate() and then setting the geometry origin of the newly duplicated graphic. The destination canvas parameter can be omitted entirely in order to make a duplicate of the graphic to a different location of the same canvas it is already on.

Instance Properties

var actionURLURL or null

URL to be opened when this graphic is clicked/tapped with the action tool or in presentation mode.

var alignsEdgesToGridBoolean

Align edges or center to the grid.

var allowsConnectionsBoolean

Allow line connections to this graphic.

var automationActionArray of String

An array of two strings, the first being the plugin id and the second being the action id for an automation action. This automation action is performed when this graphic is clicked/tapped with the action tool or in presentation mode.

var connectedLinesArray of Line read-only

An array of all Line graphics connected to this graphic.

var cornerRadiusNumber

Corner radius of the stroke.

var flippedHorizontallyBoolean

Is this graphic flipped horizontally?

var flippedVerticallyBoolean

Is this graphic flipped vertically?

var geometryRect

The bounds rectangle of this graphic.

var idNumber read-only

A unique identifier (within this canvas) of this graphic. Note that this value is NOT persistent across closing/reopening of the document.

var incomingLinesArray of Line read-only

A subset of the connected lines: those lines whose head are connected to this graphic.

var layerLayer or null

The layer this graphic is on.

var lockedBoolean

Whether this graphic is locked.

var nameString or null

The name of this graphic, if any. Note that most graphics do not have names unless they are explicitly set; instead they will be displayed using a placeholder string (such as "Rectangle") in the outline.

var notesString

Notes attached to this graphic.

var outgoingLinesArray of Line read-only

A subset of the connected lines: those lines whose tail are connected to this graphic.

var plasticCurveNumber or null

If the stroke style is plastic, this is the depth of curvature.

var plasticHighlightAngleNumber or null

If the stroke style is plastic, this is the highlight angle of the "light" shining on the plastic.

var rotationNumber

Rotation of this graphic.

var shadowColorColor or null

Color of the shadow.

var shadowFuzzinessNumber

Fuzziness of the shadow.

var shadowVectorPoint

Direction and length of the shadow.

var strokeCapLineCap

Type of end cap on the stroke.

var strokeColorColor or null

Color of the stroke.

var strokeJoinLineJoin

Type of join on segments of the stroke.

var strokePatternStrokeDash

Dash pattern of the stroke.

var strokeThicknessNumber

Thickness of the stroke in points.

var strokeTypeStrokeType or null

Type of stroke (the outline around the graphic).

var userData → Object

User data for this graphic

Group: Graphic

A set of grouped graphics represented by a single graphic. Groups can contain more groups, et cetera.

Constructors

new Group(graphics:Array of Graphic)Group

Construct a new group containing the given graphics and replace those graphics on their original canvas with the group graphic.

Instance Functions

function ungroup()Array of Graphic

Remove this group, putting all of the graphics inside back on the canvas the group was previously upon. The group itself is deleted.

Instance Properties

var connectToGroupOnlyBoolean

Whether lines may connect to individual constituents or must connect to the group as a whole.

var graphicsArray of Graphic read-only

An array of graphics contained inside the group.

var magnetsArray of Point

Connection magnets on the group.

Subgraph: Group

A 'Subgraph' is a type of 'Group' that can be expanded and collapsed to show or hide its contents.

Constructors

new Subgraph(graphics:Array of Graphic)Group

No documentation available.

Instance Properties

var backgroundSolid read-only

The background graphic which is shown behind the contents when expanded, and by itself when collapsed.

var collapsedBoolean

Whether this subgraph is currently collapsed.

var subgraphicsArray of Graphic read-only

An array of graphics contained inside the subgraph.

Table: Group

A 'Table' is a type of 'Group' where the graphics inside aren't arranged arbitrarily, but are instead in fixed rows and columns.

Class Functions

function withRowsColumns(rows:Number, columns:Number, graphics:Array of Graphic)Table

No documentation available.

Constructors

new Table(graphic:Graphic)Table

No documentation available.

Instance Functions

function graphicAt(row:Number, column:Number)Graphic or null

Retrieve the contained graphic at the given row and column index.

function setRowHeight(pts:Number, ofRow:Number)

Change the height of all graphics in the given row index so that the row itself is the new height.

function setColumnWidth(pts:Number, ofColumn:Number)

Change the width of all graphics in the given column index so that the column itself is the new width.

Instance Properties

var columnsNumber

Number of columns in the table.

var rowsNumber

Number of rows in the table.

Line: Graphic

A graphic which is a line, potentially connecting two other graphics at its head and tail ends.

Class Properties

var allLineEndingTypesArray of String read-only

No documentation available.

Instance Properties

var bezierPointsArray of Point

Array of bezier control points, or empty for non-bezier lines. Each line point is first, followed by its control points. The first and last line point have a single control point, while any intermediate line points have two control points.

var headGraphic or null

Graphic attached to the head of this line.

var headMagnetNumber

Index of the magnet in the head graphic which this line is connected to. Zero if not any particular magnet.

var headScaleNumber

Scale of the line ending at the head end of this line.

var headTypeString

Type of line ending at the head end of this line.

var hopTypeHopType

Style and behavior of line hops when this line passes over any other line on this canvas.

var lineTypeLineType

Line type of this line. (Straight, Curved, Orthogonal, Bezier.)

var pointsArray of Point

Array of control points for this line in canvas coordinates.

var tailGraphic or null

Graphic attached to the tail of this line.

var tailMagnetNumber

Index of the magnet in the tail graphic which this line is connected to. Zero if not any particular magnet.

var tailScaleNumber

Scale of the line ending at the tail end of this line.

var tailTypeString

Type of line ending at the tail end of this line.

Solid: Graphic

A solid graphic is one that potentially has a fill, image, and text - as opposed to a 'Line', which has only a stroke. Almost all solid graphics will actually be the subclass 'Shape', but a canvas background is a 'Solid' without being a 'Shape'.

Instance Properties

var autosizingTextAutosizing

Autosizing behavior of the graphic when the text size changes.

var blendColorColor or null

The middle color of a three color gradient fill, if the fill style includes such.

var blendFractionNumber

The middle fraction of a three color gradient fill, if the fill style includes such.

var fillColorColor or null

Color of the fill for this graphic.

var fillTypeFillType or null

Style of fill for this graphic.

var fontNameString

Font of text in this graphic. This is the Font's "Postscript name", as displayed in the Font Book application’s Font Info pane on the Mac. Where there are multiple fonts, this returns the first character's font. Setting this value sets it for all text in the graphic.

var gradientAngleNumber

For linear gradients, the angle at which the gradient is drawn.

var gradientCenterPoint

For radial gradients, the position of the center of the gradient.

var gradientColorColor or null

For gradient fills, the second color (along with the fill color) that the fill goes between.

var imageImageReference or null

Image fill for this graphic, if any.

var imageOffsetPoint

Positioning offset of the image fill. This is the difference between the image origin and the graphic origin in percentage terms.

var imageOpacityNumber

Opacity percentage for the image fill for this graphic.

var imagePageNumber

Page number to display for the given image, if relevant. Mainly useful for PDF images, which are potentially multiple pages.

var imageScaleSize

Scaling of the image fill. This is a multiplier between the displayed size and original image size.

var imageSizingImageSizing

Type of sizing behavior for the image, if any.

var magnetsArray of Point

Array of connection magnets for this graphic.

var textString

Text contents of this graphic.

var textAlongPathGlyphAnchorNumber

text-on-path glyph placement anchor; 0 = glyph anchored at bottom center (this is how text-on-path works in OmniGraffle 7.10 and later), 1 = glyph anchored at bottom left (this is how text-on-path works in OmniGraffle 7.9.3 and previous)

var textColorColor

Color of the text in this graphic. Where there are multiple colors, this returns the first character's color. Setting this value sets it for all text in the graphic.

var textFlowTextFlow

Text flow behavior of the graphic.

var textGeometryRect read-only

Drawing bounds of the text in canvas coordinates.

var textHorizontalAlignmentHorizontalTextAlignment

Alignment of the text in this graphic horizontally.

var textHorizontalPaddingNumber

Horizontal padding between the edge of the graphic's bounds and the edge of the text area where text is drawn.

var textRotationNumber

Rotation of the text.

var textRotationIsRelativeBoolean

Whether the text rotation is relative to the existing rotation of the graphic itself, or whether it is constant compared to the canvas.

var textSizeNumber

Font size of text in this graphic. Where there are multiple fonts, this returns the first character's font size. Setting this value sets it for all text in the graphic.

var textUnitRectRect

Size and position of the graphics' text area as a unit square. I.e. The x and y are in terms of proportion of graphic size from the graphic bounds (so 0,0 is the graphic origin, (1,1) originates at the graphic's lower-righthand corner, and the width and height are the scale of the text area in proportion to the graphic, so (1,1) is the same size as the graphic bounds, (2,2) would be twice as large, etc.

var textVerticalPaddingNumber

Vertical padding between the edge of the graphic's bounds and the edge of the text area where text is drawn.

var textVerticalPlacementVerticalTextPlacement

Alignment of the text in this graphic vertically.

var textWrapsBoolean

Whether the text wraps to the graphic's bounds, or can go as wide as it wishes outside the graphic bounds.

var tripleBlendBoolean

Whether the fill includes three colors in a gradient.

Shape: Solid

A 'Solid' graphic which has a particular shape, either one of the built-in shapes, or a custom bezier shape.

Instance Properties

var shapeString or null

Name of the shape for this graphic.

var shapeControlPointsArray of Point

The vertices and controlPoint1 & controlPoint2 of each bezier segment. For straight line segments, both control points will be identical to the vertex point.

var shapeVerticesArray of Point

Array of vertices for this shape.

GraphicView

The view of the canvas in an OmniGraffle window.

Instance Functions

function select(graphics:Array of Graphic, extending:Boolean or null)

Change the selection to a new array of graphics. If extending is true, then the previous selection is retained as well.

function deselect(graphics:Array of Graphic)

Removes any of the passed graphics from the current selection, leaving any other currently selected graphics still selected.

function edit(solid:Solid)

Begin editing the text of a solid graphic.

Instance Properties

var canvasCanvas

The canvas currently being displayed in this view.

var visibleRectRect

The rectangle of the canvas which is visible in the window.

Grid

Holds the grid settings for a particular canvas.

Instance Properties

var drawsInFrontBoolean

Whether the grid draws in front of all graphics or behind them.

var majorColorColor

Color of the major grid lines.

var majorSpacingNumber

Number of minor grid squares between each major grid line.

var minorColorColor

Color of the minor grid lines.

var snapsBoolean

Whether graphics on the canvas snap to the grid.

var spacingNumber

Number of points of spacing between each minor grid line. (Also the width and height of each minor grid square.)

var visibleBoolean

Whether the grid is currently visible or invisible.

HierarchicalDirection

No documentation available.

Class Properties

var BottomHierarchicalDirection read-only

Root of the hierarchy is at the bottom and tree extends upwards.

var LeftHierarchicalDirection read-only

Root of the hierarchy is at the left and tree extends rightwards.

var RightHierarchicalDirection read-only

Root of the hierarchy is at the right and tree extends leftwards.

var TopHierarchicalDirection read-only

Root of the hierarchy is at the top and tree extends downwards.

var allArray of HierarchicalDirection read-only

An array of all items of this enumeration.

HopType

No documentation available.

Class Properties

var BridgeHopType read-only

Bridge over the other line(s).

var GapHopType read-only

Leave a gap while crossing the other line(s).

var IgnoreHopType read-only

No hops, and ignore this line when computing hops for other lines.

var NoneHopType read-only

Don't hop at all.

var RoundHopType read-only

Rounded over the other line(s).

var RoundUnderHopType read-only

Rounded under the other line(s).

var SquareHopType read-only

Square shape over the other line(s).

var SquareUnderHopType read-only

Square shape under the other line(s).

var ThreeSideHopType read-only

Three segments angled over the other line(s).

var ThreeSideUnderHopType read-only

Three segments angled under the other line(s).

var TwoSideHopType read-only

Vee over the other line(s).

var TwoSideUnderHopType read-only

Vee under the other line(s).

var allArray of HopType read-only

An array of all items of this enumeration.

HorizontalAlignment

No documentation available.

Class Properties

var CenterHorizontalAlignment read-only

Align to horizontal centers.

var LeftHorizontalAlignment read-only

Align to left edges.

var RightHorizontalAlignment read-only

Align to right edges.

var allArray of HorizontalAlignment read-only

An array of all items of this enumeration.

HorizontalTextAlignment

No documentation available.

Class Properties

var CenterHorizontalTextAlignment read-only

Centered horizontally.

var JustifyHorizontalTextAlignment read-only

Spacing adjusted to fill available horizontal space.

var LeftHorizontalTextAlignment read-only

Aligned left.

var RightHorizontalTextAlignment read-only

Aligned right.

var allArray of HorizontalTextAlignment read-only

An array of all items of this enumeration.

Image

No documentation available.

ImageReference

An image inside an OmniGraffle document. The image can be part of the fill for more than one 'Solid' graphic, and all of them will refer to the same 'ImageReference'.

Instance Properties

var dataData or null read-only

The image data bytes.

var originalSizeSize read-only

Original size of the image in pixels.

var uniqueIDNumber read-only

A unique (within this document) identifier for this image reference.

ImageSizing

No documentation available.

Class Properties

var ManualImageSizing read-only

Manual.

var StretchedImageSizing read-only

Stretched.

var TiledImageSizing read-only

Tiled.

var allArray of ImageSizing read-only

An array of all items of this enumeration.

Layer

A layer containing graphics on a given canvas.

Instance Functions

function orderAbove(layer:Layer)

Reorder this layer so that it is just above the given layer.

function orderBelow(layer:Layer)

Reorder this layer so that it is just below the given layer.

function remove()

Remove this layer from its canvas, deleting it.

function addShape(shapeName:String, bounds:Rect)Shape

Create a new graphic of a given shape and place it on this layer.

function newShape()Shape

Create a zero-sized rectangle (presumably to be modified further) and place it on this layer.

Instance Properties

var graphicsArray of Graphic read-only

All graphics in this layer.

var lockedBoolean

Whether this layer is locked, effectively locking all graphics contained in the layer.

var nameString

Name of this layer.

var printsBoolean

Whether graphics on this layer should be visible when this canvas is printed.

var visibleBoolean

Whether graphics on this layer are visible.

Layout

Graphic layout information for a canvas.

Instance Properties

var automaticLayoutBoolean

Whether to re-layout automatically on every change to the canvas.

var circularLineLengthNumber

Optimum line length to try to achieve during circular layout.

var directionHierarchicalDirection

The hierarchical layout orientation.

var forceDirectedLineLengthNumber

Optimum line length to try to achieve during force-directed layout.

var forceDirectedSeparationNumber

Separation distance between graphics to try to achieve during force-directed layout.

var objectSeparationNumber

Distance between graphics at the same level during hierarchical layout.

var radialSeparationNumber

Distance between graphics during radial layout.

var rankSeparationNumber

Distance between graphics from one level to an adjacent level higher or lower during hierarchical layout.

var typeLayoutType

Type of layout to perform: hierarchical, circular, radial, or force-directed.

LayoutType

No documentation available.

Class Properties

var CircularLayoutType read-only

Tries to arrange sibling shapes in a circle around their parent.

var ForceDirectedLayoutType read-only

Grows in semi-random directions from the center.

var HierarchicalLayoutType read-only

Creates layers of equally-ranked objects, extending in one direction..

var RadialLayoutType read-only

Tries to arrange sibling shapes in arcs around their parent.

var allArray of LayoutType read-only

An array of all items of this enumeration.

LineCap

No documentation available.

Class Properties

var ButtLineCap read-only

The line has a flat end cap, exactly at the end point of the line.

var RoundLineCap read-only

The line has a round end cap, with the center at the end point of the line, and radius of half its width.

var SquareLineCap read-only

The line has a flat end cap, extending half the line width past the end point.

var allArray of LineCap read-only

An array of all items of this enumeration.

LineJoin

No documentation available.

Class Properties

var BevelLineJoin read-only

Line segments are joined with a squared-off end.

var MiterLineJoin read-only

Line segments are joined with a sharp (angled) corner.

var RoundLineJoin read-only

Line segments are joined with a rounded end.

var allArray of LineJoin read-only

An array of all items of this enumeration.

LineType

No documentation available.

Class Properties

var BezierLineType read-only

Bezier line.

var CurvedLineType read-only

Curved line.

var OrthogonalLineType read-only

Orthogonal line.

var StraightLineType read-only

Straight line.

var allArray of LineType read-only

An array of all items of this enumeration.

Locale

No documentation available.

Class Properties

var identifiersArray of String read-only

The list of known ISO locale identifiers.

Constructors

new Locale(identifier:String)Locale

No documentation available.

Instance Properties

var calendarCalendar read-only

No documentation available.

var identifierString read-only

No documentation available.

MenuItem

No documentation available.

Instance Properties

var checkedBoolean

If true, a checkmark is displayed next to the MenuItem's label.

var labelString

The string displayed to describe the MenuItem's action.

NSWindow

No documentation available.

Instance Functions

function close()

No documentation available.

function setViewForCanvas(canvas:Canvas, zoom:Number, center:Point)

Change the saved position for a canvas, so that this will be the view position and scale shown when that canvas is next selected.

Instance Properties

var centerVisiblePointPoint

No documentation available.

var selectionSelection read-only

No documentation available.

var zoomNumber

No documentation available.

OGOutlineNode

An outline node is one element of a hierarchical organization of the canvas's graphics. Each node represents a single shape, with the lines between shapes determining parent-child relationships. The outline structure is visualized in the Mac applications 'Outline' sidebar tab.

Instance Properties

var childrenArray of OGOutlineNode read-only

Child nodes of this node.

var graphicGraphic or null read-only

Graphic that this outline node represents.

Pasteboard

No documentation available.

Class Functions

function makeUnique()Pasteboard

Creates a new unique pasteboard.

Class Properties

var generalPasteboard read-only

The Pasteboard used for user-initiated copy/paste support.

PlugIn

No documentation available.

Class Functions

function find(identifier:String, minimumVersion:Version or null)PlugIn or null

No documentation available.

Class Properties

var allArray of PlugIn read-only

No documentation available.

Instance Functions

function library(identifier:String)Object or null

Looks for a PlugIn.Library in the receiver and returns it if found.

function action(identifier:String)PlugIn.Action or null

No documentation available.

function handler(identifier:String)PlugIn.Handler or null

No documentation available.

function resourceNamed(name:String)URL or null

No documentation available.

function imageNamed(name:String)Image or null

No documentation available.

Instance Properties

var URLURL or null read-only

Returns the original URL from whence this PlugIn came, if known.

var actionsArray of PlugIn.Action read-only

No documentation available.

var displayNameString read-only

Returns the localized, human-readable name for the PlugIn.

var handlersArray of PlugIn.Handler read-only

No documentation available.

var identifierString read-only

The unique identifier of the PlugIn.

var librariesArray of PlugIn.Library read-only

No documentation available.

var versionVersion read-only

Returns the current Version for the PlugIn.

PlugIn.Action

No documentation available.

Constructors

new PlugIn.Action(perform:Function)PlugIn.Action

Returns a new PlugIn.Action. Only used within an action JavaScript file embedded within a PlugIn.

Instance Properties

var nameString read-only

Returns the name of the PlugIn.Action.

var performFunction read-only

No documentation available.

var plugInPlugIn read-only

Returns the PlugIn that contains this object.

var validateFunction or null

A function to check whether the action is supported, given the current application state, as determined by the arguments passed (typically including the selection). This optional Function may be configured while the Action is being loaded, but after that the Action will be frozen.

PlugIn.Handler

No documentation available.

Constructors

new PlugIn.Handler(invoke:Function)PlugIn.Handler

Returns a new PlugIn.Handler. Only used within an handler JavaScript file embedded within a PlugIn.

Instance Properties

var invokeFunction read-only

The Function that will be executed for each handler registered for an event posted by an application object.

var nameString read-only

Returns the name of the PlugIn.Handler.

var plugInPlugIn read-only

Returns the PlugIn that contains this object.

var willAttachFunction or null

An optional Function that can be set on PlugIn.Handler as it is being loaded (but not after). This function is passed the application object that post events to trigger the handler. The return value should be a state object that is JSON archivable (or undefined if the handler has no state to maintain across invocations).

var willDetachFunction or null

An optional Function that can be set on PlugIn.Handler as it is being loaded (but not after). Called when a previously attached PlugIn.Handler is being detached from an application object. Any return value or thrown error are ignored.

PlugIn.Handler.Registration

No documentation available.

Instance Functions

function remove()

Removes a previously added event observation.

PlugIn.Library

An object that represents a library from a plug-in.

Constructors

new PlugIn.Library(version:Version)PlugIn.Library

Returns a new Library. Typically only used within a library JavaScript file embedded within a PlugIn.

Instance Properties

var nameString read-only

Returns the name of the PlugIn.Library.

var plugInPlugIn read-only

Returns the PlugIn that contains this object.

var versionVersion read-only

Returns the Version of this library, as passed to the constructor.

Point

No documentation available.

Class Properties

var unitXPoint read-only

Returns a Point with coordinates (1, 0).

var unitYPoint read-only

Returns a Point with coordinates (0, 1).

var zeroPoint read-only

Returns the Point (0, 0), the origin.

Constructors

new Point(x:Number, y:Number)Point

Returns a new Point with the specified coordinates.

Instance Functions

function add(point:Point)Point

Returns a new Point that is the component-wise sum of the receiver and the argument Point.

function subtract(point:Point)Point

Returns a new Point that is the component-wise difference of the receiver and the argument Point.

function scale(factor:Number)Point

Returns a new Point where each component is scaled by the given factor.

function distanceTo(point:Point)Number

Returns the distance between the receiver and the given Point.

function dot(point:Point)Number

Returns the dot product between the receiver and the given Point.

Instance Properties

var lengthNumber read-only

Returns the distance between the receiver and the origin.

var negativePoint read-only

Returns the component-wise negative of the receiver.

var normalizedPoint read-only

For a non-zero point, returns a point with a distance of one from the origin, but in the same direction as the original. For the zero point, this returns the receiver.

var xNumber

The horizontal axis coordinate of the Point.

var yNumber

The vertical axis coordinate of the Point.

Portfolio

A Portfolio represents the main contents of an OmniGraffle Document and is used as the global object in any scripting session that is related to a particular document.

Instance Functions

function addCanvas()Canvas or null

Add a new canvas to the end of the current canvases.

function addImage(data:Data)ImageReference or null

Add an image to the document given some image data. The resulting ImageReference can then be set as the image fill of any number of Solid graphics on canvases within this document. Returns nil if the data could not be interpreted as a valid image.

function copyImage(image:ImageReference)ImageReference or null

Copy an image from another document or stencil to this one.

Instance Properties

var canvasesArray of Canvas read-only

List of canvases in the portfolio.

var documentGraffleDocument or null read-only

No documentation available.

var imagesArray of ImageReference read-only

A list of all images referenced by any graphic in this document. Each ImageReference is a unique image and appears only once in the list, even if it is used as the image fill for multiple graphics.

Promise

The built-in JavaScript Promise constructor.

Rect

No documentation available.

Constructors

new Rect(x:Number, y:Number, width:Number, height:Number)Rect

Returns a new Rect with the specified coordinates and size.

Instance Functions

function insetBy(dx:Number, dy:Number)Rect

No documentation available.

function offsetBy(dx:Number, dy:Number)Rect

No documentation available.

function union(rect:Rect)Rect

No documentation available.

function intersect(rect:Rect)Rect

No documentation available.

function containsRect(rect:Rect)Boolean

No documentation available.

function containsPoint(point:Point)Boolean

No documentation available.

function intersects(rect:Rect)Boolean

No documentation available.

Instance Properties

var centerPoint read-only

No documentation available.

var heightNumber

No documentation available.

var integralRect read-only

No documentation available.

var isEmptyBoolean read-only

No documentation available.

var isInfiniteBoolean read-only

No documentation available.

var isNullBoolean read-only

No documentation available.

var maxXNumber read-only

No documentation available.

var maxYNumber read-only

No documentation available.

var midXNumber read-only

No documentation available.

var midYNumber read-only

No documentation available.

var minXNumber read-only

No documentation available.

var minYNumber read-only

No documentation available.

var originPoint

No documentation available.

var sizeSize

No documentation available.

var standardizedRect read-only

No documentation available.

var widthNumber

No documentation available.

var xNumber

No documentation available.

var yNumber

No documentation available.

Selection

The 'selection' argument to plugin actions, letting them inspect the selection.

Instance Properties

var canvasCanvas or null read-only

The currently selected canvas.

var documentGraffleDocument or null read-only

The current document whose graphics are selected.

var graphicsArray of Graphic read-only

The currently selected graphics.

var linesArray of Line read-only

The subset of the currently selected graphics which are lines.

var solidsArray of Solid read-only

The subset of the currently selected graphics which are solids.

var viewGraphicView or null read-only

The current view containing the selection.

ShapeCombination

No documentation available.

Class Properties

var IntersectShapeCombination read-only

Form the intersection of the shapes.

var NoneShapeCombination read-only

Perform no combination operation.

var SubtractShapeCombination read-only

Subtract the shapes from the first shape

var UnionShapeCombination read-only

Form the union of the shapes.

var UniteShapeCombination read-only

An alias for Union.

var allArray of ShapeCombination read-only

An array of all items of this enumeration.

Size

No documentation available.

Constructors

new Size(width:Number, height:Number)Size

Returns a new Size with the specified width and height.

Instance Properties

var heightNumber

No documentation available.

var widthNumber

No documentation available.

Stencil

A stencil containing graphics that can be copied to documents.

Instance Functions

function load(completed:Function)

Load this stencil document into memory so its graphics and images can be accessed.

Instance Properties

var graphicsArray of Graphic read-only

Array of graphics available on the stencil.

var imagesArray of ImageReference read-only

A list of all images referenced by any graphic in this stencil. Each ImageReference is a unique image and appears only once in the list, even if it is used as the image fill for multiple graphics.

var isLoadedBoolean read-only

Whether or not this stencil has already been loaded into memory.

var nameString read-only

Name of the stencil.

StrokeDash

No documentation available.

Class Properties

var Dash10on3off2on3offStrokeDash read-only

No documentation available.

var Dash10on3off2on3off2on3offStrokeDash read-only

No documentation available.

var Dash16on9offStrokeDash read-only

Sixteen point dash segments with nine point gaps.

var Dash16on9off16on9off1on9offStrokeDash read-only

No documentation available.

var Dash16on9off1on9offStrokeDash read-only

No documentation available.

var Dash16on9off1on9off1on9offStrokeDash read-only

No documentation available.

var Dash1on3offStrokeDash read-only

One point dot segments with three point gaps.

var Dash1on4offStrokeDash read-only

One point dot segments with four point gaps.

var Dash1on5offStrokeDash read-only

One point dot segments with five point gaps.

var Dash1on9offStrokeDash read-only

One point dot segments with nine point gaps.

var Dash20on5off4on5offStrokeDash read-only

No documentation available.

var Dash20on5off4on5off4on5offStrokeDash read-only

No documentation available.

var Dash2on2offStrokeDash read-only

No documentation available.

var Dash40on9off8on9offStrokeDash read-only

No documentation available.

var Dash40on9off8on9off8on9offStrokeDash read-only

No documentation available.

var Dash4on3off1on3offStrokeDash read-only

No documentation available.

var Dash4on3off1on3off1on3offStrokeDash read-only

No documentation available.

var Dash4on3off4on3off1on3offStrokeDash read-only

No documentation available.

var Dash4on4offStrokeDash read-only

Four point dash segments with four point gaps.

var Dash4on9off1on5offStrokeDash read-only

Four point dash alternating with one point dots, with nine and five point gaps

var Dash4on9off1on5off1on5offStrokeDash read-only

No documentation available.

var Dash8on4off1on4offStrokeDash read-only

Eight point dash alternating with one point dots, both with four point gaps.

var Dash8on5offStrokeDash read-only

Eight point dash with five point gaps.

var Dash8on5off8on5off1on5offStrokeDash read-only

No documentation available.

var SolidStrokeDash read-only

Solid stroke with no dash pattern.

var allArray of StrokeDash read-only

An array of all items of this enumeration.

StrokeType

No documentation available.

Class Properties

var DoubleStrokeType read-only

Double.

var FreehandStrokeType read-only

Freehand.

var InnerStrokeType read-only

Inner.

var OuterStrokeType read-only

Outer.

var PlasticStrokeType read-only

Plastic.

var SingleStrokeType read-only

Single.

var allArray of StrokeType read-only

An array of all items of this enumeration.

TextAutosizing

No documentation available.

Class Properties

var ClipTextAutosizing read-only

Clip.

var FullTextAutosizing read-only

Full.

var OverflowTextAutosizing read-only

Overflow.

var VerticalTextAutosizing read-only

Vertical.

var allArray of TextAutosizing read-only

An array of all items of this enumeration.

TextFlow

No documentation available.

Class Properties

var ClipTextFlow read-only

Clip.

var FillsShapeTextFlow read-only

Fills shape.

var FollowsPathTextFlow read-only

Follows path.

var OverflowTextFlow read-only

Overflow.

var ResizeTextFlow read-only

Resize.

var allArray of TextFlow read-only

An array of all items of this enumeration.

TimeZone

No documentation available.

Class Properties

var abbreviationsArray of String read-only

The list of known time zone abbreviations.

Constructors

new TimeZone(abbreviation:String)TimeZone or null

Make a new TimeZone with the given abbreviation. Note that the returned TimeZone may have a different abbreviation than the passed argument. For example, if one of "PST" or "PDT" is requested that doens't match the current use of daylight savings time, the one that does match will be returned.

Instance Properties

var abbreviationString or null read-only

The abbreviation for the TimeZone.

var daylightSavingTimeBoolean read-only

Returns true if the TimeZone is currently using daylight savings time.

var secondsFromGMTNumber read-only

The current difference in seconds between this TimeZone and GMT.

Timer

No documentation available.

Class Functions

function once(interval:Number, action:Function)Timer

Makes a new Timer that will fire once, after the specified interval (in seconds from the current time). When the Timer fires, the passed in Function is called, passing the Timer as its argument.

function repeating(interval:Number, action:Function)Timer

Makes a new Timer that will fire repeatedly with the specified interval (in seconds, with the first invocation happening that interval after the current time). When the Timer fires, the passed in Function is called, passing the Timer as its argument.

Instance Functions

function cancel()

No documentation available.

Instance Properties

var intervalNumber read-only

No documentation available.

ToolbarItem

No documentation available.

Instance Properties

var imageImage or null

No documentation available.

var labelString

No documentation available.

var toolTipString or null

No documentation available.

URL

No documentation available.

Class Functions

function choose(types:Array of String)URL or null

Deprecated: Please use FilePicker instead.

Allows the user to choose a file URL if possible and returns a new instance, or null otherwise.

function chooseFolder()URL or null

Deprecated: Please use FilePicker instead.

Allows the user to choose a folder URL if possible and returns a new instance, or null otherwise.

function fromString(string:String)URL or null

Parses the string as a URL if possible and returns a new instance, or null otherwise.

function tellScript(app:String, js:String, arg:Object or null)URL or null

Creates a URL to invoke the given JS on the given app (url scheme) appropriate for use with the call function.

function tellFunction(app:String, jsFunction:Function, arg:Object or null)URL or null

Creates a URL to invoke the given JS function on the given app (url scheme) appropriate for use with the call function.

Instance Functions

function fetch(success:Function, failure:Function or null)

Get the contents at the destination of this URL.

function call(success:Function, failure:Function or null)

No documentation available.

function find(types:Array of FileType, recurse:Boolean or null)Promise

Scan a directory URL for files of the given types. If recurse is specified and is false, only the immediate contents of the directory will be considered. If recurse is not specified or is true, the full directory tree will be scanned.

function toString()String

No documentation available.

Instance Properties

var stringString read-only

String representation of this URL.

var toObjectObject or null read-only

No documentation available.

Version

No documentation available.

Constructors

new Version(versionString:String)Version

Parses a string representation of a Version and returns an instance, or throws an error if the string isn't a valid version.

Instance Functions

function equals(version:Version)Boolean

Returns true if the receiving Version is equal to the argument Version.

function atLeast(version:Version)Boolean

Returns true if the receiving Version is at the same as or newer than the argument Version.

function isAfter(version:Version)Boolean

Returns true if the receiving Version is strictly after the argument Version.

function isBefore(version:Version)Boolean

Returns true if the receiving Version is strictly before the argument Version.

Instance Properties

var versionStringString read-only

Returns as an opaque string representation of the Version, suitable for display or logging. This should never be used in comparisons of any sort.

VerticalAlignment

No documentation available.

Class Properties

var BottomVerticalAlignment read-only

Align to bottom edges.

var CenterVerticalAlignment read-only

Align to vertical centers.

var TopVerticalAlignment read-only

Align to top edges.

var allArray of VerticalAlignment read-only

An array of all items of this enumeration.

VerticalTextPlacement

No documentation available.

Class Properties

var BottomVerticalTextPlacement read-only

Aligned to the bottom of the shape.

var MiddleVerticalTextPlacement read-only

Centered in the vertical middle of the shape.

var TopVerticalTextPlacement read-only

Aligned to the top of the shape.

var allArray of VerticalTextPlacement read-only

An array of all items of this enumeration.