(OmniGraffle Professional.app terminology, generated from /Applications/Graphisme/OmniGraffle Professional.app)
Suites |
[#suite_Standard_Suite Standard Suite] [#suite_Text_Suite Text Suite] [#suite_Extended_Text_Suite Extended Text Suite] [#suite_OmniFoundation_Scripting /OmniFoundation Scripting] [#suite_OmniGraffle OmniGraffle] |
Commands |
[#command_add add] [#command_assemble assemble] [#command_bold bold] [#command_close close] [#command_connect connect] [#command_count count] [#command_delete delete] [#command_duplicate duplicate] [#command_exists exists] [#command_flip flip] [#command_get get] [#command_italicize italicize] [#command_layout layout] [#command_make make] [#command_move move] [#command_open open] [#command_page_adjust page_adjust] [#command_print_ print_] [#command_quit quit] [#command_remove remove] [#command_replace replace] [#command_save save] [#command_set set] [#command_slide slide] [#command_unbold unbold] [#command_underline underline] [#command_unitalicize unitalicize] [#command_ununderline ununderline] |
Classes |
[#class_application application] [#class_attribute_run attribute_run] [#class_character character] [#class_color color] [#class_document document] [#class_graphic graphic] [#class_grid grid] [#class_group group] [#class_incoming_line incoming_line] [#class_item item] [#class_label label] [#class_layer layer] [#class_layout_info layout_info] [#class_line line] [#class_outgoing_line outgoing_line] [#class_page page] [#class_paragraph paragraph] [#class_point point] [#class_polygon polygon] [#class_record record] [#class_section section] [#class_shape shape] [#class_solid solid] [#class_text text] [#class_text_attachment text_attachment] [#class_window window] [#class_word word] |
Standard Suite
Common classes and commands for most applications.
Commands
Anchor(command_get)reference.get() -- Get the data for an object.BR
Result: Anything -- the reply for the command
Anchor(command_save)reference.save(...) -- Save an object.BR
[as=UnicodeText] -- The file type in which to save the data.BR [in_=Alias] -- The file in which to save the object.BR Result: None
Anchor(command_set)reference.set(...) -- Set an object's data.BR
to=Anything -- The new value.BR Result: None
Anchor(command_print_)application.print_(...) -- Print an object.BR
[Alias] -- The file(s) or document(s) to be printed.BR Result: None
Anchor(command_duplicate)reference.duplicate(...) -- Copy object(s) and put the copies at a new location.BR
to=InsertionLoc -- The location for the new object(s).BR [with_properties=AERecord] -- Properties to be set in the new duplicated object(s).BR Result: None
Anchor(command_exists)reference.exists() -- Verify if an object exists.BR
Result: Boolean -- the reply for the command
Anchor(command_delete)reference.delete() -- Delete an object.BR
Result: None
Anchor(command_make)application.make(...) -- Make a new object.BR
[with_properties=AERecord] -- The initial values for properties of the object.BR new=Type -- The class of the new object.BR [with_data=Anything] -- The initial data for the object.BR [at=InsertionLoc] -- The location at which to insert the object.BR Result: ObjectSpecifier -- the reply for the command
Anchor(command_open)application.open(...) -- Open an object.BR
[Alias] -- The file(s) to be opened.BR Result: None
Anchor(command_close)reference.close(...) -- Close an object.BR
[saving=k.yes | k.no | k.ask] -- Specifies whether changes should be saved before closing.BR [saving_in=Alias] -- The file in which to save the object.BR Result: None
Anchor(command_count)reference.count(...) -- Return the number of elements of a particular class within an object.BR
[each=Type] -- The class of objects to be counted.BR Result: SInt32 -- the reply for the command
Anchor(command_move)reference.move(...) -- Move object(s) to a new location.BR
to=InsertionLoc -- The new location for the object(s).BR Result: None
Anchor(command_quit)reference.quit(...) -- Quit an application.BR
[saving=k.yes | k.no | k.ask] -- Specifies whether changes should be saved before quitting.BR Result: None
Classes
Anchor(class_document)document -- An /OmniGraffle document
- Parent:
[#class_item item]
modified (r/o) Boolean -- Has the document been modified since the last save?BR path UnicodeText -- The document's path.BR name UnicodeText -- The document's name.BR links_visible Boolean -- Whether link indicators are visibleBR alignment_guides_enabled Boolean -- Whether smart alignment guides are enabledBR distance_guides_enabled Boolean -- Whether smart distance guides are enabledBR show_guides Boolean -- Whether manually set guides are visibleBR page_breaks_visible Boolean -- Whether page breaks are visibleBR magnets_visible Boolean -- Whether magnets are visibleBR
[#class_page pages] -- name | index | relative | range | testBR
Anchor(class_item)item -- A scriptable object.
- Children:
[#class_color color] [#class_label label] [#class_section section] [#class_window window] [#class_layout_info layout_info] [#class_point point] [#class_grid grid] [#class_word word] [#class_page page] [#class_attribute_run attribute_run] [#class_layer layer] [#class_character character] [#class_paragraph paragraph] [#class_application application] [#class_document document] [#class_graphic graphic] [#class_text text]
Anchor(class_window)window -- An /OmniGraffle window
- Parent:
[#class_item item]
zoomed Boolean -- Whether the window is currently zoomed.BR miniaturized Boolean -- Whether the window is currently miniaturized.BR name UnicodeText -- The full title of the window.BR floating (r/o) Boolean -- Whether the window floats.BR modal (r/o) Boolean -- Whether the window is the application's current modal window.BR miniaturizable (r/o) Boolean -- Whether the window can be miniaturized.BR visible Boolean -- Whether the window is currently visible.BR closeable (r/o) Boolean -- Whether the window has a close box.BR resizable (r/o) Boolean -- Whether the window can be resized.BR zoomable (r/o) Boolean -- Whether the window can be zoomed.BR id (r/o) SInt32 -- The unique identifier of the window.BR bounds QDRectangle -- The bounding rectangle of the window.BR titled (r/o) Boolean -- Whether the window has a title bar.BR index SInt32 -- The index of the window in the back-to-front window ordering.BR document (r/o) [#class_document k.document] -- The document whose contents are being displayed in the window.BR zoom ShortFloat -- Current zoom setting for this windowBR page [#class_page k.page] -- Current page this window is viewingBR selection AEList -- Selected graphicsBR
Anchor(class_application)application -- /OmniGraffle
- Parent:
[#class_item item]
version (r/o) UnicodeText -- The version of the application.BR frontmost (r/o) Boolean -- Is this the frontmost (active) application?BR name (r/o) UnicodeText -- The name of the application.BR self (r/o) [#class_graphic k.graphic] -- Graphic clicked to start this scriptBR professional (r/o) Boolean -- Whether this application is /OmniGraffle or /OmniGraffle ProfessionalBR demo (r/o) Boolean -- Is this the demo version of the applicationBR
Anchor(class_color)color -- A color.
- Parent:
[#class_item item]
- Parent:
Text Suite
A set of basic classes for text processing.
Classes
Anchor(class_text_attachment)text_attachment -- Represents an inline text attachment. This class is used mainly for make commands.
- Parent:
[#class_text text]
file_name UnicodeText -- The path to the file for the attachmentBR
Anchor(class_text)text -- Rich (styled) text
- Parent:
[#class_item item]
[#class_text_attachment text_attachment]
size SInt32 -- The size in points of the first character.BR underlined Boolean -- Is the first character underlined?BR baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.BR font UnicodeText -- The name of the font of the first character.BR superscript SInt32 -- The superscript level of the text.BR alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.BR text UnicodeText -- The actual text content.BR color [#class_color k.color] -- The color of the first character.BR
[#class_text_attachment text_attachments] -- index | relative | range | testBR [#class_character characters] -- index | relative | range | testBR [#class_attribute_run attribute_runs] -- index | relative | range | testBR [#class_word words] -- index | relative | range | testBR [#class_paragraph paragraphs] -- index | relative | range | testBR
Anchor(class_attribute_run)attribute_run -- This subdivides the text into chunks that all have the same attributes.
- Parent:
[#class_item item]
size SInt32 -- The size in points of the first character.BR underlined Boolean -- Is the first character underlined?BR baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.BR font UnicodeText -- The name of the font of the first character.BR superscript SInt32 -- The superscript level of the text.BR alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.BR text UnicodeText -- The actual text content.BR color [#class_color k.color] -- The color of the first character.BR
[#class_text_attachment text_attachments] -- index | relative | range | testBR [#class_character characters] -- index | relative | range | testBR [#class_attribute_run attribute_runs] -- index | relative | range | testBR [#class_word words] -- index | relative | range | testBR [#class_paragraph paragraphs] -- index | relative | range | testBR
Anchor(class_character)character -- This subdivides the text into characters.
- Parent:
[#class_item item]
size SInt32 -- The size in points of the first character.BR underlined Boolean -- Is the first character underlined?BR baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.BR font UnicodeText -- The name of the font of the first character.BR superscript SInt32 -- The superscript level of the text.BR alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.BR text UnicodeText -- The actual text content.BR color [#class_color k.color] -- The color of the first character.BR
[#class_text_attachment text_attachments] -- index | relative | range | testBR [#class_character characters] -- index | relative | range | testBR [#class_attribute_run attribute_runs] -- index | relative | range | testBR [#class_word words] -- index | relative | range | testBR [#class_paragraph paragraphs] -- index | relative | range | testBR
Anchor(class_word)word -- This subdivides the text into words.
- Parent:
[#class_item item]
size SInt32 -- The size in points of the first character.BR underlined Boolean -- Is the first character underlined?BR baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.BR font UnicodeText -- The name of the font of the first character.BR superscript SInt32 -- The superscript level of the text.BR alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.BR text UnicodeText -- The actual text content.BR color [#class_color k.color] -- The color of the first character.BR
[#class_text_attachment text_attachments] -- index | relative | range | testBR [#class_character characters] -- index | relative | range | testBR [#class_attribute_run attribute_runs] -- index | relative | range | testBR [#class_word words] -- index | relative | range | testBR [#class_paragraph paragraphs] -- index | relative | range | testBR
Anchor(class_paragraph)paragraph -- This subdivides the text into paragraphs.
- Parent:
[#class_item item]
size SInt32 -- The size in points of the first character.BR underlined Boolean -- Is the first character underlined?BR baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.BR font UnicodeText -- The name of the font of the first character.BR superscript SInt32 -- The superscript level of the text.BR alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.BR text UnicodeText -- The actual text content.BR color [#class_color k.color] -- The color of the first character.BR
[#class_text_attachment text_attachments] -- index | relative | range | testBR [#class_character characters] -- index | relative | range | testBR [#class_attribute_run attribute_runs] -- index | relative | range | testBR [#class_word words] -- index | relative | range | testBR [#class_paragraph paragraphs] -- index | relative | range | testBR
- Parent:
Anchor(suite_Extended_Text_Suite)
Extended Text Suite
Extended functionality for text.
Commands
Anchor(command_underline)reference.underline() -- Underline some textBR
Result: None
Anchor(command_unitalicize)reference.unitalicize() -- Unitalicize some textBR
Result: None
Anchor(command_unbold)reference.unbold() -- Unbold some textBR
Result: None
Anchor(command_ununderline)reference.ununderline() -- Ununderline some textBR
Result: None
Anchor(command_replace)reference.replace(...) BR
[regexp=UnicodeText] -- Regular expression to findBR [string=UnicodeText] -- String to findBR replacement=UnicodeText -- Replacement stringBR Result: None
Anchor(command_italicize)reference.italicize() -- Italicize some textBR
Result: None
Anchor(command_bold)reference.bold() -- Bold some textBR
Result: None
Anchor(suite_OmniFoundation_Scripting)
/OmniFoundation Scripting
OmniFoundation scripting support.
Commands
Anchor(command_remove)reference.remove(...) -- Remove the given object from the container.BR
from_=k.item -- The container from which to remove the object.BR Result: None
Anchor(command_add)reference.add(...) -- Add the given object to the container.BR
to=k.item -- The container to which to add the object.BR Result: None
/OmniGraffle
Omni Graffle Script Suite
Commands
Anchor(command_slide)reference.slide(...) -- Slide graphics by a vector amountBR
by=k.point -- The x and y amounts to shift the graphicsBR Result: None
Anchor(command_layout)reference.layout() -- Layout some graphics, or a whole document using the document's Layout Info.BR
Result: None
Anchor(command_assemble)reference.assemble() -- Group graphicsBR
Result: k.group -- the reply for the command
Anchor(command_flip)reference.flip(...) -- Flip graphicsBR
over=k.vertically | k.horizontally -- Orientation to flip the graphic aroundBR Result: None
Anchor(command_page_adjust)reference.page_adjust() -- Change the number of pages to fit the current graphicsBR
Result: None
Anchor(command_connect)reference.connect(...) -- Draw a line between graphicsBR
Classes
Anchor(class_polygon)polygon -- A polygon graphic
- Parent:
[#class_solid solid]
point_list AEList -- A list containing all the vertexes of the polygonBR
[#class_point points] -- index | relative | range | testBR
Anchor(class_layer)layer -- A layer
- Parent:
[#class_item item]
locked Boolean -- are the layer's graphics locked?BR prints Boolean -- do the layer's graphics print?BR visible Boolean -- are the layer's graphics visible?BR name UnicodeText -- name of the layerBR
[#class_polygon polygons] -- index | relative | range | test | idBR [#class_shape shapes] -- name | index | relative | range | test | idBR [#class_group groups] -- index | relative | range | test | idBR [#class_graphic graphics] -- index | relative | range | test | idBR [#class_solid solids] -- index | relative | range | test | idBR [#class_line lines] -- index | relative | range | test | idBR
Anchor(class_page)page -- A page
- Parent:
[#class_item item]
page_size (r/o) [#class_point k.point] -- Size of each pageBR row_alignment k.bottom | k.middle_ | k.top -- Row alignmentBR grid [#class_grid k.grid] -- Settings for the gridBR column_spacing ShortFloat -- Spacing between graphics in a columnBR script_canvas_color [#class_color k.color] -- Canvas background colorBR column_alignment k.right | k.left | k.center -- Column alignmentBR horizontal_pages SInt32 -- Horizontal pagesBR name UnicodeText -- Name of this pageBR row_spacing ShortFloat -- Spacing between graphics in a rowBR vertical_pages SInt32 -- Vertical pagesBR layout_info [#class_layout_info k.layout_info] -- Settings for automatic layoutBR canvas_size [#class_point k.point] -- Size of the canvas (page size multiplied by number of pages)BR
[#class_polygon polygons] -- index | relative | range | test | idBR [#class_shape shapes] -- name | index | relative | range | test | idBR [#class_group groups] -- index | relative | range | test | idBR [#class_graphic graphics] -- index | relative | range | test | idBR [#class_solid solids] -- index | relative | range | test | idBR [#class_line lines] -- index | relative | range | test | idBR [#class_layer layers] -- name | index | relative | range | testBR
Anchor(class_shape)shape -- A graphic with a shape
- Parent:
[#class_solid solid]
name UnicodeText -- name of the shape ("Rectangle", "Circle", et cetera)BR
Anchor(class_label)label -- A line label
- Parent:
[#class_item item]
offset ShortFloat -- Distance away from the lineBR fill_color [#class_color k.color] -- Fill colorBR filled Boolean -- Is this label filled?BR orientation k.vertical | k.parallel | k.perpendicular | k.horizontal -- Orientation of the textBR text [#class_text k.text] -- Label textBR id (r/o) SInt32 -- Unique identifierBR position ShortFloat -- Position along the line (0 is tail, 1 is head)BR
Anchor(class_point)point -- A point
- Parent:
[#class_item item]
x (r/o) ShortFloat -- x positionBR y (r/o) ShortFloat -- y positionBR
Anchor(class_record)record -- A record with multiple text fields
- Parent:
[#class_solid solid]
[#class_section sections] -- index | relative | range | testBR
Anchor(class_layout_info)layout_info -- Automated layout for a page
- Parent:
[#class_item item]
type k.vertical_hierarchy | k.force_directed | k.horizontal_hierarchy -- Type of layout to performBR adjusts_pages Boolean -- Adjust number of pages automatically with hierarchical layout?BR shape_force ShortFloat -- Repulsive force of shapes in force-directed layoutBR edge_force ShortFloat -- Repulsive force of canvas edge in force-directed layoutBR random_start Boolean -- Start force-directed layout with shapes in random locations?BR animates Boolean -- Animate force-directed layout?BR line_force ShortFloat -- Attractive force of lines in force-directed layoutBR
Anchor(class_line)line -- A line
- Parent:
[#class_graphic graphic]
source [#class_graphic k.graphic] -- Graphic that the tail of the line is connected to.BR tail_magnet SInt32 -- Which magnet of the source graphic the line attaches toBR line_type k.curved | k.orthogonal | k.straight -- Type of the lineBR point_list AEList -- A list containing all the points of the line.BR head_scale ShortFloat -- Scale of line ending on the head of the line (1.0 being the normal size)BR weight ShortFloat -- Weighting to give this line during automatic layout.BR head_magnet SInt32 -- Which magnet of the destination graphic the line attaches toBR destination [#class_graphic k.graphic] -- Graphic that the head of the line is connected to.BR head_type UnicodeText -- Type of line ending on the head of the lineBR tail_scale ShortFloat -- Scale of line ending on the tail of the line (1.0 being the normal size)BR tail_type UnicodeText -- Type of line ending on the tail of the lineBR
Anchor(class_solid)solid -- Any graphic which is solid instead of a line. Includes polygons and shapes.
- Parent:
[#class_graphic graphic]
[#class_record record] [#class_polygon polygon] [#class_shape shape]
text_placement k.bottom | k.middle_ | k.top -- Placement of the text inside the solidBR gradient_color [#class_color k.color] -- For linear and radial fills, this is the ending color.BR fill_color [#class_color k.color] -- The fill color. For linear and radial gradient fills this is the starting colorBR autosizing k.vertically_only | k.clip | k.full | k.overflow -- Autosizing behavior of the solid around the textBR image_scale ShortFloat -- For manual image fills, the scale of the imageBR fill k.linear_fill | k.no_fill | k.solid_fill | k.radial_fill -- The type of fill for this solidBR gradient_angle ShortFloat -- Angle of a linear gradient fill.BR image_sizing k.stretched | k.manual | k.tiled -- How to size and display the image fill.BR gradient_center [#class_point k.point] -- Starting point of a radial gradient fill. (In a square from {-1,-1} to {1,1} so {0,0} is the center of the solid.)BR text [#class_text k.text] -- The text inside the solidBR rotation ShortFloat -- Rotation of the graphic in degreesBR image_offset [#class_point k.point] -- For manual image fills, the offset of the image in the solidBR image UnicodeText -- Set to a file name to load an image fill.BR magnets AEList -- List of magnet points. (In a square from {-1,-1} to {1,1}.BR
Anchor(class_graphic)graphic -- A graphic
- Parent:
[#class_item item]
[#class_outgoing_line outgoing_line] [#class_incoming_line incoming_line] [#class_line line] [#class_solid solid] [#class_group group]
draws_shadow Boolean -- Does this graphic draw its shadow?BR id (r/o) SInt32 -- Unique identifierBR url UnicodeText -- Web link for this graphicBR origin [#class_point k.point] -- Origin of the graphic (position of the upper-left corner of the bounding rectangle)BR shadow_color [#class_color k.color] -- Color of the shadowBR stroke_join k.miter | k.bevel | k.round -- Type of join between segments of the strokeBR size [#class_point k.point] -- Size of the graphic (width and height of the bounding rectangle)BR thickness ShortFloat -- Thickness of the strokeBR page (r/o) [#class_page k.page] -- Page that this graphic is onBR stroke_color [#class_color k.color] -- Color of the strokeBR allows_connections Boolean -- Does this graphic allow connections to it?BR locked Boolean -- Is this graphic locked?BR group (r/o) [#class_group k.group] -- Which group (if any) this graphic is inBR draws_stroke Boolean -- Does this graphic draw its stroke?BR stroke_pattern SInt32 -- Dash pattern of the strokeBR aligns_edges_to_grid Boolean -- When snapped to the grid does this graphic align its edges to the grid? (The alternative is to align its center to the grid.)BR layer [#class_layer k.layer] -- Which layer this graphic is inBR jump [#class_page k.page] -- Destination page of jump actionBR script UnicodeText -- Source of attached AppleScriptBR stroke_cap k.square | k.butt | k.round -- Type of cap at ends of the strokeBR
Anchor(class_group)group -- A grouped set of graphics
- Parent:
[#class_graphic graphic]
[#class_graphic graphics] -- index | relative | range | test | idBR
Anchor(class_grid)grid -- The grid of a page
- Parent:
[#class_item item]
major Boolean -- Does the grid have 'major' lines?BR visible Boolean -- Is the grid visible?BR draws_in_front Boolean -- Does the grid draw in front of all shapes?BR spacing ShortFloat -- Number of pixels between minor grid linesBR snaps Boolean -- Do points snap to the grid?BR script_major_grid_color [#class_color k.color] -- Color of major linesBR major_spacing SInt32 -- The number of minor grid lines for each major lineBR script_grid_color [#class_color k.color] -- Color of the gridBR
Anchor(class_section)section -- One text area in a record
- Parent:
[#class_item item]
size SInt32 -- The size in points of the first character.BR underlined Boolean -- Is the first character underlined?BR baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.BR font UnicodeText -- The name of the font of the first character.BR superscript SInt32 -- The superscript level of the text.BR alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.BR text UnicodeText -- The actual text content.BR color [#class_color k.color] -- The color of the first character.BR
Anchor(class_outgoing_line)outgoing_line -- Outgoing line
- Parent:
[#class_graphic graphic]
source [#class_graphic k.graphic] -- Graphic that the tail of the line is connected to.BR tail_magnet SInt32 -- Which magnet of the source graphic the line attaches toBR line_type k.curved | k.orthogonal | k.straight -- Type of the lineBR point_list AEList -- A list containing all the points of the line.BR head_scale ShortFloat -- Scale of line ending on the head of the line (1.0 being the normal size)BR weight ShortFloat -- Weighting to give this line during automatic layout.BR head_magnet SInt32 -- Which magnet of the destination graphic the line attaches toBR destination [#class_graphic k.graphic] -- Graphic that the head of the line is connected to.BR head_type UnicodeText -- Type of line ending on the head of the lineBR tail_scale ShortFloat -- Scale of line ending on the tail of the line (1.0 being the normal size)BR tail_type UnicodeText -- Type of line ending on the tail of the lineBR
Anchor(class_incoming_line)incoming_line -- Incoming line
- Parent:
[#class_graphic graphic]
source [#class_graphic k.graphic] -- Graphic that the tail of the line is connected to.BR tail_magnet SInt32 -- Which magnet of the source graphic the line attaches toBR line_type k.curved | k.orthogonal | k.straight -- Type of the lineBR point_list AEList -- A list containing all the points of the line.BR head_scale ShortFloat -- Scale of line ending on the head of the line (1.0 being the normal size)BR weight ShortFloat -- Weighting to give this line during automatic layout.BR head_magnet SInt32 -- Which magnet of the destination graphic the line attaches toBR destination [#class_graphic k.graphic] -- Graphic that the head of the line is connected to.BR head_type UnicodeText -- Type of line ending on the head of the lineBR tail_scale ShortFloat -- Scale of line ending on the tail of the line (1.0 being the normal size)BR tail_type UnicodeText -- Type of line ending on the tail of the lineBR
- Parent: