OmniGraffle 7 Omni Automation API

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(‍option: Number‍) or null) → Promise of Number

Displays the alert. 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(‍documentOrError: Document or Error, alreadyOpen: Boolean‍))

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 buildVersion → Version read-only

The internal build version number for the app. See also userVersion.

var commandKeyDown → Boolean read-only

Whether the Command key is currently down.

var controlKeyDown → Boolean read-only

Whether the Control key is currently down.

var name → String read-only

Application name.

var optionKeyDown → Boolean read-only

Whether the Option key is currently down.

var platformName → String read-only

Returns a string describing the current platform, currently "iOS" or "macOS".

var shiftKeyDown → Boolean read-only

Whether the Shift key is currently down.

var stencils → Array of Stencil read-only

List of stencils that OmniGraffle currently has available.

var userVersion → Version read-only

The user-visible version number for the app. See also buildVersion.

var version → String read-only

Deprecated: Recommend using either userVersion or buildVersion.

For backwards compatibility with existing scripts, this returns the same result as buildVersion.versionString. We recommend using either the user-visible userVersion or the internal buildVersion instead, which are more clear about which version they’re returning and provide their results as Version objects which can be semantically compared with other Version objects.

Array

The built-in JavaScript Array constructor.

Audio

Class Functions

function playAlert(alert: Audio.Alert or null, completed: Function(‍‍) or null)

Play the specified Audio.Alert. On macOS, if no alert is specified, the user’s default alert sound will be played. On iOS, there is no default alert sound and nothing will be done without specifying an alert.

Audio.Alert

Constructors

new Audio.Alert(url: URL) → Audio.Alert

Calendar

Class Properties

var buddhist → Calendar read-only

var chinese → Calendar read-only

var coptic → Calendar read-only

var current → Calendar read-only

The user’s preferred calendar

var ethiopicAmeteAlem → Calendar read-only

var ethiopicAmeteMihret → Calendar read-only

var gregorian → Calendar read-only

The Gregorian calendar.

var hebrew → Calendar read-only

var indian → Calendar read-only

var islamic → Calendar read-only

var islamicCivil → Calendar read-only

var islamicTabular → Calendar read-only

var islamicUmmAlQura → Calendar read-only

var iso8601 → Calendar read-only

var japanese → Calendar read-only

var persian → Calendar read-only

var republicOfChina → Calendar read-only

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 identifier → String read-only

The ISO identifier for the calendar.

var locale → Locale or null read-only

The locale of the calendar.

var timeZone → TimeZone read-only

The time zone of the calendar.

Canvas

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

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 autosizesDown → Boolean

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

var autosizesLeft → Boolean

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

var autosizesRight → Boolean

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

var autosizesUp → Boolean

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

var background → Solid read-only

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

var canvasSizeIsMeasuredInPages → Boolean

var canvasSizingMode → CanvasSizingMode

var columnAlignment → VerticalAlignment

Setting for how graphics ought to be aligned vertically.

var graphics → Array of Graphic read-only

All graphics upon this canvas.

var grid → Grid read-only

Settings for the major and minor grids, if any.

var horizontalPages → Number

Number of printer pages wide.

var id → Number read-only

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

var layers → Array of Layer read-only

All layers of this canvas.

var layoutInfo → Layout read-only

The automatic layout information describing how graphics should be arranged.

var name → String

The title of this canvas.

var outlineRoot → OGOutlineNode 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 pageSize → Size read-only

Size of each page in points.

var rowAlignment → HorizontalAlignment

Setting for how graphics ought to be aligned horizontally.

var shapes → Array of Shape read-only

var size → Size

Overall size in points.

var spaceBetweenObjectsInColumn → Number

Setting for how graphics ought to be spaced out vertically.

var spaceBetweenObjectsInRow → Number

Setting for how graphics ought to be spaced out horizontally.

var verticalPages → Number

Number of printer pages tall.

CanvasSizingMode

Class Properties

var Fit → CanvasSizingMode read-only

Resizes to fit its contents.

var Fixed → CanvasSizingMode read-only

Specific size in pages or in points.

var Infinite → CanvasSizingMode read-only

No specific size and no canvas edges.

var all → Array of CanvasSizingMode read-only

Color

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 black → Color read-only

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

var blue → Color read-only

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

var brown → Color read-only

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

var clear → Color read-only

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

var cyan → Color read-only

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

var darkGray → Color read-only

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

var gray → Color read-only

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

var green → Color read-only

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

var lightGray → Color read-only

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

var magenta → Color read-only

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

var orange → Color read-only

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

var purple → Color read-only

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

var red → Color read-only

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

var white → Color read-only

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

var yellow → Color 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 alpha → Number read-only

Returns the alpha component of the color.

var blue → Number read-only

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

var brightness → Number read-only

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

var colorSpace → ColorSpace read-only

Returns the colorspace of the instance.

var green → Number read-only

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

var hue → Number read-only

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

var red → Number read-only

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

var saturation → Number read-only

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

var white → Number read-only

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

ColorSpace

Class Properties

var CMYK → ColorSpace read-only

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

var HSB → ColorSpace read-only

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

var Named → ColorSpace read-only

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

var Pattern → ColorSpace read-only

A colorspace that wraps a pattern image.

var RGB → ColorSpace read-only

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

var White → ColorSpace read-only

A colorspace with white and alpha components.

var all → Array of ColorSpace read-only

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)

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

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.

Credentials

The Credentials class allows storage of private username and password pairs, URL.Bookmark instances, and possibly other sensitive information in the future. Instances are tied to a single plug-in and single application, and may only be created in plug-ins when they are being loaded.

For example, when a PlugIn.Action is being created, you could use the following pattern:

 (() => {
     let credentials = new Credentials();

     var action = new PlugIn.Action(function(selection) {
         // ... use the captured credentials ...
     });

     return action;
 })();

Attempts to create Credential instances elsewhere will throw an error. Care should be taken to store instances in anonymous closures as above, and not pass them to or store them on other objects.

Credentials are keyed off a service identifier, which your plug-in can define however it likes.

Constructors

new Credentials() → Credentials

Creates a new Credentials instance for the currently loading plug-in. Throws an error if called outside of plug-in loading.

Instance Functions

function read(service: String) → Object or null

Looks up the current credentials for a given service identifier. If credentials have previously been stored, an object will be returned containing "user" an "password" properties.

