OmniGraffle Classes
Alert • Application • Array • Calendar • Canvas • CanvasSizingMode • Color • ColorSpace • Console • Data • DateComponents • Decimal • Document • GraffleDocument • Email • Error • FilePicker • FileSaver • FileType • FileWrapper • FileWrapper.Type • FillType • Form • Form.Field • Form.Field.Checkbox • Form.Field.Date • Form.Field.Option • Form.Field.String • Function • Graphic • Group • Subgraph • Table • Line • Solid • Shape • GraphicView • Grid • HierarchicalDirection • HopType • HorizontalAlignment • HorizontalTextAlignment • Image • ImageReference • ImageSizing • Layer • Layout • LayoutType • LineCap • LineJoin • LineType • Locale • MenuItem • NSWindow • OGOutlineNode • Pasteboard • PlugIn • PlugIn.Action • PlugIn.Handler • PlugIn.Handler.Registration • PlugIn.Library • Point • Portfolio • Promise • Rect • Selection • ShapeCombination • Size • Stencil • StrokeDash • StrokeType • TextAutosizing • TextFlow • TimeZone • Timer • ToolbarItem • URL • Version • VerticalAlignment • VerticalTextPlacement
Alert
An alert interface for displaying information to the user, blocking further interaction until the alert is dismissed.
new Alert(title:String
, message:String
)
→ Alert
Create a new alert panel with the given title and text contents.
function show(callback:Function
or null
)
→ Promise
Displays the alert, unless an alert is already being displayed, in which case an error is thrown. If no options have yet been added, a default "OK" option is added. Once the user selects an option, the alert is dismissed. If a callback function was supplied, it is invoked with the zero-based index of the selected option as its argument. A Promise
is returned as well, which may also be used to collect the result of the Alert
.
function addOption(string:String
)
Adds an option button to the alert.
Application
An object representing the OmniGraffle application itself. The type of the global variable app
.
function openDocument(from:Document
or null
, url:URL
, completed:Function
)
Attempts to open the specified document and return a reference to it asynchronously. If the document is already open, the reference is passed along. Note that due to platform sandboxing restrictions, opening the document may fail if the application doesn't have currently permission to access the given URL
. The document, if any, that is associated with the calling script can be passed along to help grant permission to open the new document.
The passed in function will be passed two argument. The first will be either either the Document
or an Error
. On success, the second argument is a Boolean
specifying whether the document was already open.
var commandKeyDown
→ Boolean
read-onlyNo documentation available.
var controlKeyDown
→ Boolean
read-onlyNo documentation available.
var name
→ String
read-onlyApplication name.
var optionKeyDown
→ Boolean
read-onlyNo documentation available.
var platformName
→ String
read-onlyNo documentation available.
var shiftKeyDown
→ Boolean
read-onlyNo documentation available.
var stencils
→ Array
of Stencil
read-onlyList of stencils that OmniGraffle currently has available.
var version
→ String
read-onlyApplication version number.
Array
A JavaScript Array.
Calendar
No documentation available.
var buddhist
→ Calendar
read-onlyNo documentation available.
var chinese
→ Calendar
read-onlyNo documentation available.
var coptic
→ Calendar
read-onlyNo documentation available.
var current
→ Calendar
read-onlyThe user's preferred calendar
var ethiopicAmeteAlem
→ Calendar
read-onlyNo documentation available.
var ethiopicAmeteMihret
→ Calendar
read-onlyNo documentation available.
var gregorian
→ Calendar
read-onlyThe Gregorian calendar.
var hebrew
→ Calendar
read-onlyNo documentation available.
var indian
→ Calendar
read-onlyNo documentation available.
var islamic
→ Calendar
read-onlyNo documentation available.
var islamicCivil
→ Calendar
read-onlyNo documentation available.
var islamicTabular
→ Calendar
read-onlyNo documentation available.
var islamicUmmAlQura
→ Calendar
read-onlyNo documentation available.
var iso8601
→ Calendar
read-onlyNo documentation available.
var japanese
→ Calendar
read-onlyNo documentation available.
var persian
→ Calendar
read-onlyNo documentation available.
var republicOfChina
→ Calendar
read-onlyNo documentation available.
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
.
var identifier
→ String
read-onlyThe ISO identifier for the calendar.
var locale
→ Locale
or null
read-onlyThe locale of the calendar.
var timeZone
→ TimeZone
read-onlyThe time zone of the calendar.
Canvas
No documentation available.
function layout()
Perform automatic layout of all graphics on this canvas.
function layoutGraphics(graphics:Array
of Graphic
)
Perform automatic layout of only the given graphics (all of which need to be on this canvas).
function addShape(shapeName:String
, bounds:Rect
)
→ Shape
Create a new graphic of a given shape and place it on the first visible and unlocked layer.
function newShape()
→ Shape
Create a zero-sized rectangle (presumably to be modified further) and place it on the first visible and unlocked layer.
function newLayer()
→ Layer
Create a new (top-most) layer.
function addLine(start:Point
, end:Point
)
→ Line
Create a new line between two points and place it on the first visible layer.
function newLine()
→ Line
Create a new zero-length line (presumably to be modified further) and place it on the first visible layer.
function addText(text:String
, origin:Point
)
→ Solid
Create a new shape containing text (with no stroke or shadow) and place it on the first visible layer.
function connect(from:Graphic
, to:Graphic
)
→ Line
Create a new line connecting two existing graphics.
function duplicate(graphics:Array
of Graphic
)
→ Array
of Graphic
Duplicate existing graphics onto new graphics placed upon this canvas. The original graphics may be from elsewhere - such as from another canvas, a stencil, or another document.
function orderBefore(model:Canvas
)
Reorder this canvas to be before another canvas in this document.
function orderAfter(model:Canvas
)
Reorder this canvas to be after another canvas in this document.
function remove()
Remove this canvas from the document, deleting it.
function graphicWithId(id:Number
)
→ Graphic
or null
Get the graphic with the given id, if it exists on this canvas.
function graphicWithName(name:String
)
→ Graphic
or null
Get the first graphic with the given name, if any. Note that most graphics do not have names unless they are explicitly set; instead they will be displayed using a placeholder string (such as "Rectangle") in the outline.
function allGraphicsWithUserDataForKey(data:String
, key:String
)
→ Array
of Graphic
Get all graphics with the given data string for the user data key.
function graphicWithUserDataForKey(data:String
, key:String
)
→ Graphic
or null
Get the first graphic with the given data string for the user data key, if any.
function combine(shapes:Array
of Shape
, operation:ShapeCombination
, replaceOriginal:Boolean
or null
)
→ Shape
or null
No documentation available.
function onGraphicChanged(handler:PlugIn.Handler
)
→ PlugIn.Handler.Registration
or null
A handler called when any graphic on this canvas changes any properties.
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-onlyA solid graphic representing the canvas background. Its fill and image properties determine the canvas background appearance.
var canvasSizeIsMeasuredInPages
→ Boolean
No documentation available.
var canvasSizingMode
→ CanvasSizingMode
No documentation available.
var columnAlignment
→ VerticalAlignment
Setting for how graphics ought to be aligned vertically.
var graphics
→ Array
of Graphic
read-onlyAll graphics upon this canvas.
var grid
→ Grid
read-onlySettings for the major and minor grids, if any.
var horizontalPages
→ Number
Number of printer pages wide.
var id
→ Number
read-onlyA unique (within this document) identifying number for this canvas.
var layers
→ Array
of Layer
read-onlyAll layers of this canvas.
var layoutInfo
→ Layout
read-onlyThe automatic layout information describing how graphics should be arranged.
var name
→ String
The title of this canvas.
var outlineRoot
→ OGOutlineNode
read-onlyBuilds 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-onlySize of each page in points.
var rowAlignment
→ HorizontalAlignment
Setting for how graphics ought to be aligned horizontally.
var shapes
→ Array
of Shape
read-onlyNo documentation available.
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
No documentation available.
var Fit
→ CanvasSizingMode
read-onlyResizes to fit its contents.
var Fixed
→ CanvasSizingMode
read-onlySpecific size in pages or in points.
var Infinite
→ CanvasSizingMode
read-onlyNo specific size and no canvas edges.
var all
→ Array
of CanvasSizingMode
read-onlyAn array of all items of this enumeration.
Color
No documentation available.
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.
var black
→ Color
read-onlyA color in the White
colorspace with white component of 0.0.
var blue
→ Color
read-onlyA color in the RGB
colorspace with components (0, 0, 1, 1).
var brown
→ Color
read-onlyA color in the RGB
colorspace with components (0.6, 0.4, 0.2, 1).
var clear
→ Color
read-onlyA color in the White
colorspace with white component of 0.0 and alpha of 0.0 ("transparent black").
var cyan
→ Color
read-onlyA color in the RGB
colorspace with components (0, 1, 1, 1).
var darkGray
→ Color
read-onlyA color in the White
colorspace with white component of 0.333.
var gray
→ Color
read-onlyA color in the White
colorspace with white component of 0.5.
var green
→ Color
read-onlyA color in the RGB
colorspace with components (0, 1, 0, 1).
var lightGray
→ Color
read-onlyA color in the White
colorspace with white component of 0.667.
var magenta
→ Color
read-onlyA color in the RGB
colorspace with components (1, 0, 1, 1).
var orange
→ Color
read-onlyA color in the RGB
colorspace with components (1, 0.5, 0, 1).
var purple
→ Color
read-onlyA color in the RGB
colorspace with components (1, 0, 1, 1).
var red
→ Color
read-onlyA color in the RGB
colorspace with components (1, 0, 0, 1).
var white
→ Color
read-onlyA color in the White
colorspace with white component of 1.0.
var yellow
→ Color
read-onlyA color in the RGB
colorspace with components (1, 1, 0, 1).
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.
var alpha
→ Number
read-onlyReturns the alpha component of the color.
var blue
→ Number
read-onlyReturns the blue component of the color, after converting to a RGB
colorspace.
var brightness
→ Number
read-onlyReturns the brightness component of the color, after converting to a HSB
colorspace.
var colorSpace
→ ColorSpace
read-onlyReturns the colorspace of the instance.
var green
→ Number
read-onlyReturns the green component of the color, after converting to a RGB
colorspace.
var hue
→ Number
read-onlyReturns the hue component of the color, after converting to a HSB
colorspace.
var red
→ Number
read-onlyReturns the red component of the color, after converting to a RGB
colorspace.
var saturation
→ Number
read-onlyReturns the saturation component of the color, after converting to a HSB
colorspace.
var white
→ Number
read-onlyReturns the white component of the color, after converting to a White
colorspace.
ColorSpace
No documentation available.
var CMYK
→ ColorSpace
read-onlyA colorspace with cyan, magenta, yellow, black, and alpha components.
var HSB
→ ColorSpace
read-onlyA colorspace with hue, saturation, and value (or brightness) components.
var Named
→ ColorSpace
read-onlyA space for named colors, like system defined colors, or specific color palette spaces.
var Pattern
→ ColorSpace
read-onlyA colorspace that wraps a pattern image.
var RGB
→ ColorSpace
read-onlyThe sRGB colorspace with red, green, blue, and alpha components.
var White
→ ColorSpace
read-onlyA colorspace with white and alpha components.
var all
→ Array
of ColorSpace
read-onlyAn array of all items of this enumeration.
Console
The Console
allows scripts to log debugging, warning, or error information where it can be viewed in the system console or in the console output area. A single instance of Console
is available to scripts as the console
global variable.
function log(message:Object
, additional:Array
of Object
or null
)
Appends a line to the application console formed by concatenating the given message
(after converting it to a String
), any additional arguments separated by spaces, and finally a newline.
function error(message:Object
, additional:Array
of Object
or null
)
No documentation available.
function info(message:Object
, additional:Array
of Object
or null
)
No documentation available.
function warn(message:Object
, additional:Array
of Object
or null
)
Just calls Console.log
, currently.
function clear()
Clears the console in the user-visible window.
Data
A generic bag of bytes. Mainly useful to be interpreted / converted to some other type.
function fromString(string:String
)
→ Data
Convert from a String
to the UTF8 encoding of that string as Data
function fromBase64(string:String
)
→ Data
No documentation available.
function toString()
→ String
Convert to a String
, assuming that this Data
is encoded as UTF8.
function toBase64()
→ String
Convert to a Base-64 encoded string.
var length
→ Number
read-onlyNumber of bytes in this data.
var toObject
→ Object
or null
read-onlyNo documentation available.
DateComponents
No documentation available.
new DateComponents()
→ DateComponents
No documentation available.
var date
→ Date
or null
read-onlyNo documentation available.
var day
→ Number
or null
No documentation available.
var era
→ Number
or null
No documentation available.
var hour
→ Number
or null
No documentation available.
var minute
→ Number
or null
No documentation available.
var month
→ Number
or null
No documentation available.
var nanosecond
→ Number
or null
No documentation available.
var second
→ Number
or null
No documentation available.
var timeZone
→ TimeZone
or null
No documentation available.
var year
→ Number
or null
No documentation available.
Decimal
The Decimal
class provides support for operating on base-10 numbers, which may not be exactly representable by types like the built-in JavaScript Number
class. Note that Decimal
does not use the built-in arithmetic operations; for example, to add two Decimal
instances, you must use the add()
function.
function fromString(string:String
)
→ Decimal
Parses the given string into a Decimal
. If the string cannot be parsed, notANumber
is returned.
var maximum
→ Decimal
read-onlyReturns the maximum representable Decimal
value.
var minimum
→ Decimal
read-onlyReturns the minimum representable Decimal
value.
var notANumber
→ Decimal
read-onlyReturns a Decimal
that represents a non-number value. Any arithmetic operations involving non-number values will return notANumber
.
var one
→ Decimal
read-onlyReturns a Decimal
representing one.
var zero
→ Decimal
read-onlyReturns a Decimal
representing zero.
function toString()
→ String
Converts the Decimal
to a String
representation.
function add(number:Decimal
)
→ Decimal
Generates a new Decimal
by adding the argument and the receiver.
function subtract(number:Decimal
)
→ Decimal
Generates a new Decimal
by subtracting the argument from the receiver.
function multiply(number:Decimal
)
→ Decimal
Generates a new Decimal
by multiplying the argument and the receiver.
function divide(number:Decimal
)
→ Decimal
Generates a new Decimal
by dividing the receiver by the argument.
function compare(number:Decimal
)
→ Number
Compares the receiver and argument. If the receiver is less than the argument, -1 is returned. If the receiver is greater than the argument, 1 is returned. Otherwise, 0 is returned. notANumber
is considered less than any valid number, and equal to itself.
function equals(number:Decimal
)
→ Boolean
Returns true
if the receiver and argument represent the same number (or both are notANumber
), and false
otherwise.
Document
No documentation available.
function makeNew(resultFunction:Function
)
Create a new document, which can be populated with data and then presented. On iOS, if the document is not presented by the time the resultFunction
returns, it will be closed. On macOS, the document will be left around and accessible to the running script. The resultFunction
will be passed either the new document or an Error
if there was a problem creating the document.
function makeNewAndShow(resultFunction:Function
)
Create a new document and presents it. The resultFunction
will be passed either the new document or an Error
if there was a problem creating the document.
function close(didCancel:Function
or null
)
Close this document. If for some reason the document cannot be closed, the didCancel
function may be called at some point in the future, with the original document as the single argument. For example, on the Mac the user may review unsaved changes and may cancel the close operation. If the document is closed, the didCancel
function will not be called at all.
function save()
Save this document.
function fileWrapper(type:String
or null
)
→ FileWrapper
Deprecated: Please use makeFileWrapper()
instead.
Returns a new FileWrapper
representing the contents of the document formatted as the specified type, or its current fileType
if a null
is passed for the type.
function makeFileWrapper(baseName:String
, type:String
or null
)
→ Promise
Generates a FileWrapper
representing the contents of the document formatted as the specified type, or its current fileType
if a null
is passed for the type. Returns a Promise
that will yield the file wrapper or an error. The returned file wrapper will have a name based off the given baseName
and the default path extension for the requested file type.
function undo()
Undo the last done action.
function redo()
Redo the last undone action.
function show(resultFunction:Function
or null
)
Presents the document, ordering the window forward on macOS, and possibly closing the existing document and opening the new on on iOS.
var canRedo
→ Boolean
read-onlyWhether there are currently any actions that can be redone.
var canUndo
→ Boolean
read-onlyWhether there are currently any actions that can be undone.
var fileType
→ String
or null
read-onlyThe file type identifier the document uses when saving, if set.
var name
→ String
or null
read-onlyDocument name.
var writableTypes
→ Array
of String
read-onlyA list of all of the file types that this document can be written as.
GraffleDocument
: Document
An OmniGraffle document.
function addLocalizations(text:String
)
No documentation available.
var portfolio
→ Portfolio
read-onlyNo documentation available.
var windows
→ Array
of NSWindow
read-onlyNo documentation available.
Email
A set of parameters for generating an email.
new Email()
→ Email
No documentation available.
function generate()
Presents the generated email to the user for them to send (or discard). On iOS, any included attachment FileWrapper
s that are directories will be converted to Zip files.
var blindCarbonCopy
→ String
or null
No documentation available.
var body
→ String
or null
No documentation available.
var carbonCopy
→ String
or null
No documentation available.
var fileWrappers
→ Array
of FileWrapper
No documentation available.
var receiver
→ String
or null
No documentation available.
var subject
→ String
or null
No documentation available.
Error
FilePicker
A FilePicker
allows the user to select URL
s for files via the system-supplied file picking interface.
new FilePicker()
→ FilePicker
Returns a new FilePicker
with default settings.
function show()
→ Promise
Presents the system file selection interface to the user, allowing them to choose one or more files of the given types. The returned Promise
will yield the chosen URL
s 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 URL
s.
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 FileType
or null
The file types that will be allowed. If null
, all file types will be allowed. Defaults to null
.
FileSaver
A FileSaver
allows the user to save a FileWrapper
to a URL
s via the system-supplied file picking interface.
new FileSaver()
→ FileSaver
Returns a new FileSaver
with default settings.
function show(fileWrapper:FileWrapper
)
→ Promise
Presents the system file saving interface to the user, allowing them to choose a location and file name to save the file wrapper. The returned Promise
will yield the chosen URL
on success. If the user cancels chosing, the Promise
will be rejected.
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 FileType
or null
The file types that will be allowed. If null
, all file types will be allowed. Defaults to null
.
FileType
No documentation available.
var binaryPropertyList
→ FileType
read-onlyThe binary property list file type.
var csv
→ FileType
read-onlyThe comma-separated text file type.
var editableTypes
→ Array
of FileType
read-onlyThe list of FileType
s that can be read and written natively by documents in this application.
var gif
→ FileType
read-onlyThe GIF image file type.
var image
→ FileType
read-onlyA generic file type that all image types conform to.
var jpeg
→ FileType
read-onlyThe JPEG image file type.
var json
→ FileType
read-onlyThe JSON file type.
var pdf
→ FileType
read-onlyThe PDF file type.
var plainText
→ FileType
read-onlyThe plain text file type.
var png
→ FileType
read-onlyThe PNG image file type.
var propertyList
→ FileType
read-onlyThe generic property list file type.
var readableTypes
→ Array
of FileType
read-onlyThe list of FileType
s that can be read by documents in this this application.
var rtf
→ FileType
read-onlyThe RTF file type.
var rtfd
→ FileType
read-onlyThe RTFD file type.
var tiff
→ FileType
read-onlyThe TIFF image file type.
var writableTypes
→ Array
of FileType
read-onlyThe list of FileType
s that can be written by documents in this application (though some documents may be exportable only in a subset of these types).
var xmlPropertyList
→ FileType
read-onlyThe XML property list file type.
new FileType(identifier:String
)
→ FileType
Returns a new FileType
with the given identifier.
function conformsTo(fileType:FileType
)
→ Boolean
Returns true
if the instance is the same as the given argument or a more specific type. For example, FileType.png.conformsTo(FileType.image)
will be true
, but FileType.png.conformsTo(FileType.plainText)
will be false
.
var displayName
→ String
read-onlyReturns a human-readable description of the file type.
var identifier
→ String
read-onlyReturns a unique identifier for a file type, suitable for archiving or encoding in scripts.
var pathExtensions
→ Array
of String
read-onlyThe list of filesystem path extensions used by this file type.
FileWrapper
No documentation available.
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 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.
var children
→ Array
of FileWrapper
read-onlyReturns an Array
of child FileWrappers
, if this represents a directory. Otherwise, an empty array is returned.
var contents
→ Data
or null
read-onlyReturns the regular file contents of the wrapper, if this represents a regular file. Otherwise, null
is returned.
var destination
→ URL
or null
read-onlyReturns 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-onlyReturns the type of this FileWrapper
.
FileWrapper.Type
No documentation available.
var Directory
→ FileWrapper.Type
read-onlyA FileWrapper
that represents a directory with zero or more child wrappers.
var File
→ FileWrapper.Type
read-onlyA FileWrapper
that represents a regular file with data contents.
var Link
→ FileWrapper.Type
read-onlyA FileWrapper
that represents a symbolic link to another location.
var all
→ Array
of FileWrapper.Type
read-onlyAn array of all items of this enumeration.
FillType
No documentation available.
var Linear
→ FillType
read-onlyLinear Gradient.
var Marker
→ FillType
read-onlyMarker.
var Plastic
→ FillType
read-onlyPlastic.
var Radial
→ FillType
read-onlyRadial Gradient.
var Solid
→ FillType
read-onlySolid.
var Squiggle
→ FillType
read-onlySquiggle.
var Stipple
→ FillType
read-onlyStipple.
var all
→ Array
of FillType
read-onlyAn array of all items of this enumeration.
Form
Form
provides a mechanism to collect input from the user. Each form contains one or more instances of subclasses of Field
, which are given a key. As the form is filled out, values
object is populated with the values from the user interface.
new Form()
→ Form
No documentation available.
function addField(field:Form.Field
, index:Number
or null
)
Adds the new Field
to the Form
, at the indicated position, or at the end if no position is specified. If the field has a default value, it will be added to the values
result object immediately.
function removeField(field:Form.Field
)
Removes the Field from the
Form. Any entry in the
values` for this field will be removed as well.
function show(title:String
, confirmTitle:String
)
→ Promise
Present the Form
to the user, and return a Promise
to be fullfilled or rejected when the user commits or cancels the form.
var fields
→ Array
of Form.Field
read-onlyThe current Field
instances in the form, which will be visible to the user entering input.
var validate
→ Function
or null
A function to check whether the entered values are acceptable. The form to validate is passed as the argument and the function is expected to return a boolean result. If an Error
is thrown, it's message will be displayed in the form as the reason for validation failure. Note that the validation function may add or remove fields and update entries in the values
object (which will cause the interface to be updated). This is called any time the user edits values, or a field is added or removed.
var values
→ Object
read-onlyAn 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.
var displayName
→ String
or null
read-onlyHuman readable string used as the label for this field.
var key
→ String
read-onlyKey to use when storing the value for this field in the containing form's values
object.
Form.Field.Checkbox
: Form.Field
No documentation available.
new Form.Field.Checkbox(key:String
, displayName:String
or null
, value:Boolean
or null
)
→ Form.Field.Checkbox
Returns a new Checkbox
field, optionally with an initial value (which will be false
if no value is specified).
Form.Field.Date
: Form.Field
No documentation available.
new Form.Field.Date(key:String
, displayName:String
or null
, value:Date
or null
)
→ Form.Field.Date
Returns a new Date
field, optionally with an initial value. The user's date formatting preference will be used to display and determine component ordering when parsing dates. Relative dates like "1d", "tomorrow", "now" can also be entered.
Form.Field.Option
: Form.Field
No documentation available.
new Form.Field.Option(key:String
, displayName:String
or null
, options:Array
of Object
, names:Array
of String
or null
, selected:Object
or null
)
→ Form.Field.Option
Returns a new Option
field, allowing the user to pick from a list of option objects. A list of names may also be given, which must have the same length as the options array if so. If no names are given, the objects are converted to strings for display. An initially selected object (which must be a member of the options array) may also be given.
Form.Field.String
: Form.Field
A field for entering a free-form String
value.
new Form.Field.String(key:String
, displayName:String
or null
, value:String
or null
)
→ Form.Field.String
Returns a new String
field, optionally with an initial value.
Function
An object that represents a JavaScript function, allowing native code to call into JavaScript or JavaScript to call into native code.
Graphic
An individual graphic element on a canvas. Graphic
is an abstract superclass (that is, no actual Graphic
objects exist, only more specialized sub-types of Graphic
such as Line
and Shape
).
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.
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-onlyAn 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-onlyA 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-onlyA 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-onlyA 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 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
→ ObjectUser data for this graphic
Group
: Graphic
A set of grouped graphics represented by a single graphic. Groups can contain more groups, et cetera.
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.
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.
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-onlyAn 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.
new Subgraph(graphics:Array
of Graphic
)
→ Group
No documentation available.
var background
→ Solid
read-onlyThe 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-onlyAn 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.
function withRowsColumns(rows:Number
, columns:Number
, graphics:Array
of Graphic
)
→ Table
No documentation available.
new Table(graphic:Graphic
)
→ Table
No documentation available.
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.
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.
var allLineEndingTypes
→ Array
of String
read-onlyNo documentation available.
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 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'.
var autosizing
→ TextAutosizing
Autosizing behavior of the graphic when the text size changes.
var blendColor
→ Color
or null
The middle color of a three color gradient fill, if the fill style includes such.
var blendFraction
→ Number
The middle fraction of a three color gradient fill, if the fill style includes such.
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 gradientCenter
→ Point
For radial gradients, the position of the center of the gradient.
var gradientColor
→ Color
or null
For gradient fills, the second color (along with the fill color) that the fill goes between.
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-onlyDrawing 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.
var tripleBlend
→ Boolean
Whether the fill includes three colors in a gradient.
Shape
: Solid
A 'Solid' graphic which has a particular shape, either one of the built-in shapes, or a custom bezier shape.
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.
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.
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.
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
No documentation available.
var Bottom
→ HierarchicalDirection
read-onlyRoot of the hierarchy is at the bottom and tree extends upwards.
var Left
→ HierarchicalDirection
read-onlyRoot of the hierarchy is at the left and tree extends rightwards.
var Right
→ HierarchicalDirection
read-onlyRoot of the hierarchy is at the right and tree extends leftwards.
var Top
→ HierarchicalDirection
read-onlyRoot of the hierarchy is at the top and tree extends downwards.
var all
→ Array
of HierarchicalDirection
read-onlyAn array of all items of this enumeration.
HopType
No documentation available.
var Bridge
→ HopType
read-onlyBridge over the other line(s).
var Gap
→ HopType
read-onlyLeave a gap while crossing the other line(s).
var Ignore
→ HopType
read-onlyNo hops, and ignore this line when computing hops for other lines.
var None
→ HopType
read-onlyDon't hop at all.
var Round
→ HopType
read-onlyRounded over the other line(s).
var RoundUnder
→ HopType
read-onlyRounded under the other line(s).
var Square
→ HopType
read-onlySquare shape over the other line(s).
var SquareUnder
→ HopType
read-onlySquare shape under the other line(s).
var ThreeSide
→ HopType
read-onlyThree segments angled over the other line(s).
var ThreeSideUnder
→ HopType
read-onlyThree segments angled under the other line(s).
var TwoSide
→ HopType
read-onlyVee over the other line(s).
var TwoSideUnder
→ HopType
read-onlyVee under the other line(s).
var all
→ Array
of HopType
read-onlyAn array of all items of this enumeration.
HorizontalAlignment
No documentation available.
var Center
→ HorizontalAlignment
read-onlyAlign to horizontal centers.
var Left
→ HorizontalAlignment
read-onlyAlign to left edges.
var Right
→ HorizontalAlignment
read-onlyAlign to right edges.
var all
→ Array
of HorizontalAlignment
read-onlyAn array of all items of this enumeration.
HorizontalTextAlignment
No documentation available.
var Center
→ HorizontalTextAlignment
read-onlyCentered horizontally.
var Justify
→ HorizontalTextAlignment
read-onlySpacing adjusted to fill available horizontal space.
var Left
→ HorizontalTextAlignment
read-onlyAligned left.
var Right
→ HorizontalTextAlignment
read-onlyAligned right.
var all
→ Array
of HorizontalTextAlignment
read-onlyAn array of all items of this enumeration.
Image
No documentation available.
ImageReference
An image inside an OmniGraffle document. The image can be part of the fill for more than one 'Solid' graphic, and all of them will refer to the same 'ImageReference'.
var data
→ Data
or null
read-onlyThe image data bytes.
var originalSize
→ Size
read-onlyOriginal size of the image in pixels.
var uniqueID
→ Number
read-onlyA unique (within this document) identifier for this image reference.
ImageSizing
No documentation available.
var Manual
→ ImageSizing
read-onlyManual.
var Stretched
→ ImageSizing
read-onlyStretched.
var Tiled
→ ImageSizing
read-onlyTiled.
var all
→ Array
of ImageSizing
read-onlyAn array of all items of this enumeration.
Layer
A layer containing graphics on a given canvas.
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.
var graphics
→ Array
of Graphic
read-onlyAll 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.
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
No documentation available.
var Circular
→ LayoutType
read-onlyTries to arrange sibling shapes in a circle around their parent.
var ForceDirected
→ LayoutType
read-onlyGrows in semi-random directions from the center.
var Hierarchical
→ LayoutType
read-onlyCreates layers of equally-ranked objects, extending in one direction..
var Radial
→ LayoutType
read-onlyTries to arrange sibling shapes in arcs around their parent.
var all
→ Array
of LayoutType
read-onlyAn array of all items of this enumeration.
LineCap
No documentation available.
var Butt
→ LineCap
read-onlyThe line has a flat end cap, exactly at the end point of the line.
var Round
→ LineCap
read-onlyThe 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-onlyThe line has a flat end cap, extending half the line width past the end point.
var all
→ Array
of LineCap
read-onlyAn array of all items of this enumeration.
LineJoin
No documentation available.
var Bevel
→ LineJoin
read-onlyLine segments are joined with a squared-off end.
var Miter
→ LineJoin
read-onlyLine segments are joined with a sharp (angled) corner.
var Round
→ LineJoin
read-onlyLine segments are joined with a rounded end.
var all
→ Array
of LineJoin
read-onlyAn array of all items of this enumeration.
LineType
No documentation available.
var Bezier
→ LineType
read-onlyBezier line.
var Curved
→ LineType
read-onlyCurved line.
var Orthogonal
→ LineType
read-onlyOrthogonal line.
var Straight
→ LineType
read-onlyStraight line.
var all
→ Array
of LineType
read-onlyAn array of all items of this enumeration.
Locale
No documentation available.
var identifiers
→ Array
of String
read-onlyThe list of known ISO locale identifiers.
new Locale(identifier:String
)
→ Locale
No documentation available.
var calendar
→ Calendar
read-onlyNo documentation available.
var identifier
→ String
read-onlyNo documentation available.
MenuItem
No documentation available.
var checked
→ Boolean
If true, a checkmark is displayed next to the MenuItem
's label.
var label
→ String
The string displayed to describe the MenuItem
's action.
NSWindow
No documentation available.
function close()
No documentation available.
function setViewForCanvas(canvas:Canvas
, zoom:Number
, center:Point
)
Change the saved position for a canvas, so that this will be the view position and scale shown when that canvas is next selected.
var centerVisiblePoint
→ Point
No documentation available.
var selection
→ Selection
read-onlyNo documentation available.
var zoom
→ Number
No documentation available.
OGOutlineNode
An outline node is one element of a hierarchical organization of the canvas's graphics. Each node represents a single shape, with the lines between shapes determining parent-child relationships. The outline structure is visualized in the Mac applications 'Outline' sidebar tab.
var children
→ Array
of OGOutlineNode
read-onlyChild nodes of this node.
var graphic
→ Graphic
or null
read-onlyGraphic that this outline node represents.
Pasteboard
No documentation available.
function makeUnique()
→ Pasteboard
Creates a new unique pasteboard.
var general
→ Pasteboard
read-onlyThe Pasteboard
used for user-initiated copy/paste support.
PlugIn
No documentation available.
function find(identifier:String
, minimumVersion:Version
or null
)
→ PlugIn
or null
No documentation available.
var all
→ Array
of PlugIn
read-onlyNo documentation available.
function library(identifier:String
)
→ Object
or null
Looks for a PlugIn.Library
in the receiver and returns it if found.
function action(identifier:String
)
→ PlugIn.Action
or null
No documentation available.
function handler(identifier:String
)
→ PlugIn.Handler
or null
No documentation available.
function resourceNamed(name:String
)
→ URL
or null
No documentation available.
function imageNamed(name:String
)
→ Image
or null
No documentation available.
var URL
→ URL
or null
read-onlyReturns the original URL from whence this PlugIn
came, if known.
var actions
→ Array
of PlugIn.Action
read-onlyNo documentation available.
var displayName
→ String
read-onlyReturns the localized, human-readable name for the PlugIn
.
var handlers
→ Array
of PlugIn.Handler
read-onlyNo documentation available.
var identifier
→ String
read-onlyThe unique identifier of the PlugIn
.
var libraries
→ Array
of PlugIn.Library
read-onlyNo documentation available.
var version
→ Version
read-onlyReturns the current Version
for the PlugIn
.
PlugIn.Action
No documentation available.
new PlugIn.Action(perform:Function
)
→ PlugIn.Action
Returns a new PlugIn.Action
. Only used within an action JavaScript file embedded within a PlugIn.
var name
→ String
read-onlyReturns the name of the PlugIn.Action
.
var perform
→ Function
read-onlyNo documentation available.
var plugIn
→ PlugIn
read-onlyReturns the PlugIn
that contains this object.
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
No documentation available.
new PlugIn.Handler(invoke:Function
)
→ PlugIn.Handler
Returns a new PlugIn.Handler
. Only used within an handler JavaScript file embedded within a PlugIn.
var invoke
→ Function
read-onlyThe Function
that will be executed for each handler registered for an event posted by an application object.
var name
→ String
read-onlyReturns the name of the PlugIn.Handler
.
var plugIn
→ PlugIn
read-onlyReturns 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
No documentation available.
function remove()
Removes a previously added event observation.
PlugIn.Library
An object that represents a library from a plug-in.
new PlugIn.Library(version:Version
)
→ PlugIn.Library
Returns a new Library
. Typically only used within a library JavaScript file embedded within a PlugIn.
var name
→ String
read-onlyReturns the name of the PlugIn.Library
.
var plugIn
→ PlugIn
read-onlyReturns the PlugIn
that contains this object.
var version
→ Version
read-onlyReturns the Version
of this library, as passed to the constructor.
Point
No documentation available.
var unitX
→ Point
read-onlyReturns a Point
with coordinates (1, 0)
.
var unitY
→ Point
read-onlyReturns a Point
with coordinates (0, 1)
.
var zero
→ Point
read-onlyReturns the Point
(0, 0)
, the origin.
new Point(x:Number
, y:Number
)
→ Point
Returns a new Point
with the specified coordinates.
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
.
var length
→ Number
read-onlyReturns the distance between the receiver and the origin.
var negative
→ Point
read-onlyReturns the component-wise negative of the receiver.
var normalized
→ Point
read-onlyFor 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
A Portfolio
represents the main contents of an OmniGraffle Document
and is used as the global object in any scripting session that is related to a particular document.
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.
var canvases
→ Array
of Canvas
read-onlyList of canvases in the portfolio.
var document
→ GraffleDocument
or null
read-onlyNo documentation available.
var images
→ Array
of ImageReference
read-onlyA list of all images referenced by any graphic in this document. Each ImageReference
is a unique image and appears only once in the list, even if it is used as the image fill for multiple graphics.
Promise
The built-in JavaScript Promise
constructor.
Rect
No documentation available.
new Rect(x:Number
, y:Number
, width:Number
, height:Number
)
→ Rect
Returns a new Rect
with the specified coordinates and size.
function insetBy(dx:Number
, dy:Number
)
→ Rect
No documentation available.
function offsetBy(dx:Number
, dy:Number
)
→ Rect
No documentation available.
function union(rect:Rect
)
→ Rect
No documentation available.
function intersect(rect:Rect
)
→ Rect
No documentation available.
function containsRect(rect:Rect
)
→ Boolean
No documentation available.
function containsPoint(point:Point
)
→ Boolean
No documentation available.
function intersects(rect:Rect
)
→ Boolean
No documentation available.
var center
→ Point
read-onlyNo documentation available.
var height
→ Number
No documentation available.
var integral
→ Rect
read-onlyNo documentation available.
var isEmpty
→ Boolean
read-onlyNo documentation available.
var isInfinite
→ Boolean
read-onlyNo documentation available.
var isNull
→ Boolean
read-onlyNo documentation available.
var maxX
→ Number
read-onlyNo documentation available.
var maxY
→ Number
read-onlyNo documentation available.
var midX
→ Number
read-onlyNo documentation available.
var midY
→ Number
read-onlyNo documentation available.
var minX
→ Number
read-onlyNo documentation available.
var minY
→ Number
read-onlyNo documentation available.
var origin
→ Point
No documentation available.
var size
→ Size
No documentation available.
var standardized
→ Rect
read-onlyNo documentation available.
var width
→ Number
No documentation available.
var x
→ Number
No documentation available.
var y
→ Number
No documentation available.
Selection
The 'selection' argument to plugin actions, letting them inspect the selection.
var canvas
→ Canvas
or null
read-onlyThe currently selected canvas.
var document
→ GraffleDocument
or null
read-onlyThe current document whose graphics are selected.
var graphics
→ Array
of Graphic
read-onlyThe currently selected graphics.
var lines
→ Array
of Line
read-onlyThe subset of the currently selected graphics which are lines.
var solids
→ Array
of Solid
read-onlyThe subset of the currently selected graphics which are solids.
var view
→ GraphicView
or null
read-onlyThe current view containing the selection.
ShapeCombination
No documentation available.
var Intersect
→ ShapeCombination
read-onlyForm the intersection of the shapes.
var None
→ ShapeCombination
read-onlyPerform no combination operation.
var Subtract
→ ShapeCombination
read-onlySubtract the shapes from the first shape
var Union
→ ShapeCombination
read-onlyForm the union of the shapes.
var Unite
→ ShapeCombination
read-onlyAn alias for Union
.
var all
→ Array
of ShapeCombination
read-onlyAn array of all items of this enumeration.
Size
No documentation available.
new Size(width:Number
, height:Number
)
→ Size
Returns a new Size
with the specified width and height.
var height
→ Number
No documentation available.
var width
→ Number
No documentation available.
Stencil
A stencil containing graphics that can be copied to documents.
function load(completed:Function
)
Load this stencil document into memory so its graphics and images can be accessed.
var graphics
→ Array
of Graphic
read-onlyArray of graphics available on the stencil.
var images
→ Array
of ImageReference
read-onlyA 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-onlyWhether or not this stencil has already been loaded into memory.
var name
→ String
read-onlyName of the stencil.
StrokeDash
No documentation available.
var Dash10on3off2on3off
→ StrokeDash
read-onlyNo documentation available.
var Dash10on3off2on3off2on3off
→ StrokeDash
read-onlyNo documentation available.
var Dash16on9off
→ StrokeDash
read-onlySixteen point dash segments with nine point gaps.
var Dash16on9off16on9off1on9off
→ StrokeDash
read-onlyNo documentation available.
var Dash16on9off1on9off
→ StrokeDash
read-onlyNo documentation available.
var Dash16on9off1on9off1on9off
→ StrokeDash
read-onlyNo documentation available.
var Dash1on3off
→ StrokeDash
read-onlyOne point dot segments with three point gaps.
var Dash1on4off
→ StrokeDash
read-onlyOne point dot segments with four point gaps.
var Dash1on5off
→ StrokeDash
read-onlyOne point dot segments with five point gaps.
var Dash1on9off
→ StrokeDash
read-onlyOne point dot segments with nine point gaps.
var Dash20on5off4on5off
→ StrokeDash
read-onlyNo documentation available.
var Dash20on5off4on5off4on5off
→ StrokeDash
read-onlyNo documentation available.
var Dash2on2off
→ StrokeDash
read-onlyNo documentation available.
var Dash40on9off8on9off
→ StrokeDash
read-onlyNo documentation available.
var Dash40on9off8on9off8on9off
→ StrokeDash
read-onlyNo documentation available.
var Dash4on3off1on3off
→ StrokeDash
read-onlyNo documentation available.
var Dash4on3off1on3off1on3off
→ StrokeDash
read-onlyNo documentation available.
var Dash4on3off4on3off1on3off
→ StrokeDash
read-onlyNo documentation available.
var Dash4on4off
→ StrokeDash
read-onlyFour point dash segments with four point gaps.
var Dash4on9off1on5off
→ StrokeDash
read-onlyFour point dash alternating with one point dots, with nine and five point gaps
var Dash4on9off1on5off1on5off
→ StrokeDash
read-onlyNo documentation available.
var Dash8on4off1on4off
→ StrokeDash
read-onlyEight point dash alternating with one point dots, both with four point gaps.
var Dash8on5off
→ StrokeDash
read-onlyEight point dash with five point gaps.
var Dash8on5off8on5off1on5off
→ StrokeDash
read-onlyNo documentation available.
var Solid
→ StrokeDash
read-onlySolid stroke with no dash pattern.
var all
→ Array
of StrokeDash
read-onlyAn array of all items of this enumeration.
StrokeType
No documentation available.
var Double
→ StrokeType
read-onlyDouble.
var Freehand
→ StrokeType
read-onlyFreehand.
var Inner
→ StrokeType
read-onlyInner.
var Outer
→ StrokeType
read-onlyOuter.
var Plastic
→ StrokeType
read-onlyPlastic.
var Single
→ StrokeType
read-onlySingle.
var all
→ Array
of StrokeType
read-onlyAn array of all items of this enumeration.
TextAutosizing
No documentation available.
var Clip
→ TextAutosizing
read-onlyClip.
var Full
→ TextAutosizing
read-onlyFull.
var Overflow
→ TextAutosizing
read-onlyOverflow.
var Vertical
→ TextAutosizing
read-onlyVertical.
var all
→ Array
of TextAutosizing
read-onlyAn array of all items of this enumeration.
TextFlow
No documentation available.
var Clip
→ TextFlow
read-onlyClip.
var FillsShape
→ TextFlow
read-onlyFills shape.
var FollowsPath
→ TextFlow
read-onlyFollows path.
var Overflow
→ TextFlow
read-onlyOverflow.
var Resize
→ TextFlow
read-onlyResize.
var all
→ Array
of TextFlow
read-onlyAn array of all items of this enumeration.
TimeZone
No documentation available.
var abbreviations
→ Array
of String
read-onlyThe list of known time zone abbreviations.
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.
var abbreviation
→ String
or null
read-onlyThe abbreviation for the TimeZone
.
var daylightSavingTime
→ Boolean
read-onlyReturns true
if the TimeZone
is currently using daylight savings time.
var secondsFromGMT
→ Number
read-onlyThe current difference in seconds between this TimeZone
and GMT.
Timer
No documentation available.
function once(interval:Number
, action:Function
)
→ Timer
Makes a new Timer
that will fire once, after the specified interval (in seconds from the current time). When the Timer
fires, the passed in Function
is called, passing the Timer
as its argument.
function repeating(interval:Number
, action:Function
)
→ Timer
Makes a new Timer
that will fire repeatedly with the specified interval (in seconds, with the first invocation happening that interval after the current time). When the Timer
fires, the passed in Function
is called, passing the Timer
as its argument.
function cancel()
No documentation available.
var interval
→ Number
read-onlyNo documentation available.
ToolbarItem
No documentation available.
var image
→ Image
or null
No documentation available.
var label
→ String
No documentation available.
var toolTip
→ String
or null
No documentation available.
URL
No documentation available.
function choose(types:Array
of String
)
→ URL
or null
Deprecated: Please use FilePicker
instead.
Allows the user to choose a file URL
if possible and returns a new instance, or null
otherwise.
function chooseFolder()
→ URL
or null
Deprecated: Please use FilePicker
instead.
Allows the user to choose a folder URL
if possible and returns a new instance, or null
otherwise.
function fromString(string:String
)
→ URL
or null
Parses the string as a URL
if possible and returns a new instance, or null
otherwise.
function tellScript(app:String
, js:String
, arg:Object
or null
)
→ URL
or null
Creates a URL
to invoke the given JS on the given app (url scheme) appropriate for use with the call function.
function tellFunction(app:String
, jsFunction:Function
, arg:Object
or null
)
→ URL
or null
Creates a URL
to invoke the given JS function on the given app (url scheme) appropriate for use with the call function.
function fetch(success:Function
, failure:Function
or null
)
Get the contents at the destination of this URL.
function call(success:Function
, failure:Function
or null
)
No documentation available.
function find(types:Array
of FileType
, recurse:Boolean
or null
)
→ Promise
Scan a directory URL
for files of the given types. If recurse
is specified and is false, only the immediate contents of the directory will be considered. If recurse
is not specified or is true
, the full directory tree will be scanned.
function toString()
→ String
No documentation available.
var string
→ String
read-onlyString representation of this URL.
var toObject
→ Object
or null
read-onlyNo documentation available.
Version
No documentation available.
new Version(versionString:String
)
→ Version
Parses a string representation of a Version
and returns an instance, or throws an error if the string isn't a valid version.
function equals(version:Version
)
→ Boolean
Returns true if the receiving Version
is equal to the argument Version
.
function atLeast(version:Version
)
→ Boolean
Returns true if the receiving Version
is at the same as or newer than the argument Version
.
function isAfter(version:Version
)
→ Boolean
Returns true if the receiving Version
is strictly after the argument Version
.
function isBefore(version:Version
)
→ Boolean
Returns true if the receiving Version
is strictly before the argument Version
.
var versionString
→ String
read-onlyReturns as an opaque string representation of the Version
, suitable for display or logging. This should never be used in comparisons of any sort.
VerticalAlignment
No documentation available.
var Bottom
→ VerticalAlignment
read-onlyAlign to bottom edges.
var Center
→ VerticalAlignment
read-onlyAlign to vertical centers.
var Top
→ VerticalAlignment
read-onlyAlign to top edges.
var all
→ Array
of VerticalAlignment
read-onlyAn array of all items of this enumeration.
VerticalTextPlacement
No documentation available.
var Bottom
→ VerticalTextPlacement
read-onlyAligned to the bottom of the shape.
var Middle
→ VerticalTextPlacement
read-onlyCentered in the vertical middle of the shape.
var Top
→ VerticalTextPlacement
read-onlyAligned to the top of the shape.
var all
→ Array
of VerticalTextPlacement
read-onlyAn array of all items of this enumeration.