OmniOutliner Classes
Classes • Alert • Application • Array • ColumnArray • Calendar • Color • ColorSpace • Column • Column.Summary • Column.Type • Console • Data • DateComponents • Decimal • Document • OutlineDocument • EditorColumnPosition • Email • Enumeration • Enumeration.Member • EnumerationMemberPosition • Error • FilePicker • FileSaver • FileType • FileWrapper • FileWrapper.Type • Form • Form.Field • Form.Field.Checkbox • Form.Field.Date • Form.Field.Option • Form.Field.String • Formatter • Formatter.Date • Formatter.Decimal • Formatter.Duration • Formatter.Date.Style • Function • Image • Item • Item.ApplyResult • ItemPosition • LigatureStyle • LineCap • Locale • MenuItem • NamedStyle.List • NamedStylePosition • NoteDisplay • Outline • Pasteboard • PlugIn • PlugIn.Action • PlugIn.Handler • PlugIn.Handler.Registration • PlugIn.Library • Point • Promise • Rect • Selection • Size • SortOrdering • State • Style • NamedStyle • Style.Attribute • Text • Text.FindOption • Text.Position • Text.Range • TextAlignment • TextComponent • TimeZone • Timer • ToolbarItem • Tree • Editor • TreeNode • ItemTreeNode • URL • UnderlineAffinity • UnderlinePattern • UnderlineStyle • Version • WritingDirection
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
No documentation available.
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 version
→ String
read-onlyApplication version number.
Array
A JavaScript Array.
ColumnArray
: Array
An array of Column
s.
function byTitle(title:String
)
→ Column
or null
Return the first Column
having the given title, or null
if no such column is in the 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.
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.
Column
No documentation available.
function remove()
Removes a previously added column from its outline. Pre-defined columns like the outline column, note column, and status column cannot be removed. Calling remove()
on them will throw an error.
var enumeration
→ Enumeration
or null
read-onlyIf the column is a of type Column.Type.Enumeration
, this returns the Enumeration
of members defined for use in cells in that column.
var formatter
→ Formatter
or null
Controls the format used to display values displayed in this column. Only some column types allow formatters, and the type of the formatter must match the type of data in the column (for example, a column with a type
of Column.Type.Number
should have a formatter of type Formatter.Number
.
var outline
→ Outline
read-onlyNo documentation available.
var style
→ Style
read-onlyThe style used for cells in this column (which may be overridden by individual rows and their cells).
var textAlignment
→ TextAlignment
Controls the TextAlignment
of the contents of cells in the Column
.
var title
→ String
No documentation available.
var type
→ Column.Type
read-onlyNo documentation available.
Column.Summary
A Summary
can be applied for a Column
in a given Editor
using its setSummaryForColumn()
function. When there is a summary set, it defines a rule for calculating a value to display for a parent row, given the values in its children. Note that this calculated value is not stored in the parent Item
itself and instead can be accessed by the TreeNode
representing the Item
within the Editor
.
var AverageLeaves
→ Column.Summary
read-onlyCalculate the average value over the entries in the descendant Item
s that themselves have no children.
var Hidden
→ Column.Summary
read-onlyHide the value in rows displayed for Item
s that have children.
var Maximum
→ Column.Summary
read-onlyDisplay the maximum value over the children of each Item
.
var Minimum
→ Column.Summary
read-onlyDisplay the minimum value over the children of each Item
.
var State
→ Column.Summary
read-onlyFor Checkbox
columns, calculate the state of the checkbox based off the state of the children. If all children are checked or unchecked, the parent will display a check as well. If there is a mix of children states, the parent will display a mixed state, indicated by a -
.
var Total
→ Column.Summary
read-onlyDisplay the total of the values in the children of each Item
.
Column.Type
No documentation available.
var Checkbox
→ Column.Type
read-onlyNo documentation available.
var Date
→ Column.Type
read-onlyNo documentation available.
var Duration
→ Column.Type
read-onlyNo documentation available.
var Enumeration
→ Column.Type
read-onlyNo documentation available.
var Number
→ Column.Type
read-onlyNo documentation available.
var Text
→ Column.Type
read-onlyNo documentation available.
var identifier
→ String
read-onlyNo documentation available.
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.
OutlineDocument
: Document
No documentation available.
var editors
→ Array
of Editor
read-onlyNo documentation available.
var outline
→ Outline
read-onlyNo documentation available.
EditorColumnPosition
No 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.
Enumeration
No documentation available.
function memberNamed(name:String
)
→ Enumeration.Member
or null
Returns the Enumeration.Member
with specified name, or null
if no member has the given name.
function add(name:String
or null
, at:EnumerationMemberPosition
or null
)
→ Enumeration.Member
Adds a new Enumeration.Member
to the Enumeration
, using the specified name if it is unused (otherwise a unique name is selected automatically). A Enumeration.Member.Position
may be specified to determine where in the list of members the new member is located.
function move(members:Array
of Enumeration.Member
, to:EnumerationMemberPosition
)
Moves the Enumeration.Member
s to the requested position.
var beginning
→ EnumerationMemberPosition
read-onlyReturns an Enumeration.Member.Position
that indicates the position before any other members.
var end
→ EnumerationMemberPosition
read-onlyReturns an Enumeration.Member.Position
that indicates the position before after existing children.
var members
→ Array
of Enumeration.Member
read-onlyReturns the sorted list of Enumeration.Member
s contained in this Enumeration
.
Enumeration.Member
No documentation available.
function remove()
No documentation available.
var after
→ EnumerationMemberPosition
read-onlyReturns an Enumeration.Member.Position
that indicates the position just after this member.
var before
→ EnumerationMemberPosition
read-onlyReturns an Enumeration.Member.Position
that indicates the position just before this member.
var name
→ String
read-onlyNo documentation available.
EnumerationMemberPosition
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.
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.
Formatter
No documentation available.
Formatter.Date
: Formatter
No documentation available.
function withStyle(dateStyle:Formatter.Date.Style
, timeStyle:Formatter.Date.Style
or null
)
→ Formatter.Date
A formatter that will display dates according to the user's "short" format 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.
var iso8601
→ Formatter.Date
read-onlyReturn a date formatter that produces ISO-8601 formatted dates, using the Gregorian calendar and the UTC time zone.
function stringFromDate(date:Date
)
→ String
No documentation available.
function dateFromString(string:String
)
→ Date
or null
No documentation available.
var calendar
→ Calendar
No documentation available.
var dateFormat
→ String
read-onlyNo documentation available.
var locale
→ Locale
No documentation available.
var timeZone
→ TimeZone
No documentation available.
Formatter.Decimal
: Formatter
No documentation available.
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.
var currencyCodes
→ Array
of String
read-onlyReturns the list of known ISO currency codes
var custom
→ Formatter.Decimal
read-onlyReturns a new formatter that can be configured with custom settings.
var decimal
→ Formatter.Decimal
read-onlyReturns a new number formatter that will use both a decimal separator.
var percent
→ Formatter.Decimal
read-onlyReturns a new number formatter that will display the value as a percentage.
var percentWithDecimal
→ Formatter.Decimal
read-onlyReturns a new number formatter that will display the value as a percentage with a decimal separator.
var plain
→ Formatter.Decimal
read-onlyReturns a new number formatter that will not use any separators.
var thousandsAndDecimal
→ Formatter.Decimal
read-onlyReturns a new number formatter that will use both a thousands and decimal separator.
function stringFromDecimal(number:Decimal
)
→ String
or null
No documentation available.
function decimalFromString(string:String
)
→ Decimal
or null
No documentation available.
var decimalSeparator
→ String
No documentation available.
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
No documentation available.
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
No documentation available.
new Formatter.Duration()
→ Formatter.Duration
No documentation available.
function stringFromDecimal(number:Decimal
)
→ String
or null
No documentation available.
function decimalFromString(string:String
)
→ Decimal
or null
No documentation available.
var hoursPerDay
→ Number
No documentation available.
var hoursPerWeek
→ Number
No documentation available.
var useVerboseFormat
→ Boolean
No documentation available.
Formatter.Date.Style
No documentation available.
var Full
→ Formatter.Date.Style
read-onlyUse the user's "full" format as selected in system settings.
var Long
→ Formatter.Date.Style
read-onlyUse the user's "long" format as selected in system settings.
var Medium
→ Formatter.Date.Style
read-onlyUse the user's "medium" format as selected in system settings.
var Short
→ Formatter.Date.Style
read-onlyUse the user's "short" format as selected in system settings.
var all
→ Array
of Formatter.Date.Style
read-onlyAn array of all items of this enumeration.
Function
An object that represents a JavaScript function, allowing native code to call into JavaScript or JavaScript to call into native code.
Image
No documentation available.
Item
No documentation available.
function setValueForColumn(value:Object
or null
, column:Column
)
Assigns a new value or clears the value for the cell defined by the intersection of this Item
and the specified Column
.
function valueForColumn(column:Column
)
→ Object
or null
Returns the current value (or null) for the cell defined by the intersection of this Item
and the specified Column
.
function addChild(position:ItemPosition
or null
, configure:Function
or null
)
→ Item
Adds a new Item
as a child of this item, at the specified position. If no position is specified, the child is added after any existing children. An optional Function
, taking an Item
argument, may be passed to configure properties on the item before it is added to the parent). Returns the added Item
.
function remove()
Removes the Item
from its parent. Attempting to remove the rootItem
of an Outline
will throw an error.
function apply(function:Function
)
Calls the supplied Function
for each Item
in the receiver (including the receiver), passing that item as the single argument. The function may optional return a Item.ApplyResult
to stop or skip some of the items. Any other return value (including none) will continue the application of the function to the remaining items.
var after
→ ItemPosition
read-onlyReturns an ItemPosition
that indicates the slot after this item.
var ancestors
→ Array
of Item
read-onlyReturns a list of all the ancestors of this item, up to but not including the root item of the Outline
.
var before
→ ItemPosition
read-onlyReturns an ItemPosition
that indicates the slot before this item.
var beginning
→ ItemPosition
read-onlyReturns an ItemPosition
that indicates the position before any existing children.
var children
→ Array
of Item
read-onlyReturns the list of items contained by this Item
. Note that if the Editor
has sort orderings specified, or there is a filter in place, the order and number of items returned here may differ from what is seen at the Tree
level.
var childrenAreSections
→ Boolean
Control whether the receiver's children are sections or not. Setting this to true
will expand the item (and its ancestors) in the sidebar.
var descendants
→ Array
of Item
read-onlyReturns a breadth-first ordered array of all the descendants of this Item
.
var descendents
→ Array
of Item
read-onlyDEPRECATED: Old spelling for descendants
.
var end
→ ItemPosition
read-onlyReturns an ItemPosition
that indicates the position before after existing children.
var followingSiblings
→ Array
of Item
read-onlyReturns an array of all the Item
s that share the same parent that are also ordered after this Item
.
var hasChildren
→ Boolean
read-onlyReturns true if the Item
has sub-items.
var identifier
→ String
read-onlyThe identifier for this Item
, which is unique within the containing Outline
. The root item will always report an empty String.
var index
→ Number
read-onlyReturns the index of this Item
among its siblings, or zero for the rootItem
.
var leaves
→ Array
of Item
read-onlyReturns a list of all the items contained by this Item
that have no children. If this item has no children, an empty array is returned (an Item
isn't considered its own leaf).
var level
→ Number
read-onlyReturns the nesting level of the Item
, relative to the root of the item tree. The rootItem
of an Outline
has level zero, its children have level one, and so on.
var note
→ String
A convenience to access the value in the note column for the item.
var outline
→ Outline
read-onlyNo documentation available.
var parent
→ Item
or null
read-onlyReturns the item that contains this item, or null
if this is the root item.
var precedingSiblings
→ Array
of Item
read-onlyReturns an array of all the Item
s that share the same parent that are also ordered before this Item
.
var sections
→ Array
of Item
read-onlyReturns a list of the items under this time that are considered sections
. These are the top-level items which are expanded in the sidebar.
var state
→ State
or null
The status of the row (which maps to the Outline
's statusColumn
). Note that summaries are applied at the Tree
level, so automatically calculated status
values for items with children will not be reflected in this property. A null
status indicates that the checkbox is disabled for this item, and if a summary is enabled for the column, this item does not contribute to the calculation.
var style
→ Style
read-onlyThe style for this Item
, which itself cascades from the Style
for the entire Outline
.
var topic
→ String
A convenience to access the value in the outline column for the item. The result will be a String, no matter what type the outline column is configured to use.
Item.ApplyResult
No documentation available.
var Skip
→ Item.ApplyResult
read-onlyThe descendants of the current Item
are skipped.
var Stop
→ Item.ApplyResult
read-onlyThe call to Item.apply
terminates with no further items being processed.
var all
→ Array
of Item.ApplyResult
read-onlyAn array of all items of this enumeration.
ItemPosition
No documentation available.
LigatureStyle
No documentation available.
var All
→ LigatureStyle
read-onlyUse all of the available ligatures.
var Essential
→ LigatureStyle
read-onlyUse ligatures that are required for proper rendering of text.
var Standard
→ LigatureStyle
read-onlyUse the default ligatures for the given script.
var all
→ Array
of LigatureStyle
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.
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.
NamedStyle.List
No documentation available.
function add(name:String
or null
)
→ NamedStyle
Makes a new NamedStyle
at the end of the NamedStyleList
, and optionally assigns it a name.
function byName(name:String
)
→ NamedStyle
or null
Returns the first named style that has the specified name
, or null
if none do.
function byIdentifier(identifier:String
)
→ NamedStyle
or null
Returns the single named style with the specified identifier
, or null
if no style has that identifier
.
function moveStyles(styles:Array
of NamedStyle
, position:NamedStylePosition
)
Reorders the named styles within the NamedStyleList
. This cannot be used to move styles between documents.
function duplicateStyles(styles:Array
of NamedStyle
, position:NamedStylePosition
)
→ Array
of NamedStyle
No documentation available.
var all
→ Array
of NamedStyle
read-onlyReturns the list of all NamedStyles
. Note that the order determine which attribute values are applied if two named styles have conflicting settings.
var beginning
→ NamedStylePosition
read-onlyReturns a NamedStylePosition
that indicates the position before any existing named styles.
var end
→ NamedStylePosition
read-onlyReturns a NamedStylePosition
that indicates the position before after existing named styles.
NamedStylePosition
No documentation available.
NoteDisplay
No documentation available.
var Inline
→ NoteDisplay
read-onlyDisplay notes inline with the row.
var Pane
→ NoteDisplay
read-onlyDisplay notes in a separate pane.
var all
→ Array
of NoteDisplay
read-onlyAn array of all items of this enumeration.
Outline
No documentation available.
function itemWithIdentifier(identifier:String
)
→ Item
or null
Finds the Item
with the specified identifier, if it exists in this Outline
.
function addColumn(columnType:Column.Type
, position:EditorColumnPosition
, configure:Function
or null
)
→ Column
Adds a column to the outline at the specified position. An optional function, taking a Column
argument, may be passed to configure properties on the column before it is added to the outline). Returns the added column.
function moveColumns(columns:Array
of Column
, position:EditorColumnPosition
)
Moves the indicated columns in the editor. Note that moving the built-in statusColumn
doesn't do anything useful since its position is pinned relative to the outlineColumn
(and using it as a reference in the EditorColumnPosition
won't behave as expected either).
function moveItems(items:Array
of Item
, position:ItemPosition
)
Moves the specified Items
to the new position, which must be in the same Outline
.
function duplicateItems(items:Array
of Item
, position:ItemPosition
)
Duplicates an array of Item
s to a destination location, which must be within the same Outline
. This does a deep copy of the item tree and all the values in each Item
. The rootItem
may not be duplicated.
function levelStyle(depth:Number
)
→ Style
Returns the level style for the specified nesting level, possibly extending the levelStyles
array.
function group(items:Array
of Item
)
→ Item
or null
Makes a new item with the specified items as its children.
function ungroup(items:Array
of Item
)
No documentation available.
function organize(items:Array
of Item
, byColumns:Array
of Column
, underItem:Item
, pruneEmptyGroups:Boolean
or null
)
Rearranges the item trees rooted at items
based on the values in the specified columns (converted to a string representation), and places those items under the specified new parent item. Any items moving to the new parent will be placed at the end of the parent item. If pruneEmptyGroups
is true
, any children of underItem
that end up empty will be removed. As an example, assume you have a document with a enumeration column named "Type":
// Rearrange the leaf items into groups based on their value in the Type column.
// Any previously created Type groups that have no entries will be removed.
organize(rootItem.leaves, [columns.byTitle("Type")], rootItem, true)
function topItems(items:Array
of Item
)
→ Array
of Item
Given an array of Item
s in this Outline
, return the subset of Item
s that are not descendants of some other element of the array.
function bottomItems(items:Array
of Item
)
→ Array
of Item
Given an array of Item
s in this Outline
, return the subset of Item
s that are not ancestors of some other element of the array.
function itemsSortedByPosition(items:Array
of Item
)
→ Array
of Item
Given an array of Item
s in this Outline
, return a sorted array of those Item
s as they are ordered in the Outline
's item tree.
function onCellChanged(handler:PlugIn.Handler
)
→ PlugIn.Handler.Registration
or null
Registers a PlugIn.Handler
to be called when any cell in the Outline
is edited.
var alternateRowColor
→ Color
or null
No documentation available.
var backgroundColor
→ Color
No documentation available.
var baseStyle
→ Style
read-onlyThe default style used for the whole outline.
var columnTitleStyle
→ Style
read-onlyNo documentation available.
var columns
→ ColumnArray
read-onlyReturns an array of all the columns in the Outline
, in an unspecified order.
var document
→ OutlineDocument
or null
read-onlyThe Document
that wraps this Outline
, if any. Most Outline
s will be contained in a document, but an outline might exist purely in memory for some period.
var horizontalGridColor
→ Color
or null
No documentation available.
var levelStyles
→ Array
of Style
read-onlyReturns the styles used by default for Item
s at different nesting levels in the document. The length of this array will be the larger of the currently defined number of level styles or the maximum nesting level of Item
s in the Outline
.
var namedStyles
→ NamedStyle.List
read-onlyNo documentation available.
var noteColumn
→ Column
read-onlyReturns the built-in note column for the outline. Cannot be removed.
var outlineColumn
→ Column
read-onlyReturns the built-in column for the outline which displays the nesting of items. Cannot be removed.
var plugIns
→ Array
of PlugIn
read-onlyReturns the set of PlugIn
s available to this document.
var rootItem
→ Item
read-onlyReturns the root item of the outline. This item isn't displayed in the document, but is the parent of all the "top level" items.
var statusColumn
→ Column
read-onlyReturns the built-in checkbox column for the outline. Cannot be removed.
var styleAttributes
→ Array
of Style.Attribute
read-onlyNo documentation available.
var verticalGridColor
→ Color
or null
No documentation available.
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
.
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
No documentation available.
var allObjects
→ Array
of Object
read-onlyReturns all the objects in the selection.
var columns
→ Array
of Column
read-onlyReturns all the Column
objects in the selection.
var document
→ OutlineDocument
or null
read-onlyNo documentation available.
var editor
→ Editor
or null
read-onlyThe Editor
that contains the selection, or null
.
var items
→ Array
of Item
read-onlyReturns the Item
s represented by the selected ItemTreeNode
s, sorted by their order in the Outline
.
var nodes
→ Array
of ItemTreeNode
read-onlyThe ItemTreeNode
instances for the selected rows.
var outline
→ Outline
or null
read-onlyThe Outline
that contains the selection, or null
.
var styles
→ Array
of Style
read-onlyReturns all the Style
objects in the selection.
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.
SortOrdering
No documentation available.
var Ascending
→ SortOrdering
read-onlySort smaller numerical or lexigraphically preceding values first.
var Descending
→ SortOrdering
read-onlySort larger numerical or lexigraphically later values first.
var all
→ Array
of SortOrdering
read-onlyAn array of all items of this enumeration.
State
No documentation available.
var Checked
→ State
read-onlyThe checkbox value is checked.
var Mixed
→ State
read-onlyThe checkbox value has a mixed state, due to child items having a combination of Checked
and Unchecked
states.
var Unchecked
→ State
read-onlyThe checkbox value is not checked.
var all
→ Array
of State
read-onlyAn array of all items of this enumeration.
Style
No documentation available.
function set(attribute:Style.Attribute
, value:Object
or null
)
→ Boolean
Sets (or clears) the value for the given style attribute. Styles that cascade from this one will inherit this value, if they don't define their own value or have a closer ancestor style that does. Returns true if a change was actually made, false otherwise. Throws an error if the key does not map to a known attribute, or if the value is of the wrong type for the specified attribute.
function get(attribute:Style.Attribute
)
→ Object
or null
Looks up the value for the specified style attribute locally, in the cascading and inherited styles, and finally falling back to the default value for the style attribute.
function localValueForAttribute(attribute:Style.Attribute
)
→ Object
or null
Looks up the value for the specified style attribute locally, returning null if it is not set.
function addNamedStyle(namedStyle:NamedStyle
)
Adds the specified NamedStyle
to the set of named styles to include in this Style
. If the style is already present, or if this would create a loop (adding two NamedStyles
to each other's list of named styles), an error will be thrown.
function removeNamedStyle(namedStyle:NamedStyle
)
Removes the specified NamedStyle
from the set of named styles to include in this Style
. If the style is not present, an error will be thrown.
function influencedBy(otherStyle:Style
)
→ Boolean
Returns true
if the receiver is influenced, directly or indirectly from the passed Style
.
function setStyle(style:Style
)
Updates all the attributes and inherited styles on the receiver to be the same as the argument Style
.
function clear()
Removes all the locally applied style attribute values for this Style
.
var fontFillColor
→ Color
The color used to fill text. Setting the color to null
will remove the setting for this style.
var link
→ URL
or null
read-onlyReturns the URL
link for a style, or null
if there is no link applied. Note that get(Style.Attribute.Link)
on the same style will return the default URL
with an empty toString()
value when there is no URL applied. If the style represents a file attachment and there is no specific link attribute set, the URL
for the file attachment will be returned. If the style represents an file attachment that is embedded in the document, null
will be returned.
var locallyDefinedAttributes
→ Array
of Style.Attribute
read-onlyReturns an array of the Style.Attribute
s defined on this Style
.
var namedStyles
→ Array
of NamedStyle
read-onlyReturns the NamedStyle
s that are directly associated with this Style
. If a style attribute lookup doesn't find a value in the local style, then the named styles will be searched.
NamedStyle
: Style
No documentation available.
function remove()
Removes the NamedStyle
from the document. Any references to it are disconnected as well.
var after
→ NamedStylePosition
read-onlyReturns a NamedStylePosition
that indicates the slot after this item.
var before
→ NamedStylePosition
read-onlyReturns a NamedStylePosition
that indicates the slot before this item.
var identifier
→ String
read-onlyA unique identifier for the style, which is suitable for long-lived references.
var name
→ String
The name of the style that is presented in the interface.
Style.Attribute
No documentation available.
var BackgroundColor
→ Style.Attribute
read-onlyNo documentation available.
var BaselineOffset
→ Style.Attribute
read-onlyNo documentation available.
var BaselineSuperscript
→ Style.Attribute
read-onlyNo documentation available.
var Expansion
→ Style.Attribute
read-onlyNo documentation available.
var FontCondensed
→ Style.Attribute
read-onlyNo documentation available.
var FontFamily
→ Style.Attribute
read-onlyNo documentation available.
var FontFillColor
→ Style.Attribute
read-onlyNo documentation available.
var FontFixedPitch
→ Style.Attribute
read-onlyNo documentation available.
var FontItalic
→ Style.Attribute
read-onlyNo documentation available.
var FontName
→ Style.Attribute
read-onlyNo documentation available.
var FontNarrow
→ Style.Attribute
read-onlyNo documentation available.
var FontSize
→ Style.Attribute
read-onlyNo documentation available.
var FontStrokeColor
→ Style.Attribute
read-onlyNo documentation available.
var FontStrokeWidth
→ Style.Attribute
read-onlyNo documentation available.
var FontWeight
→ Style.Attribute
read-onlyNo documentation available.
var KerningAdjustment
→ Style.Attribute
read-onlyNo documentation available.
var LigatureSelection
→ Style.Attribute
read-onlyNo documentation available.
var Link
→ Style.Attribute
read-onlyNo documentation available.
var Obliqueness
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphAlignment
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphBaseWritingDirection
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphDefaultTabInterval
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphFirstLineHeadIndent
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphHeadIndent
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphLineHeightMultiple
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphLineSpacing
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphMaximumLineHeight
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphMinimumLineHeight
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphSpacing
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphSpacingBefore
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphTabStops
→ Style.Attribute
read-onlyNo documentation available.
var ParagraphTailIndent
→ Style.Attribute
read-onlyNo documentation available.
var ShadowBlurRadius
→ Style.Attribute
read-onlyNo documentation available.
var ShadowColor
→ Style.Attribute
read-onlyNo documentation available.
var ShadowOffset
→ Style.Attribute
read-onlyNo documentation available.
var StrikethroughAffinity
→ Style.Attribute
read-onlyNo documentation available.
var StrikethroughColor
→ Style.Attribute
read-onlyNo documentation available.
var StrikethroughPattern
→ Style.Attribute
read-onlyNo documentation available.
var StrikethroughStyle
→ Style.Attribute
read-onlyNo documentation available.
var UnderlineAffinity
→ Style.Attribute
read-onlyNo documentation available.
var UnderlineColor
→ Style.Attribute
read-onlyNo documentation available.
var UnderlinePattern
→ Style.Attribute
read-onlyNo documentation available.
var UnderlineStyle
→ Style.Attribute
read-onlyNo documentation available.
var defaultValue
→ Object
read-onlyReturns the default value that will be used when a style has no local value for this attribute, nor do any of its associated styles.
var key
→ String
read-onlyReturns the string used to identify this attribute when calling get
or set
on a Style
instance.
Text
No documentation available.
function makeFileAttachment(fileWrapper:FileWrapper
, style:Style
)
→ Text
Returns a new Text
instance that represents a file attachment. The attachment has a single character string content with a special value.
new Text(string:String
, style:Style
)
→ Text
Returns a new Text
instance with the given string contents and Style
applied to the entire range of text.
function textInRange(range:Text.Range
)
→ Text
Returns a copy of the text in the specified range.
function styleForRange(range:Text.Range
)
→ Style
Returns a Style
instance for the given range of the Text
.
function ranges(component:TextComponent
, useEnclosingRange:Boolean
or null
)
→ Array
of Text.Range
Returns an array of TextRange
s for the specified component. If useEnclosingRange
is true
, than any extra characters that separate follow a component will be included in its range. Any extra characters before the first found component will be included in the first range.
function replace(range:Text.Range
, with:Text
)
Replaces the sub-range of the receiving Text
with a copy of the passed in Text
(which remains unchanged).
function append(text:Text
)
Appends the given Text
to the receiver.
function insert(position:Text.Position
, text:Text
)
Inserts a copy of the given Text
at the specified position in the receiver.
function remove(range:Text.Range
)
Removes the indicated sub-range of the receiving Text
.
function find(string:String
, options:Array
of Text.FindOption
or null
, range:Text.Range
or null
)
→ Text.Range
or null
Finds an occurrence of string
within the Text
and returns the enclosing Text.Range
if there is a match. If range
is passed, only that portion of the Text
is searched. The supplied options
, if any, change how the search is performed based on their definition.
var attachments
→ Array
of Text
read-onlyReturns an array of copies of the blocks of Text
in the receiver that represent Attachment
s. Note that editing these instances will not change the original.
var attributeRuns
→ Array
of Text
read-onlyReturns an array of copies of the contiguous blocks of Text
in the receiver that have the same style. Note that editing these instances will not change the original.
var characters
→ Array
of Text
read-onlyReturns an array of copies of the characters in the Text
. Note that editing these instances will not change the original.
var end
→ Text.Position
read-onlyReturns a Text.Position
indicating the end of the Text
.
var fileWrapper
→ FileWrapper
or null
read-onlyReturns the attached file wrapper for the Text
(or rather, the first character of the text), if any.
var paragraphs
→ Array
of Text
read-onlyReturns an array of copies of the paragraphs in the Text
. Note that editing these instances will not change the original. Paragraphs, if ended by a newline, will contain the newline character.
var range
→ Text.Range
read-onlyReturns a Text.Range
that spans the entire Text
.
var sentences
→ Array
of Text
read-onlyReturns an array of copies of the sentences in the Text
. Note that editing these instances will not change the original.
var start
→ Text.Position
read-onlyReturns a Text.Position
indicating the beginning of the Text
.
var string
→ String
Returns a plain String
version of the characters in the Text
. Note that since JavaScript represents Strings as Unicode code points, the length of the returned string may be differnt from the number of characters
in the Text
object.
var style
→ Style
read-onlyReturns a Style
instance for this Text
object.
var words
→ Array
of Text
read-onlyReturns an array of copies of the words in the Text
. Note that editing these instances will not change the original.
Text.FindOption
No documentation available.
var Anchored
→ Text.FindOption
read-onlyMatches must be anchored to the beginning (or end if Backwards is include) of the string or search range.
var Backwards
→ Text.FindOption
read-onlySearch starting from the end of the string or range.
var CaseInsensitive
→ Text.FindOption
read-onlyCompare upper and lower case characters as equal.
var DiacriticInsensitive
→ Text.FindOption
read-onlyIgnore diacritics. For example, "ö" is considered the same as "o".
var ForcedOrdering
→ Text.FindOption
read-onlyForce an ordering between strings that aren't strictly equal.
var Literal
→ Text.FindOption
read-onlyPerform exact character-by-character matching.
var Numeric
→ Text.FindOption
read-onlyOrder numbers by numeric value, not lexigraphically. Only applies to ordered comparisons, not find operations.
var RegularExpression
→ Text.FindOption
read-onlyFor find operations, the string is treated as an ICU-compatible regular expression. If set, no other options can be used except for CaseInsensitive
and Anchored
.
var WidthInsensitive
→ Text.FindOption
read-onlyIgnore width differences. For example, "a" is considered the same as 'FULLWIDTH LATIN SMALL LETTER A' (U+FF41).
var all
→ Array
of Text.FindOption
read-onlyAn array of all items of this enumeration.
Text.Position
No documentation available.
Text.Range
No documentation available.
new Text.Range(start:Text.Position
, end:Text.Position
)
→ Text.Range
No documentation available.
var end
→ Text.Position
read-onlyReturns the Text.Position
for the end of the Text.Range
var isEmpty
→ Boolean
read-onlyReturns true
if the Text.Range
contains no characters.
var start
→ Text.Position
read-onlyReturns the Text.Position
for the beginning of the Text.Range
TextAlignment
No documentation available.
var Center
→ TextAlignment
read-onlyVisually center aligned.
var Justified
→ TextAlignment
read-onlyFully-justified.
var Left
→ TextAlignment
read-onlyVisually left aligned.
var Natural
→ TextAlignment
read-onlyUse the default alignment based on the characters in the text.
var Right
→ TextAlignment
read-onlyVisually right aligned.
var all
→ Array
of TextAlignment
read-onlyAn array of all items of this enumeration.
TextComponent
No documentation available.
var Attachments
→ TextComponent
read-onlyThe ranges of Text which represent Attachments.
var AttributeRuns
→ TextComponent
read-onlyThe ranges of Text which have the same attributes.
var Characters
→ TextComponent
read-onlyThe individual characters of the Text. Note that some characters (like emoji) consist of multiple Unicode code points.
var Paragraphs
→ TextComponent
read-onlyThe paragraphs of Text. Unlike other options, the line breaking characters that end the paragraph are included.
var Sentences
→ TextComponent
read-onlyThe sentences of the Text.
var Words
→ TextComponent
read-onlyThe words in the Text. Whitespace or other word break characters are not included.
var all
→ Array
of TextComponent
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.
Tree
No documentation available.
function nodeForObject(object:Object
)
→ TreeNode
or null
Returns the TreeNode
that represents the object
in this Tree
, or null
if it cannot be found (possibly filtered out).
function nodesForObjects(object:Array
of Object
)
→ Array
of TreeNode
Returns an array of TreeNode
s for the objects that are currently in the Tree
, according to the same filters as nodeForObject()
. The size of the resulting node array may be smaller (even empty) than the passed in objects
array.
function reveal(nodes:Array
of TreeNode
)
Ensures the ancestor nodes of all the specified nodes are expanded.
function select(nodes:Array
of TreeNode
, extending:Boolean
or null
)
Selects the specified TreeNode
s that are visible (nodes with collapsed ancestors cannot be selected). If extending
is true
, the existing selection is not cleared.
var rootNode
→ TreeNode
read-onlyReturns the rootNode
of the Editor
.
var selectedNodes
→ Array
of TreeNode
read-onlyReturns the list of selected TreeNode
s, in the order they appear in the tree.
Editor
: Tree
No documentation available.
function visibilityOfColumn(column:Column
)
→ Boolean
Returns true
if the specified Column
is visible.
function setVisibilityOfColumn(column:Column
, visible:Boolean
)
Sets the visibility of the specified Column
within the Editor
.
function widthForColumn(column:Column
)
→ Number
Returns the width in points used to display the Column
, assuming a zoom factor of 1.0.
function setWidthForColumn(column:Column
, width:Number
)
Sets the width in points used to display the Column
, assuming a zoom factor of 1.0.
function sortOrderingForColumn(column:Column
)
→ SortOrdering
or null
Returns the current sort ordering in this editor for the specified Column
, or null
if no ordering is set.
function setSortOrderingForColumn(column:Column
, order:SortOrdering
or null
)
Changes the sort ordering for the specified Column
in this editor.
function withoutSorting(function:Function
)
→ Object
or null
Temporarily disables any automatic sorting while running the passed in Function
(which is invoked with zero arguments). The result of the function is returned.
function summaryForColumn(column:Column
)
→ Column.Summary
or null
Returns the current Summary
used to calculate cells value for parent items in the specified Column
, or null
if the values are directly editable.
function setSummaryForColumn(column:Column
, summary:Column.Summary
or null
)
Sets or clears the Summary
used to calculate cells value for parent items.
function beforeColumn(column:Column
or null
)
→ EditorColumnPosition
Returns an EditorColumnPosition
that indicates the slot before the specified column, or before all columns if null
is given.
function afterColumn(column:Column
or null
)
→ EditorColumnPosition
Returns an EditorColumnPosition
that indicates the slot after the specified column, or after all columns if null
is given.
function nodeForItem(item:Item
)
→ TreeNode
or null
Deprecated: Please use nodeForObject
instead.
Returns the TreeNode
that represents the item
in this Editor
, or null
if it cannot be found (possibly filtered out, or not contained in the focusedItems
).
function nodesForItems(items:Array
of Item
)
→ Array
of TreeNode
Deprecated: Please use nodeForObjects
instead.
Returns an array of TreeNode
s for the Item
s that are currently in the Editor
's filtered and focused view. The size of the resulting node array may be smaller (even empty) than the passed in items
array.
function scrollToNode(node:TreeNode
)
Attempts to scroll the view so that the specified TreeNode
is visible. If the node is not revealed due to a collapsed ancestor, this may not be possible and no scrolling will be performed.
function indentNodes(nodes:Array
of TreeNode
)
Indents the specified nodes one level, or throws an error if that isn't possible.
function outdentNodes(nodes:Array
of TreeNode
)
Outdents the specified nodes one level, or throws an error if that isn't possible.
function copyNodes(nodes:Array
of TreeNode
, to:Pasteboard
)
Writes a serialized version of the nodes
to the specified pasteboard.
function paste(from:Pasteboard
, parentNode:TreeNode
or null
, childIndex:Number
or null
)
Attempts to read a serialized version of nodes from the pasteboard and create new items at the specified location in the receiver. If a parent node is not specified, then the root node of the receiver is assumed. If a childIndex
is not specified, any new children are placed at the end of the parent's existing children.
var focusedItems
→ Array
of Item
The set of items to show in the content area. If empty, the entire outline is shown.
var foldingEnabled
→ Boolean
When set, cells with text that would layout over multiple lines only show their first line, followed by an ellipsis. Editing a cell that is folded, will temporarily expand it.
var noteDisplay
→ NoteDisplay
Now the notes for each row are displayed, either together with their row when Inline
is selected, or in a separate pane with Pane
.
var selection
→ Selection
read-onlyReturns the current Selection
in the editor.
TreeNode
No documentation available.
function expand(completely:Boolean
or null
)
Attempts to expand the TreeNode
. If completely
is passed, all the child nodes will be expanded as they allow.
function collapse(completely:Boolean
or null
)
Attempts to collapse the TreeNode
. If completely
is passed, all the child nodes will be collapse as they allow.
function expandNote(completely:Boolean
or null
)
Attempts to expand the inline note of the TreeNode
. If completely
is passed, all the child node notes will be expanded.
function collapseNote(completely:Boolean
or null
)
Attempts to collapse the inline note of the TreeNode
. If completely
is passed, all the child node notes will be collapsed.
function reveal()
Expands all the
function apply(function:Function
)
Calls the supplied function for each TreeNode
in the receiver (including the receiver), passing that node as the single argument.
var canCollapse
→ Boolean
read-onlyReturns true
if this TreeNode
can be collapsed.
var canExpand
→ Boolean
read-onlyReturns true
if this TreeNode
can be expanded.
var children
→ Array
of TreeNode
read-onlyReturns the array of children that are visible under this node, according to any filtering that is being done, and in the order specified by any sorting rules that have been established.
var index
→ Number
read-onlyReturns the index of this TreeNode
among its siblings, or zero for the rootNode
.
var isExpanded
→ Boolean
read-onlyReturns true
if this TreeNode
is currently expanded.
var isNoteExpanded
→ Boolean
read-onlyReturns true
if the note of this TreeNode
is currently expanded.
var isRevealed
→ Boolean
read-onlyReturns true
if the TreeNode
is the rootNode
or all of its ancestor nodes are expanded.
var isRootNode
→ Boolean
read-onlyReturns true
if this node is the rootNode
of its tree.
var isSelectable
→ Boolean
read-onlyReturns true
if this TreeNode
can be selected. The rootNode
cannot be selected, nor can nodes that aren't revealed.
var isSelected
→ Boolean
Set to true
if this TreeNode
is in the list of selected nodes for its tree. Attempting to set this to true
will do nothing if the node is not revealed (or is the root node).
var level
→ Number
read-onlyReturns the nesting level of the TreeNode
, relative to the root of the tree. The rootNode
of an Outline
has level zero, its children have level one, and so on. Note that if only a portion of the model is being shown, this level may not match the level of the underlying object
.
var object
→ Object
read-onlyThe model object which this node wraps.
var parent
→ TreeNode
or null
read-onlyReturns the TreeNode
that contains this node, or null
if this is the rootNode
.
var rootNode
→ TreeNode
read-onlyReturns the root TreeNode
for the tree that this node belongs to.
ItemTreeNode
: TreeNode
No documentation available.
function setValueForColumn(value:Object
or null
, column:Column
)
No documentation available.
function valueForColumn(column:Column
)
→ Object
or null
No documentation available.
var state
→ State
or null
The computed status value for this node (which maps to the Outline
's statusColumn
). Setting the state on a parent node will propagate the state down to the children, skipping any children that have their state disabled by having a null
applied locally.
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
)
Invoke an x-callback-url API end-point, with callback results being passed to either the success
or failure
function parameter.
function open()
Ask the system to open this URL.
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.
UnderlineAffinity
No documentation available.
var ByWord
→ UnderlineAffinity
read-onlyUnderline only the words, but not the space between them.
var None
→ UnderlineAffinity
read-onlyUnderline the entire range.
var all
→ Array
of UnderlineAffinity
read-onlyAn array of all items of this enumeration.
UnderlinePattern
No documentation available.
var Dash
→ UnderlinePattern
read-onlyDashed line.
var DashDot
→ UnderlinePattern
read-onlyAlternating dashes and dots.
var DashDotDot
→ UnderlinePattern
read-onlyAlternating dashes and pairs of dots.
var Dot
→ UnderlinePattern
read-onlyDotted line.
var Solid
→ UnderlinePattern
read-onlyA continuous line.
var all
→ Array
of UnderlinePattern
read-onlyAn array of all items of this enumeration.
UnderlineStyle
No documentation available.
var Double
→ UnderlineStyle
read-onlyTwo lines.
var None
→ UnderlineStyle
read-onlyNo underline.
var Single
→ UnderlineStyle
read-onlyA single line.
var Thick
→ UnderlineStyle
read-onlyA single thick line.
var all
→ Array
of UnderlineStyle
read-onlyAn array of all items of this enumeration.
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.
WritingDirection
No documentation available.
var LeftToRight
→ WritingDirection
read-onlyText is laid out from left to right.
var Natural
→ WritingDirection
read-onlyThe text direction follows the Unicode bi-directional algorithm.
var RightToLeft
→ WritingDirection
read-onlyText is laid out from right to left.
var all
→ Array
of WritingDirection
read-onlyAn array of all items of this enumeration.