function write(service: String, username: String, password: String)

Creates or updates an existing credential, storing the username and password for this service securely in the Keychain.

function remove(service: String)

Deletes any currently stored credentials for the specified service, either a username and password or a URL bookmark.

function readBookmark(service: String) → URL.Bookmark or null

Reads the entry for the given service identifier and attempts to return it as a URL.Bookmark, or null if no such entry exists.

function writeBookmark(service: String, bookmark: URL.Bookmark)

Stores the URL.Bookmark persistently for later access.

Crypto

Crypto provides access to some of Apple’s CryptoKit

Class Functions

function randomData(length: Number) → Data

Copy length bytes of cryptographically secure random data.

Crypto.SHA256

The SHA–256 hash function.

Constructors

new Crypto.SHA256() → Crypto.SHA256

Create a new SHA–256 digest.

Instance Functions

function update(data: Data)

Incrementally update the digest with the given data.

function finalize() → Data

Finalize any remaining digest process and return the result of the hash function.

Crypto.SHA384

The SHA–384 hash function.

Constructors

new Crypto.SHA384() → Crypto.SHA384

Create a new SHA–384 digest.

Instance Functions

function update(data: Data)

Incrementally update the digest with the given data.

function finalize() → Data

Finalize any remaining digest process and return the result of the hash function.

Crypto.SHA512

The SHA–512 hash function.

Constructors

new Crypto.SHA512() → Crypto.SHA512

Create a new SHA–512 digest.

Instance Functions

function update(data: Data)

Incrementally update the digest with the given data.

function finalize() → Data

Finalize any remaining digest process and return the result of the hash function.

Data

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

Class Functions

function fromString(string: String, encoding: StringEncoding or null) → Data

Convert the string to a Data using the given encoding, or UTF8 if none is specified.

function fromBase64(string: String) → Data

Instance Functions

function toString(encoding: StringEncoding or null) → String

Convert to a String, assuming that this Data using the specified encoding, or UTF8 if none is given.

function toBase64() → String

Convert to a Base–64 encoded string.

Instance Properties

var length → Number read-only

Number of bytes in this data.

var toObject → Object or null read-only

DateComponents

Constructors

new DateComponents() → DateComponents

Instance Properties

var date → Date or null read-only

var day → Number or null

var era → Number or null

var hour → Number or null

var minute → Number or null

var month → Number or null

var nanosecond → Number or null

var second → Number or null

var timeZone → TimeZone or null

var year → Number or null

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 maximum → Decimal read-only

Returns the maximum representable Decimal value.

var minimum → Decimal read-only

Returns the minimum representable Decimal value.

var notANumber → Decimal read-only

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

var one → Decimal read-only

Returns a Decimal representing one.

var zero → Decimal 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.

Device

Class Properties

var current → Device read-only

The device the current application is running on.

Instance Properties

var iOS → Boolean read-only

A convenience that returns true on iPhone and iPad devices

var iPad → Boolean read-only

A convenience that returns true only on iPad devices, but not on iPhone devices.

var mac → Boolean read-only

A convenience that returns true only on Mac devices.

var operatingSystemVersion → Version read-only

The current operation system version running on the device

var type → DeviceType or null read-only

The general type of the current device

var visionPro → Boolean read-only

A convenience that returns true only on Apple Vision Pro devices.

DeviceType

Class Properties

var all → Array of DeviceType read-only

var iPad → DeviceType read-only

An iPad

var iPhone → DeviceType read-only

An iPhone

var mac → DeviceType read-only

A Mac device

var visionPro → DeviceType read-only

An Apple Vision Pro

Document

Class Functions

function makeNew(resultFunction: Function(‍document: Document or Error‍) or null) → Promise of Document

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. resultFunction is executed before any functions tethered to the result Promise are executed. Returns a Promise that will yield the new document or an error.

function makeNewAndShow(resultFunction: Function(‍document: Document or Error‍) or null) → Promise of Document

Create a new document and presents it. Returns a Promise that will yield the new document or an error.

Instance Functions

function close(didCancel: Function(‍document: Document‍) 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 of FileWrapper

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(completed: 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. Calls the completion function once the document is shown.

Instance Properties

var canRedo → Boolean read-only

Whether there are currently any actions that can be redone.

var canUndo → Boolean read-only

Whether there are currently any actions that can be undone.

var fileType → String or null read-only

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

var name → String or null read-only

Document name.

var writableTypes → Array 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)

Instance Properties

var portfolio → Portfolio read-only

var windows → Array of NSWindow read-only

Email

A set of parameters for generating an email.

Constructors

new Email() → Email

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 blindCarbonCopy → String or Array of String or null

var body → String or null

var carbonCopy → String or Array of String or null

var fileWrappers → Array of FileWrapper

var receiver → String or Array of String or null

var subject → String or null

Error

The built-in JavaScript Error constructor.

Instance Properties

var causedByUserCancelling → Boolean read-only

Returns true for errors that are caused by the user cancelling an operation. For example, if the user selects the Cancel button in a FilePicker, the Promise will signal an error that reflects this.

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 of Array of URL

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 folders → Boolean

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

var message → String

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

var multiple → Boolean

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

var types → Array of TypeIdentifier 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 of URL

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 message → String

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

var nameLabel → String

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

var prompt → String

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

var types → Array of TypeIdentifier or null

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

FileWrapper

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.

function fromURL(url: URL, options: Array of FileWrapper.ReadingOptions or null) → FileWrapper

Reads a FileWrapper from an existing URL.

Instance Functions

function childNamed(name: String) → FileWrapper or null

Returns the child file wrapper with the specified name, or null if the receiver is not a directory or doesn’t have a child with that name.

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.

function write(url: URL, options: Array of FileWrapper.WritingOptions or null, originalContentsURL: URL or null)

Writes the FileWrapper to the given URL. NOTE: Any existing file or folder at the desination URL will be replaced. Care must be taken when developing scripts to avoid unintended data loss.

Instance Properties

var children → Array of FileWrapper read-only

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

var contents → Data or null read-only

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

var destination → URL or null read-only

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

var filename → String 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 preferredFilename → String 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 type → FileWrapper.Type read-only

Returns the type of this FileWrapper.

FileWrapper.ReadingOptions

Class Properties

var Immediate → FileWrapper.ReadingOptions read-only

Whether the contents are read immediately, or (by default) as the file wrappers are accessed.

var WihtoutMapping → FileWrapper.ReadingOptions read-only

Allow disabling file mapping.

var all → Array of FileWrapper.ReadingOptions read-only

FileWrapper.Type

Class Properties

var Directory → FileWrapper.Type read-only

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

var File → FileWrapper.Type read-only

A FileWrapper that represents a regular file with data contents.

var Link → FileWrapper.Type read-only

A FileWrapper that represents a symbolic link to another location.

var all → Array of FileWrapper.Type read-only

FileWrapper.WritingOptions

Class Properties

var Atomic → FileWrapper.WritingOptions read-only

Write the entire FileWrapper atomically, so that either the entire file package is replaced or none of it is.

var UpdateNames → FileWrapper.WritingOptions read-only

On successful writing, update the filename of each file wrapper recursively so that following writes can use performance optimizations using hard links.

var all → Array of FileWrapper.WritingOptions read-only

FillType

Class Properties

var EvenOdd → FillType read-only

Even/odd rule Solid.

var Gradient → FillType read-only

Gradient.

var Linear → FillType read-only

Linear Gradient.

var Marker → FillType read-only

Marker.

var None → FillType read-only

No Fill.

var Plastic → FillType read-only

Plastic.

var Radial → FillType read-only

Radial Gradient.

var Solid → FillType read-only

Solid.

var Squiggle → FillType read-only

Squiggle.

var Stipple → FillType read-only

Stipple.

var all → Array of FillType read-only

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

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 theForm. Any entry in thevalues` for this field will be removed as well.

function show(title: String, confirmTitle: String) → Promise of Form

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 fields → Array of Form.Field read-only

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

var validate → Function(‍Form: Form‍) → Boolean 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 or null to perform default validation. 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. If no validate function is specified or it returns null, some per-field default validation will be performed (see Form.Field.Option. If the validate function returns a boolean result, no default validation will be performed.

var values → Object 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 displayName → String or null read-only

Human readable string used as the label for this field.

var key → String read-only

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

Form.Field.Checkbox : Form.Field

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

Constructors

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

Returns a new Date field, optionally with an initial value, and optionally a date formatter. If no formatter is specified, a default one will be created that follows the user’s date formatting preferences to display and determine component ordering when parsing dates. Relative dates like “1d”, “tomorrow”, “now” can also be entered.

Form.Field.MultipleOptions : Form.Field

Constructors

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

Returns a new MultipleOptions field, allowing the user to pick multiple items 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 array of zero or more initially selected objects (which must be members of the options array) may also be given. An empty array is valid input for the initially selected items. Additionally, it is valid for MultipleOptions fields to have a value that is an empty array.

Form.Field.Option : Form.Field

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, nullOptionTitle: String 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. If the field is not configured to allow a null value and no initially selected value is specified, the user must select a value before the field is considered valid under the default form validation.

Instance Properties

var allowsNull → Boolean

If set to true, an option will be added to allow selecting null.

var nullOptionTitle → String or null

If null is allowed, this will be used for the title of that option. Otherwise a default title will be used.

Form.Field.Password : Form.Field

A field for text-based input, optionally using a Formatter to convert the string value into a different type.

Constructors

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

Returns a new Password field, optionally with an initial value. The displayed text will be obscured.

Form.Field.String : Form.Field

A field for text-based input, optionally using a Formatter to convert the string value into a different type.

Constructors

new Form.Field.String(key: String, displayName: String or null, value: Object or null, formatter: Formatter or null) → Form.Field.String

Returns a new String field, optionally with an initial value and formatter. If a formatter is specified, the value should be of the output type from the formatter or null. If no formatter is specified, the value should be a string or null.

Formatter

Formatter.Date : Formatter

Class Functions

function withStyle(dateStyle: Formatter.Date.Style, timeStyle: Formatter.Date.Style or null) → Formatter.Date

A formatter that will display dates according to the specified date and time formats selected in system settings.

function withFormat(format: String) → Formatter.Date

Returns a formatter with a specific ICU date format and the user’s current locale, calendar, and timeZone. See http://userguide.icu-project.org/formatparse/datetime/ for details on date format strings.

Class Properties

var iso8601 → Formatter.Date read-only

Return a date formatter that produces ISO–8601 formatted dates, using the Gregorian calendar and the UTC time zone.

Instance Functions

function stringFromDate(date: Date) → String

function dateFromString(string: String) → Date or null

Instance Properties

var calendar → Calendar

var dateFormat → String read-only

var locale → Locale

var timeZone → TimeZone

Formatter.Decimal : Formatter

This formatter class formats and parses Decimal-valued strings (note, not Number values).

Class Functions

function currency(code: String or null) → Formatter.Decimal

Returns a new formatter that will display the value as a currency value. An ISO currency code may be specified to pick a specific currency, or null may be passed to use the default currency for the user’s locale. If the argument is not a valid currency code, an error will be thrown.

Class Properties

var currencyCodes → Array of String read-only

Deprecated: Please use the currencyCode property on Locale instead. Returns the list of known ISO currency codes

var custom → Formatter.Decimal read-only

Returns a new formatter that can be configured with custom settings.

var decimal → Formatter.Decimal read-only

Returns a new number formatter that will use both a decimal separator.

var percent → Formatter.Decimal read-only

Returns a new number formatter that will display the value as a percentage.

var percentWithDecimal → Formatter.Decimal read-only

Returns a new number formatter that will display the value as a percentage with a decimal separator.

var plain → Formatter.Decimal read-only

Returns a new number formatter that will not use any separators.

var thousandsAndDecimal → Formatter.Decimal read-only

Returns a new number formatter that will use both a thousands and decimal separator.

Instance Functions

function stringFromDecimal(number: Decimal) → String or null

Format a Decimal as a string, based on the rules set on the formatter.

function decimalFromString(string: String) → Decimal or null

Parses a Decimal from a string, based on the rules set on the formatter. Returns null if the value was not recognized.

Instance Properties

var decimalSeparator → String

The string to display between the whole portion of a number and the decimal portion.

var negativeFormat → String

A format string to use for negative values.

var positiveFormat → String

A format string to use for positive values.

var thousandsSeparator → String or null

The string to display between groups of digits representing powers of a thousand.

var zeroSymbol → String or null

The string to use when displaying a zero value. If this is null, the positiveFormat is used.

Formatter.Duration : Formatter

Constructors

new Formatter.Duration() → Formatter.Duration

Instance Functions

function stringFromDecimal(number: Decimal) → String or null

function decimalFromString(string: String) → Decimal or null

Instance Properties

var hoursPerDay → Number

var hoursPerWeek → Number

var useVerboseFormat → Boolean

Formatter.Date.Style

Class Properties

var Full → Formatter.Date.Style read-only

Use the user’s “full” format as selected in system settings.

var Long → Formatter.Date.Style read-only

Use the user’s “long” format as selected in system settings.

var Medium → Formatter.Date.Style read-only

Use the user’s “medium” format as selected in system settings.

var Short → Formatter.Date.Style read-only

Use the user’s “short” format as selected in system settings.

var all → Array of Formatter.Date.Style read-only

Function

The built-in JavaScript Function constructor.

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.

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

Similar to duplicateTo(), but the newly created graphic will be a reference to this one, instead of a standalone copy.

Instance Properties

var actionURL → URL or null

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

var alignsEdgesToGrid → Boolean

Align edges or center to the grid.

var allowsConnections → Boolean

Allow line connections to this graphic.

var automationAction → Array 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 connectedLines → Array of Line read-only

An array of all Line graphics connected to this graphic.

var cornerRadius → Number

Corner radius of the stroke.

var flippedHorizontally → Boolean

Is this graphic flipped horizontally?

var flippedVertically → Boolean

Is this graphic flipped vertically?

var geometry → Rect

The bounds rectangle of this graphic.

var id → Number 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 incomingLines → Array of Line read-only

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

var layer → Layer or null

The layer this graphic is on.

var locked → Boolean

Whether this graphic is locked.

var name → String 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 notes → String

Notes attached to this graphic.

var outgoingLines → Array of Line read-only

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

var plasticCurve → Number or null

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

var plasticHighlightAngle → Number or null

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

var referenceGraphic → Graphic or null read-only

The graphic that this one is a reference of.

var referenceInstances → Array of Graphic read-only

An array of all graphics that are references to this graphic.

var rotation → Number

Rotation of this graphic.

var shadowColor → Color or null

Color of the shadow.

var shadowFuzziness → Number

Fuzziness of the shadow.

var shadowVector → Point

Direction and length of the shadow.

var strokeCap → LineCap

Type of end cap on the stroke.

var strokeColor → Color or null

Color of the stroke.

var strokeJoin → LineJoin

Type of join on segments of the stroke.

var strokePattern → StrokeDash

Dash pattern of the stroke.

var strokeThickness → Number

Thickness of the stroke in points.

var strokeType → StrokeType 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 connectToGroupOnly → Boolean

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

var graphics → Array of Graphic read-only

An array of graphics contained inside the group.

var magnets → Array 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

Instance Properties

var background → Solid read-only

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

var collapsed → Boolean

Whether this subgraph is currently collapsed.

var subgraphics → Array 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

Constructors

new Table(graphic: Graphic) → Table

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 columns → Number

Number of columns in the table.

var rows → Number

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 allLineEndingTypes → Array of String read-only

Instance Properties

var bezierPoints → Array 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 head → Graphic or null

Graphic attached to the head of this line.

var headMagnet → Number

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

var headScale → Number

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

var headType → String

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

var hopType → HopType

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

var lineLength → Number read-only

The overall length of this line. The value you’d get from using the Line Length text tag in a label for this line.

var lineType → LineType

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

var points → Array of Point

Array of control points for this line in canvas coordinates.

var tail → Graphic or null

Graphic attached to the tail of this line.

var tailMagnet → Number

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

var tailScale → Number

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

var tailType → String

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 autosizing → TextAutosizing

Autosizing behavior of the graphic when the text size changes.

var fillColor → Color or null

Color of the fill for this graphic.

var fillType → FillType or null

Style of fill for this graphic.

var fontName → String

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 gradientAngle → Number

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

var image → ImageReference or null

Image fill for this graphic, if any.

var imageOffset → Point

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

var imageOpacity → Number

Opacity percentage for the image fill for this graphic.

var imagePage → Number

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

var imageScale → Size

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

var imageSizing → ImageSizing

Type of sizing behavior for the image, if any.

var magnets → Array of Point

Array of connection magnets for this graphic.

var text → String

Text contents of this graphic.

var textAlongPathGlyphAnchor → Number

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 textColor → Color

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 textFlow → TextFlow

Text flow behavior of the graphic.

var textGeometry → Rect read-only

Drawing bounds of the text in canvas coordinates.

var textHorizontalAlignment → HorizontalTextAlignment

Alignment of the text in this graphic horizontally.

var textHorizontalPadding → Number

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

var textRotation → Number

Rotation of the text.

var textRotationIsRelative → Boolean

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

var textSize → Number

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 textUnitRect → Rect

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 textVerticalPadding → Number

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

var textVerticalPlacement → VerticalTextPlacement

Alignment of the text in this graphic vertically.

var textWraps → Boolean

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

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 shape → String or null

Name of the shape for this graphic.

var shapeControlPoints → Array 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 shapeVertices → Array 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 canvas → Canvas

The canvas currently being displayed in this view.

var visibleRect → Rect

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

Grid

Holds the grid settings for a particular canvas.

Instance Properties

var drawsInFront → Boolean

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

var majorColor → Color

Color of the major grid lines.

var majorSpacing → Number

Number of minor grid squares between each major grid line.

var minorColor → Color

Color of the minor grid lines.

var snaps → Boolean

Whether graphics on the canvas snap to the grid.

var spacing → Number

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

var visible → Boolean

Whether the grid is currently visible or invisible.

HierarchicalDirection

Class Properties

var Bottom → HierarchicalDirection read-only

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

var Left → HierarchicalDirection read-only

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

var Right → HierarchicalDirection read-only

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

var Top → HierarchicalDirection read-only

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

var all → Array of HierarchicalDirection read-only

HopType

Class Properties

var Bridge → HopType read-only

Bridge over the other line(s).

var Gap → HopType read-only

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

var Ignore → HopType read-only

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

var None → HopType read-only

Don’t hop at all.

var Round → HopType read-only

Rounded over the other line(s).

var RoundUnder → HopType read-only

Rounded under the other line(s).

var Square → HopType read-only

Square shape over the other line(s).

var SquareUnder → HopType read-only

Square shape under the other line(s).

var ThreeSide → HopType read-only

Three segments angled over the other line(s).

var ThreeSideUnder → HopType read-only

Three segments angled under the other line(s).

var TwoSide → HopType read-only

Vee over the other line(s).

var TwoSideUnder → HopType read-only

Vee under the other line(s).

var all → Array of HopType read-only

HorizontalAlignment

Class Properties

var Center → HorizontalAlignment read-only

Align to horizontal centers.

var Left → HorizontalAlignment read-only

Align to left edges.

var Right → HorizontalAlignment read-only

Align to right edges.

var all → Array of HorizontalAlignment read-only

HorizontalTextAlignment

Class Properties

var Center → HorizontalTextAlignment read-only

Centered horizontally.

var Justify → HorizontalTextAlignment read-only

Spacing adjusted to fill available horizontal space.

var Left → HorizontalTextAlignment read-only

Aligned left.

var Right → HorizontalTextAlignment read-only

Aligned right.

var all → Array of HorizontalTextAlignment read-only

Image

Class Functions

function symbolNamed(name: String) → Image or null

Returns an image given a symbol name.

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 data → Data or null read-only

The image data bytes.

var originalSize → Size read-only

Original size of the image in pixels.

var uniqueID → Number read-only

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

ImageSizing

Class Properties

var Manual → ImageSizing read-only

Manual.

var Stretched → ImageSizing read-only

Stretched.

var Tiled → ImageSizing read-only

Tiled.

var all → Array of ImageSizing read-only

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 graphics → Array of Graphic read-only

All graphics in this layer.

var locked → Boolean

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

var name → String

Name of this layer.

var prints → Boolean

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

var visible → Boolean

Whether graphics on this layer are visible.

Layout

Graphic layout information for a canvas.

Instance Properties

var automaticLayout → Boolean

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

var circularLineLength → Number

Optimum line length to try to achieve during circular layout.

var direction → HierarchicalDirection

The hierarchical layout orientation.

var forceDirectedLineLength → Number

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

var forceDirectedSeparation → Number

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

var objectSeparation → Number

Distance between graphics at the same level during hierarchical layout.

var radialSeparation → Number

Distance between graphics during radial layout.

var rankSeparation → Number

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

var type → LayoutType

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

LayoutType

Class Properties

var Circular → LayoutType read-only

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

var ForceDirected → LayoutType read-only

Grows in semi-random directions from the center.

var Hierarchical → LayoutType read-only

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

var Radial → LayoutType read-only

Tries to arrange sibling shapes in arcs around their parent.

var all → Array of LayoutType read-only

LineCap

Class Properties

var Butt → LineCap read-only

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

var Round → LineCap 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 Square → LineCap read-only

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

var all → Array of LineCap read-only

LineJoin

Class Properties

var Bevel → LineJoin read-only

Line segments are joined with a squared-off end.

var Miter → LineJoin read-only

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

var Round → LineJoin read-only

Line segments are joined with a rounded end.

var all → Array of LineJoin read-only

LineType

Class Properties

var Bezier → LineType read-only

Bezier line.

var Curved → LineType read-only

Curved line.

var Orthogonal → LineType read-only

Orthogonal line.

var Straight → LineType read-only

Straight line.

var all → Array of LineType read-only

Locale

Class Properties

var identifiers → Array of String read-only

The list of known ISO locale identifiers.

Constructors

new Locale(identifier: String) → Locale

Instance Properties

var calendar → Calendar read-only

The calendar for the locale.

var currencyCode → String or null read-only

The currency code for the locale.

var identifier → String read-only

The ISO locale identifier for this object.

MenuItem

Instance Properties

var checked → Boolean

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

var image → Image or null

An optional image to be displayed with the MenuItem.

var label → String

The string displayed to describe the MenuItem’s action.

NSWindow

Instance Functions

function close()

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 centerVisiblePoint → Point

var selection → Selection read-only

var zoom → Number

Notification

Constructors

new Notification(title: String) → Notification

Instance Functions

function show() → Promise of Notification

Attempts to present the notification and returns a Promise which will yield the notification object itself if it is clicked or tapped, or an error if it cannot be presented or is dismissed.

Instance Properties

var subtitle → String or null

var title → String

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 children → Array of OGOutlineNode read-only

Child nodes of this node.

var graphic → Graphic or null read-only

Graphic that this outline node represents.

Pasteboard

A pasteboard temporarily holds representations of items of different types for transfer between different applications or different locations in the application.

Class Functions

function makeUnique() → Pasteboard

Creates a new unique pasteboard.

Class Properties

var general → Pasteboard read-only

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

Instance Functions

function availableType(types: Array of TypeIdentifier) → TypeIdentifier or null

The first type from the provided list which is available on the pasteboard, or null if none are available.

function addItems(items: Array of Pasteboard.Item)

Appends the new items to the pasteboard.

function clear()

Remove all items from the pasteboard.

function dataForType(type: TypeIdentifier) → Data or null

The Data representation for the given type in this pasteboard, or null if none is available.

function setDataForType(data: Data, type: TypeIdentifier)

Set the Data representation for the given type in this pasteboard, replacing any previously set data.

function stringForType(type: TypeIdentifier) → String or null

The String representation for the given type in this pasteboard, or null if none is available.

function setStringForType(string: String, type: TypeIdentifier)

Set the String representation for the given type in this pasteboard, replacing any previously set data.

Instance Properties

var URL → URL or null

Gets or sets the pasteboard content as a single URL.

var URLs → Array of URL or null

Gets or sets the pasteboard content as a list of URLs.

var color → Color or null

Gets or sets the pasteboard content as a single color.

var colors → Array of Color or null

Gets or sets the pasteboard content as a list of colors.

var hasColors → Boolean read-only

Returns true if the pasteboard contains one or more colors.

var hasImages → Boolean read-only

Returns true if the pasteboard contains one or more images.

var hasStrings → Boolean read-only

Returns true if the pasteboard contains one or more strings.

var hasURLs → Boolean read-only

Returns true if the pasteboard contains one or more URLs.

var image → Image or null

Gets or sets the pasteboard content as a single image.

var images → Array of Image or null

Gets or sets the pasteboard content as a list of images.

var items → Array of Pasteboard.Item

The array of individual items on the pasteboard, each potentially with their own set of types.

var string → String or null

Gets or sets the pasteboard content as a single plain-text string.

var strings → Array of String or null

Gets or sets the pasteboard content as a list of plain-text strings.

var types → Array of TypeIdentifier read-only

The list of pasteboard types currently available on the pasteboard.

Pasteboard.Item

Constructors

new Pasteboard.Item() → Pasteboard.Item

Make a new empty pasteboard item with no contents.

Instance Functions

function dataForType(type: TypeIdentifier) → Data or null

The Data representation for the given type in this pasteboard item, or null if none is available.

function setDataForType(data: Data, type: TypeIdentifier)

Set the Data representation for the given type in this pasteboard item, replacing any previously set data.

function stringForType(type: TypeIdentifier) → String or null

The String representation for the given type in this pasteboard item, or null if none is available.

function setStringForType(string: String, type: TypeIdentifier)

Set the String representation for the given type in this pasteboard item, replacing any previously set data.

Instance Properties

var types → Array of TypeIdentifier read-only

The list of types available for this pasteboard item.

PlugIn

Class Functions

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

Class Properties

var all → Array of PlugIn read-only

Instance Functions

function library(identifier: String) → PlugIn.Library or null

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

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

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

function resourceNamed(name: String) → URL or null

function imageNamed(name: String) → Image or null

function localizedResourceNamed(filename: String) → FileWrapper or null

Instance Properties

var URL → URL or null read-only

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

var actions → Array of PlugIn.Action read-only

var author → String read-only

Returns the author for the PlugIn.

var description → String read-only

Returns the description provided for the PlugIn.

var displayName → String read-only

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

var handlers → Array of PlugIn.Handler read-only

var identifier → String read-only

The unique identifier of the PlugIn.

var libraries → Array of PlugIn.Library read-only

var version → Version read-only

Returns the current Version for the PlugIn.

PlugIn.Action

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 description → String read-only

var label → String read-only

Returns the default label to use for interface controls that invoke the action.

var longLabel → String read-only

Returns the label to use for interface controls that invoke the action, when a long amount of space is available.

var mediumLabel → String read-only

Returns the label to use for interface controls that invoke the action, when a medium amount of space is available.

var name → String read-only

Returns the name of the PlugIn.Action.

var paletteLabel → String read-only

Returns the label to use for interface controls that show a prototype of the action control, such as on a macOS toolbar configuration sheet.

var perform → Function read-only

var plugIn → PlugIn read-only

Returns the PlugIn that contains this object.

var shortLabel → String read-only

Returns the label to use for interface controls that invoke the action, when a short amount of space is available.

var validate → Function 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

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 invoke → Function read-only

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

var name → String read-only

Returns the name of the PlugIn.Handler.

var plugIn → PlugIn read-only

Returns the PlugIn that contains this object.

var willAttach → Function 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 willDetach → Function 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

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 name → String read-only

Returns the name of the PlugIn.Library.

var plugIn → PlugIn read-only

Returns the PlugIn that contains this object.

var version → Version read-only

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

Point

Class Properties

var unitX → Point read-only

Returns a Point with coordinates (1, 0).

var unitY → Point read-only

Returns a Point with coordinates (0, 1).

var zero → Point 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 length → Number read-only

Returns the distance between the receiver and the origin.

var negative → Point read-only

Returns the component-wise negative of the receiver.

var normalized → Point 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 x → Number

The horizontal axis coordinate of the Point.

var y → Number

The vertical axis coordinate of the Point.

Portfolio

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 app → Application read-only

Returns the shared Application.

var canvases → Array of Canvas read-only

List of canvases in the portfolio.

var console → Console read-only

Returns the shared Console.

var document → GraffleDocument or null read-only

var images → Array 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.

Preferences

Constructors

new Preferences(identifier: String or null) → Preferences

Creates a new Preferences instance. The identifier specified may be null to create an instance for the currently loading plug-in. If it is null and a plug-in is not being loaded, an error will be thrown. Key/value pairs stored in the instance will be prefixed with the identifier and a “.”.

Instance Functions

function read(key: String) → Object or null

Returns the previously stored value for the given key, or null if no value is stored.

function readBoolean(key: String) → Boolean

Returns the previously stored value as a Boolean, or false if there is no stored value or it can’t be converted to a Boolean.

function readString(key: String) → String or null

Returns the previously stored value as a String, or null if there is no stored value or it is not a String.

function readNumber(key: String) → Number

Returns the previously stored value as a Number, or null if there is no stored value or it is not a Number.

function readDate(key: String) → Date or null

Returns the previously stored value as a Date, or null if there is no stored value or it is not a Date.

function readData(key: String) → Data or null

Returns the previously stored value as a Data, or null if there is no stored value or it is not a Data.

function write(key: String, value: Boolean, String, Number, Date, or Data or null)

Stores the specified key/value pair, or removes the pair if value is null.

function remove(key: String)

Removes and previously stored value for the given key.

Instance Properties

var identifier → String read-only

The scoping identifier the instance given when created, or the plug-in identifier if none was given.

Promise

The built-in JavaScript Promise constructor.

Rect

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

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

function union(rect: Rect) → Rect

function intersect(rect: Rect) → Rect

function containsRect(rect: Rect) → Boolean

function containsPoint(point: Point) → Boolean

function intersects(rect: Rect) → Boolean

Instance Properties

var center → Point read-only

var height → Number

var integral → Rect read-only

var isEmpty → Boolean read-only

var isInfinite → Boolean read-only

var isNull → Boolean read-only

var maxX → Number read-only

var maxY → Number read-only

var midX → Number read-only

var midY → Number read-only

var minX → Number read-only

var minY → Number read-only

var origin → Point

var size → Size

var standardized → Rect read-only

var width → Number

var x → Number

var y → Number

Selection

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

Instance Properties

var canvas → Canvas or null read-only

The currently selected canvas.

var document → GraffleDocument or null read-only

The current document whose graphics are selected.

var graphics → Array of Graphic read-only

The currently selected graphics.

var lines → Array of Line read-only

The subset of the currently selected graphics which are lines.

var solids → Array of Solid read-only

The subset of the currently selected graphics which are solids.

var view → GraphicView or null read-only

The current view containing the selection.

ShapeCombination

Class Properties

var Intersect → ShapeCombination read-only

Form the intersection of the shapes.

var None → ShapeCombination read-only

Perform no combination operation.

var Subtract → ShapeCombination read-only

Subtract the shapes from the first shape

var Union → ShapeCombination read-only

Form the union of the shapes.

var Unite → ShapeCombination read-only

An alias for Union.

var all → Array of ShapeCombination read-only

SharePanel

An interface that can display the system share interaction for the given items.

Constructors

new SharePanel(items: Array of URL, String, Image, or FileWrapper) → SharePanel

Create a new share panel with the given items.

Instance Functions

function addItem(shareItem: URL, String, Image, or FileWrapper)

Appends the item to the end of items.

function addItems(shareItems: Array of URL, String, Image, or FileWrapper)

Appends the contents of the given array to the end of items.

function removeItem(shareItem: URL, String, Image, or FileWrapper)

Removes the first occurrence of the item from items if it is present in items.

function removeItems(shareItems: Array of URL, String, Image, or FileWrapper)

Removes the first occurrence of each member of the given array from items if that member is present in items.

function clearItems()

Sets items to an empty array. Note: Calling show when items is empty results in an error, so be sure to add new items after calling this and before calling show.

function show()

Presents the share panel for its items. Calling this when items is empty will result in an error.

Instance Properties

var items → Array of URL, String, Image, or FileWrapper

The items that will be supplied to the system share interaction upon calling show.

Size

Constructors

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

Returns a new Size with the specified width and height.

Instance Properties

var height → Number

var width → Number

Speech

Speech.Boundary

Class Properties

var Immediate → Speech.Boundary read-only

var Word → Speech.Boundary read-only

var all → Array of Speech.Boundary read-only

Speech.Synthesizer

Constructors

new Speech.Synthesizer() → Speech.Synthesizer

Instance Functions

function speakUtterance(utterance: Speech.Utterance)

Enqueues the utterance. If the utterance is already or enqueued or speaking, throws and error.

function stopSpeaking(boundary: Speech.Boundary) → Boolean

function pauseSpeaking(boundary: Speech.Boundary) → Boolean

function continueSpeaking() → Boolean

Instance Properties

var paused → Boolean read-only

var speaking → Boolean read-only

Speech.Utterance

Class Properties

var defaultSpeechRate → Number read-only

var maximumSpeechRate → Number read-only

var minimumSpeechRate → Number read-only

Constructors

new Speech.Utterance(string: String) → Speech.Utterance

Instance Properties

var pitchMultiplier → Number

A value between 0.5 and 2.0, controlling the picth of the utterance.

var postUtteranceDelay → Number

var preUtteranceDelay → Number

var prefersAssistiveTechnologySettings → Boolean

If an assistive technology is on, like VoiceOver, the user’s selected voice, rate and other settings will be used for this speech utterance instead of the default values. If no assistive technologies are on, then the values of the properties on AVSpeechUtterance will be used. Note that querying the properties will not refect the user’s settings.

var rate → Number

A value between Speech.Utterance.minimumSpeechRate and Speech.Utterance.maximumSpeechRate controlling the rate of speech for the utterance.

var string → String or null read-only

var voice → Speech.Voice or null

The voice to use for this utterance, or null in which case the default voice will be used.

var volume → Number

A value between 0.0 and 1.0 controller the volume of the utterance.

Speech.Voice

Class Functions

function withLanguage(code: String or null) → Speech.Voice or null

Returns a voice for the given BCP–47 language code (such as en-US or fr-CA), or the default voice if passed null. Returns null for an invalid langauge code.

function withIdentifier(identifier: String) → Speech.Voice or null

Returns the voice with the given identifier, or null if not found.

Class Properties

var allVoices → Array of Speech.Voice read-only

var currentLanguageCode → String read-only

Instance Properties

var gender → Speech.Voice.Gender read-only

var identifier → String read-only

var language → String read-only

var name → String read-only

Speech.Voice.Gender

Class Properties

var Female → Speech.Voice.Gender read-only

var Male → Speech.Voice.Gender read-only

var Unspecified → Speech.Voice.Gender read-only

var all → Array of Speech.Voice.Gender read-only

Stencil

A stencil containing graphics that can be copied to documents.

Instance Functions

function load(completed: Function(‍stencil: Stencil‍))

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

Instance Properties

var graphics → Array of Graphic read-only

Array of graphics available on the stencil.

var images → Array 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 isLoaded → Boolean read-only

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

var name → String read-only

Name of the stencil.

StringEncoding

Class Properties

var ASCII → StringEncoding read-only

var ISO2022JP → StringEncoding read-only

var ISOLatin1 → StringEncoding read-only

var ISOLatin2 → StringEncoding read-only

var JapaneseEUC → StringEncoding read-only

var MacOSRoman → StringEncoding read-only

var NextStep → StringEncoding read-only

var NonLossyASCII → StringEncoding read-only

var ShiftJIS → StringEncoding read-only

var Symbol → StringEncoding read-only

var UTF16 → StringEncoding read-only

var UTF16BigEndian → StringEncoding read-only

var UTF16LittleEndian → StringEncoding read-only

var UTF32 → StringEncoding read-only

var UTF32BigEndian → StringEncoding read-only

var UTF32LittleEndian → StringEncoding read-only

var UTF8 → StringEncoding read-only

var Unicode → StringEncoding read-only

var WindowsCP1250 → StringEncoding read-only

var WindowsCP1251 → StringEncoding read-only

var WindowsCP1252 → StringEncoding read-only

var WindowsCP1253 → StringEncoding read-only

var WindowsCP1254 → StringEncoding read-only

var all → Array of StringEncoding read-only

StrokeDash

Class Properties

var Dash10on3off2on3off → StrokeDash read-only

var Dash10on3off2on3off2on3off → StrokeDash read-only

var Dash16on9off → StrokeDash read-only

Sixteen point dash segments with nine point gaps.

var Dash16on9off16on9off1on9off → StrokeDash read-only

var Dash16on9off1on9off → StrokeDash read-only

var Dash16on9off1on9off1on9off → StrokeDash read-only

var Dash1on3off → StrokeDash read-only

One point dot segments with three point gaps.

var Dash1on4off → StrokeDash read-only

One point dot segments with four point gaps.

var Dash1on5off → StrokeDash read-only

One point dot segments with five point gaps.

var Dash1on9off → StrokeDash read-only

One point dot segments with nine point gaps.

var Dash20on5off4on5off → StrokeDash read-only

var Dash20on5off4on5off4on5off → StrokeDash read-only

var Dash2on2off → StrokeDash read-only

var Dash40on9off8on9off → StrokeDash read-only

var Dash40on9off8on9off8on9off → StrokeDash read-only

var Dash4on3off1on3off → StrokeDash read-only

var Dash4on3off1on3off1on3off → StrokeDash read-only

var Dash4on3off4on3off1on3off → StrokeDash read-only

var Dash4on4off → StrokeDash read-only

Four point dash segments with four point gaps.

var Dash4on9off1on5off → StrokeDash read-only

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

var Dash4on9off1on5off1on5off → StrokeDash read-only

var Dash8on4off1on4off → StrokeDash read-only

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

var Dash8on5off → StrokeDash read-only

Eight point dash with five point gaps.

var Dash8on5off8on5off1on5off → StrokeDash read-only

var Solid → StrokeDash read-only

Solid stroke with no dash pattern.

var all → Array of StrokeDash read-only

StrokeType

Class Properties

var Double → StrokeType read-only

Double.

var Freehand → StrokeType read-only

Freehand.

var Inner → StrokeType read-only

Inner.

var Outer → StrokeType read-only

Outer.

var Plastic → StrokeType read-only

Plastic.

var Single → StrokeType read-only

Single.

var all → Array of StrokeType read-only

TextAutosizing

Class Properties

var Clip → TextAutosizing read-only

Clip.

var Full → TextAutosizing read-only

Full.

var Overflow → TextAutosizing read-only

Overflow.

var Vertical → TextAutosizing read-only

Vertical.

var all → Array of TextAutosizing read-only

TextFlow

Class Properties

var Clip → TextFlow read-only

Clip.

var FillsShape → TextFlow read-only

Fills shape.

var FollowsPath → TextFlow read-only

Follows path.

var Overflow → TextFlow read-only

Overflow.

var Resize → TextFlow read-only

Resize.

var all → Array of TextFlow read-only

TimeZone

Class Properties

var abbreviations → Array 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 abbreviation → String or null read-only

The abbreviation for the TimeZone.

var daylightSavingTime → Boolean read-only

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

var secondsFromGMT → Number read-only

The current difference in seconds between this TimeZone and GMT.

Timer

Class Functions

function once(interval: Number, action: Function(‍timer: Timer‍)) → 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: Timer‍)) → 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()

Instance Properties

var interval → Number read-only

ToolbarItem

Instance Properties

var image → Image or null

var label → String

var toolTip → String or null

TypeIdentifier

Class Functions

function fromPathExtension(pathExtension: String, isDirectory: Boolean) → TypeIdentifier

Return a TypeIdentifier that matches items that have the given path extension and are (or are not) directories.

Class Properties

var URL → TypeIdentifier read-only

The URL type.

var binaryPropertyList → TypeIdentifier read-only

The binary property list type.

var csv → TypeIdentifier read-only

The comma-separated text type.

var editableTypes → Array of TypeIdentifier read-only

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

var gif → TypeIdentifier read-only

The GIF image type.

var image → TypeIdentifier read-only

A generic type that all image types conform to.

var jpeg → TypeIdentifier read-only

The JPEG image type.

var json → TypeIdentifier read-only

The JSON type.

var pdf → TypeIdentifier read-only

The PDF type.

var plainText → TypeIdentifier read-only

The plain text type.

var png → TypeIdentifier read-only

The PNG image type.

var propertyList → TypeIdentifier read-only

The generic property list type.

var readableTypes → Array of TypeIdentifier read-only

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

var rtf → TypeIdentifier read-only

The RTF type.

var rtfd → TypeIdentifier read-only

The RTFD type.

var tiff → TypeIdentifier read-only

The TIFF image type.

var writableTypes → Array of TypeIdentifier read-only

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

var xmlPropertyList → TypeIdentifier read-only

The XML property list type.

Constructors

new TypeIdentifier(identifier: String) → TypeIdentifier

Returns a new TypeIdentifier with the given identifier.

Instance Functions

function conformsTo(other: TypeIdentifier) → Boolean

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

Instance Properties

var displayName → String read-only

Returns a human-readable description of the type.

var identifier → String read-only

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

var pathExtensions → Array of String read-only

The list of filesystem path extensions used by this type.

URL

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, relativeToURL: URL or null) → URL or null

Parses the string as a URL if possible and returns a new instance, or null if the string is not a valid URL. If baseURL is not null, the result is a relative URL.

function fromPath(path: String, isDirectory: Boolean, relativeToURL: URL or null) → URL

Returns a new file URL with the given path and assumption of whether it is a directory.

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.

Class Properties

var currentAppScheme → String read-only

Returns the URL scheme for the current app.

var documentsDirectory → URL read-only

Returns the application’s Documents directory. This is in the application’s sandbox, and on the Mac is not the user’s Documents directory. This is accessible by the application without using access().

Instance Functions

function fetch(success: Function(‍contents: Data‍), failure: Function(‍error: Error‍) or null)

Get the contents at the destination of this URL.

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

Invoke an x-callback-url API end-point, with the callback functions being invoked when a reply is received. When a reply is received, the parameters of that URL are decoded as JSON, or left as String values if not valid JSON, and stored as properties of a result object. For a successful reply, if the result object has one property, its value is passed as the first argument to the success function. If there are zero or more than one parameters, the full object is passed as the first argument. In both cases, the success function is passed a second argument that is the full object of parameters. The failure callback is always passed the object will all the result parameters, typically errorCode and errorMessage.

function open()

Ask the system to open this URL.

function find(types: Array of TypeIdentifier, recurse: Boolean or null) → Promise of Array of URL

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

function appendingPathComponent(component: String) → URL

Return a new URL with the given string added at the end of the path.

function appendingPathExtension(pathExtension: String) → URL

Returns a new URL with the last path component having the given path extension added, including a separating “.”

function deletingPathExtension() → URL

Returns a new URL with the path extension (if any) of the last path component removed.

function deletingLastPathComponent() → URL

Returns a new URL with the last path component removed.

Instance Properties

var absoluteString → String read-only

Returns the absolute string for the URL.

var absoluteURL → URL read-only

Returns the absolute URL.

var baseURL → URL or null read-only

Returns the base URL if this URL is relative, or null if it is absolute.