Home Original page

MacPython/OmniGraffle/ProTerminology

This wiki is in the process of being archived due to lack of usage and the resources necessary to serve it — predominately to bots, crawlers, and LLM companies. Edits are discouraged.
Pages are preserved as they were at the time of archival. For current information, please visit python.org.
If a change to this archive is absolutely needed, requests can be made via the infrastructure@python.org mailing list.

(OmniGraffle Professional.app terminology, generated from /Applications/Graphisme/OmniGraffle Professional.app)

Standard Suite

Common classes and commands for most applications.

Commands

  • reference.get() -- Get the data for an object.

    • Result: Anything -- the reply for the command

    reference.save(...) -- Save an object.

    • [as=UnicodeText] -- The file type in which to save the data.
      [in_=Alias] -- The file in which to save the object.
      Result: None

    reference.set(...) -- Set an object's data.

    • to=Anything -- The new value.
      Result: None

    application.print_(...) -- Print an object.

    • [Alias] -- The file(s) or document(s) to be printed.
      Result: None

    reference.duplicate(...) -- Copy object(s) and put the copies at a new location.

    • to=InsertionLoc -- The location for the new object(s).
      [with_properties=AERecord] -- Properties to be set in the new duplicated object(s).
      Result: None

    reference.exists() -- Verify if an object exists.

    • Result: Boolean -- the reply for the command

    reference.delete() -- Delete an object.

    • Result: None

    application.make(...) -- Make a new object.

    • [with_properties=AERecord] -- The initial values for properties of the object.
      new=Type -- The class of the new object.
      [with_data=Anything] -- The initial data for the object.
      [at=InsertionLoc] -- The location at which to insert the object.
      Result: ObjectSpecifier -- the reply for the command

    application.open(...) -- Open an object.

    • [Alias] -- The file(s) to be opened.
      Result: None

    reference.close(...) -- Close an object.

    • [saving=k.yes | k.no | k.ask] -- Specifies whether changes should be saved before closing.
      [saving_in=Alias] -- The file in which to save the object.
      Result: None

    reference.count(...) -- Return the number of elements of a particular class within an object.

    • [each=Type] -- The class of objects to be counted.
      Result: SInt32 -- the reply for the command

    reference.move(...) -- Move object(s) to a new location.

    • to=InsertionLoc -- The new location for the object(s).
      Result: None

    reference.quit(...) -- Quit an application.

    • [saving=k.yes | k.no | k.ask] -- Specifies whether changes should be saved before quitting.
      Result: None

Classes

  • document -- An /OmniGraffle document

    • Parent: Properties:

      • modified (r/o) Boolean -- Has the document been modified since the last save?
        path UnicodeText -- The document's path.
        name UnicodeText -- The document's name.
        links_visible Boolean -- Whether link indicators are visible
        alignment_guides_enabled Boolean -- Whether smart alignment guides are enabled
        distance_guides_enabled Boolean -- Whether smart distance guides are enabled
        show_guides Boolean -- Whether manually set guides are visible
        page_breaks_visible Boolean -- Whether page breaks are visible
        magnets_visible Boolean -- Whether magnets are visible

      Elements:

      • pages -- name | index | relative | range | test

    item -- A scriptable object.

    window -- An /OmniGraffle window

    • Parent: Properties:

      • zoomed Boolean -- Whether the window is currently zoomed.
        miniaturized Boolean -- Whether the window is currently miniaturized.
        name UnicodeText -- The full title of the window.
        floating (r/o) Boolean -- Whether the window floats.
        modal (r/o) Boolean -- Whether the window is the application's current modal window.
        miniaturizable (r/o) Boolean -- Whether the window can be miniaturized.
        visible Boolean -- Whether the window is currently visible.
        closeable (r/o) Boolean -- Whether the window has a close box.
        resizable (r/o) Boolean -- Whether the window can be resized.
        zoomable (r/o) Boolean -- Whether the window can be zoomed.
        id (r/o) SInt32 -- The unique identifier of the window.
        bounds QDRectangle -- The bounding rectangle of the window.
        titled (r/o) Boolean -- Whether the window has a title bar.
        index SInt32 -- The index of the window in the back-to-front window ordering.
        document (r/o) k.document -- The document whose contents are being displayed in the window.
        zoom ShortFloat -- Current zoom setting for this window
        page k.page -- Current page this window is viewing
        selection AEList -- Selected graphics

    application -- /OmniGraffle

    • Parent: Properties:

      • version (r/o) UnicodeText -- The version of the application.
        frontmost (r/o) Boolean -- Is this the frontmost (active) application?
        name (r/o) UnicodeText -- The name of the application.
        self (r/o) k.graphic -- Graphic clicked to start this script
        professional (r/o) Boolean -- Whether this application is /OmniGraffle or /OmniGraffle Professional
        demo (r/o) Boolean -- Is this the demo version of the application

      Elements:

      • windows -- name | index | relative | range | test | id
        documents -- name | index | relative | range | test

    color -- A color.

Text Suite

A set of basic classes for text processing.

Classes

  • text_attachment -- Represents an inline text attachment. This class is used mainly for make commands.

    • Parent: Properties:

      • file_name UnicodeText -- The path to the file for the attachment

    text -- Rich (styled) text

    • Parent: Children: Properties:

      • size SInt32 -- The size in points of the first character.
        underlined Boolean -- Is the first character underlined?
        baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.
        font UnicodeText -- The name of the font of the first character.
        superscript SInt32 -- The superscript level of the text.
        alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.
        text UnicodeText -- The actual text content.
        color k.color -- The color of the first character.

      Elements:

    attribute_run -- This subdivides the text into chunks that all have the same attributes.

    • Parent: Properties:

      • size SInt32 -- The size in points of the first character.
        underlined Boolean -- Is the first character underlined?
        baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.
        font UnicodeText -- The name of the font of the first character.
        superscript SInt32 -- The superscript level of the text.
        alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.
        text UnicodeText -- The actual text content.
        color k.color -- The color of the first character.

      Elements:

    character -- This subdivides the text into characters.

    • Parent: Properties:

      • size SInt32 -- The size in points of the first character.
        underlined Boolean -- Is the first character underlined?
        baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.
        font UnicodeText -- The name of the font of the first character.
        superscript SInt32 -- The superscript level of the text.
        alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.
        text UnicodeText -- The actual text content.
        color k.color -- The color of the first character.

      Elements:

    word -- This subdivides the text into words.

    • Parent: Properties:

      • size SInt32 -- The size in points of the first character.
        underlined Boolean -- Is the first character underlined?
        baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.
        font UnicodeText -- The name of the font of the first character.
        superscript SInt32 -- The superscript level of the text.
        alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.
        text UnicodeText -- The actual text content.
        color k.color -- The color of the first character.

      Elements:

    paragraph -- This subdivides the text into paragraphs.

    • Parent: Properties:

      • size SInt32 -- The size in points of the first character.
        underlined Boolean -- Is the first character underlined?
        baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.
        font UnicodeText -- The name of the font of the first character.
        superscript SInt32 -- The superscript level of the text.
        alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.
        text UnicodeText -- The actual text content.
        color k.color -- The color of the first character.

      Elements:

Extended Text Suite

Extended functionality for text.

Commands

  • reference.underline() -- Underline some text

    • Result: None

    reference.unitalicize() -- Unitalicize some text

    • Result: None

    reference.unbold() -- Unbold some text

    • Result: None

    reference.ununderline() -- Ununderline some text

    • Result: None

    reference.replace(...)

    reference.italicize() -- Italicize some text

    • Result: None

    reference.bold() -- Bold some text

    • Result: None

/OmniFoundation Scripting

OmniFoundation scripting support.

Commands

  • reference.remove(...) -- Remove the given object from the container.

    • from_=k.item -- The container from which to remove the object.
      Result: None

    reference.add(...) -- Add the given object to the container.

    • to=k.item -- The container to which to add the object.
      Result: None

Omni Graffle Script Suite

Commands

  • reference.slide(...) -- Slide graphics by a vector amount

    • by=k.point -- The x and y amounts to shift the graphics
      Result: None

    reference.layout() -- Layout some graphics, or a whole document using the document's Layout Info.

    • Result: None

    reference.assemble() -- Group graphics

    • Result: k.group -- the reply for the command

    reference.flip(...) -- Flip graphics

    • over=k.vertically | k.horizontally -- Orientation to flip the graphic around
      Result: None

    reference.page_adjust() -- Change the number of pages to fit the current graphics

    • Result: None

    reference.connect(...) -- Draw a line between graphics

    • [with_properties=AERecord] -- The initial values for properties of the line.
      to=Anything -- Graphic or graphics to connect to.
      Result: k.line -- the reply for the command

Classes

  • polygon -- A polygon graphic

    • Parent: Properties:

      • point_list AEList -- A list containing all the vertexes of the polygon

      Elements:

      • points -- index | relative | range | test

    layer -- A layer

    • Parent: Properties:

      • locked Boolean -- are the layer's graphics locked?
        prints Boolean -- do the layer's graphics print?
        visible Boolean -- are the layer's graphics visible?
        name UnicodeText -- name of the layer

      Elements:

      • polygons -- index | relative | range | test | id
        shapes -- name | index | relative | range | test | id
        groups -- index | relative | range | test | id
        graphics -- index | relative | range | test | id
        solids -- index | relative | range | test | id
        lines -- index | relative | range | test | id

    page -- A page

    • Parent: Properties:

      • page_size (r/o) k.point -- Size of each page
        row_alignment k.bottom | k.middle_ | k.top -- Row alignment
        grid k.grid -- Settings for the grid
        column_spacing ShortFloat -- Spacing between graphics in a column
        script_canvas_color k.color -- Canvas background color
        column_alignment k.right | k.left | k.center -- Column alignment
        horizontal_pages SInt32 -- Horizontal pages
        name UnicodeText -- Name of this page
        row_spacing ShortFloat -- Spacing between graphics in a row
        vertical_pages SInt32 -- Vertical pages
        layout_info k.layout_info -- Settings for automatic layout
        canvas_size k.point -- Size of the canvas (page size multiplied by number of pages)

      Elements:

      • polygons -- index | relative | range | test | id
        shapes -- name | index | relative | range | test | id
        groups -- index | relative | range | test | id
        graphics -- index | relative | range | test | id
        solids -- index | relative | range | test | id
        lines -- index | relative | range | test | id
        layers -- name | index | relative | range | test

    shape -- A graphic with a shape

    • Parent: Properties:

      • name UnicodeText -- name of the shape ("Rectangle", "Circle", et cetera)

    label -- A line label

    • Parent: Properties:

      • offset ShortFloat -- Distance away from the line
        fill_color k.color -- Fill color
        filled Boolean -- Is this label filled?
        orientation k.vertical | k.parallel | k.perpendicular | k.horizontal -- Orientation of the text
        text k.text -- Label text
        id (r/o) SInt32 -- Unique identifier
        position ShortFloat -- Position along the line (0 is tail, 1 is head)

    point -- A point

    record -- A record with multiple text fields

    • Parent: Elements:

      • sections -- index | relative | range | test

    layout_info -- Automated layout for a page

    • Parent: Properties:

      • type k.vertical_hierarchy | k.force_directed | k.horizontal_hierarchy -- Type of layout to perform
        adjusts_pages Boolean -- Adjust number of pages automatically with hierarchical layout?
        shape_force ShortFloat -- Repulsive force of shapes in force-directed layout
        edge_force ShortFloat -- Repulsive force of canvas edge in force-directed layout
        random_start Boolean -- Start force-directed layout with shapes in random locations?
        animates Boolean -- Animate force-directed layout?
        line_force ShortFloat -- Attractive force of lines in force-directed layout

    line -- A line

    • Parent: Properties:

      • source k.graphic -- Graphic that the tail of the line is connected to.
        tail_magnet SInt32 -- Which magnet of the source graphic the line attaches to
        line_type k.curved | k.orthogonal | k.straight -- Type of the line
        point_list AEList -- A list containing all the points of the line.
        head_scale ShortFloat -- Scale of line ending on the head of the line (1.0 being the normal size)
        weight ShortFloat -- Weighting to give this line during automatic layout.
        head_magnet SInt32 -- Which magnet of the destination graphic the line attaches to
        destination k.graphic -- Graphic that the head of the line is connected to.
        head_type UnicodeText -- Type of line ending on the head of the line
        tail_scale ShortFloat -- Scale of line ending on the tail of the line (1.0 being the normal size)
        tail_type UnicodeText -- Type of line ending on the tail of the line

      Elements:

      • labels -- index | relative | range | test | id
        points -- index | relative | range | test

    solid -- Any graphic which is solid instead of a line. Includes polygons and shapes.

    • Parent: Children: Properties:

      • text_placement k.bottom | k.middle_ | k.top -- Placement of the text inside the solid
        gradient_color k.color -- For linear and radial fills, this is the ending color.
        fill_color k.color -- The fill color. For linear and radial gradient fills this is the starting color
        autosizing k.vertically_only | k.clip | k.full | k.overflow -- Autosizing behavior of the solid around the text
        image_scale ShortFloat -- For manual image fills, the scale of the image
        fill k.linear_fill | k.no_fill | k.solid_fill | k.radial_fill -- The type of fill for this solid
        gradient_angle ShortFloat -- Angle of a linear gradient fill.
        image_sizing k.stretched | k.manual | k.tiled -- How to size and display the image fill.
        gradient_center 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.)
        text k.text -- The text inside the solid
        rotation ShortFloat -- Rotation of the graphic in degrees
        image_offset k.point -- For manual image fills, the offset of the image in the solid
        image UnicodeText -- Set to a file name to load an image fill.
        magnets AEList -- List of magnet points. (In a square from {-1,-1} to {1,1}.

    graphic -- A graphic

    • Parent: Children: Properties:

      • draws_shadow Boolean -- Does this graphic draw its shadow?
        id (r/o) SInt32 -- Unique identifier
        url UnicodeText -- Web link for this graphic
        origin k.point -- Origin of the graphic (position of the upper-left corner of the bounding rectangle)
        shadow_color k.color -- Color of the shadow
        stroke_join k.miter | k.bevel | k.round -- Type of join between segments of the stroke
        size k.point -- Size of the graphic (width and height of the bounding rectangle)
        thickness ShortFloat -- Thickness of the stroke
        page (r/o) k.page -- Page that this graphic is on
        stroke_color k.color -- Color of the stroke
        allows_connections Boolean -- Does this graphic allow connections to it?
        locked Boolean -- Is this graphic locked?
        group (r/o) k.group -- Which group (if any) this graphic is in
        draws_stroke Boolean -- Does this graphic draw its stroke?
        stroke_pattern SInt32 -- Dash pattern of the stroke
        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.)
        layer k.layer -- Which layer this graphic is in
        jump k.page -- Destination page of jump action
        script UnicodeText -- Source of attached AppleScript
        stroke_cap k.square | k.butt | k.round -- Type of cap at ends of the stroke

      Elements:

    group -- A grouped set of graphics

    • Parent: Elements:

      • graphics -- index | relative | range | test | id

    grid -- The grid of a page

    • Parent: Properties:

      • major Boolean -- Does the grid have 'major' lines?
        visible Boolean -- Is the grid visible?
        draws_in_front Boolean -- Does the grid draw in front of all shapes?
        spacing ShortFloat -- Number of pixels between minor grid lines
        snaps Boolean -- Do points snap to the grid?
        script_major_grid_color k.color -- Color of major lines
        major_spacing SInt32 -- The number of minor grid lines for each major line
        script_grid_color k.color -- Color of the grid

    section -- One text area in a record

    • Parent: Properties:

      • size SInt32 -- The size in points of the first character.
        underlined Boolean -- Is the first character underlined?
        baseline_offset ShortFloat -- Number of pixels shifted above or below the normal baseline.
        font UnicodeText -- The name of the font of the first character.
        superscript SInt32 -- The superscript level of the text.
        alignment k.justified | k.right | k.left | k.natural | k.center -- Alignment of the text.
        text UnicodeText -- The actual text content.
        color k.color -- The color of the first character.

      Elements:

    outgoing_line -- Outgoing line

    • Parent: Properties:

      • source k.graphic -- Graphic that the tail of the line is connected to.
        tail_magnet SInt32 -- Which magnet of the source graphic the line attaches to
        line_type k.curved | k.orthogonal | k.straight -- Type of the line
        point_list AEList -- A list containing all the points of the line.
        head_scale ShortFloat -- Scale of line ending on the head of the line (1.0 being the normal size)
        weight ShortFloat -- Weighting to give this line during automatic layout.
        head_magnet SInt32 -- Which magnet of the destination graphic the line attaches to
        destination k.graphic -- Graphic that the head of the line is connected to.
        head_type UnicodeText -- Type of line ending on the head of the line
        tail_scale ShortFloat -- Scale of line ending on the tail of the line (1.0 being the normal size)
        tail_type UnicodeText -- Type of line ending on the tail of the line

      Elements:

      • labels -- index | relative | range | test | id
        points -- index | relative | range | test

    incoming_line -- Incoming line

    • Parent: Properties:

      • source k.graphic -- Graphic that the tail of the line is connected to.
        tail_magnet SInt32 -- Which magnet of the source graphic the line attaches to
        line_type k.curved | k.orthogonal | k.straight -- Type of the line
        point_list AEList -- A list containing all the points of the line.
        head_scale ShortFloat -- Scale of line ending on the head of the line (1.0 being the normal size)
        weight ShortFloat -- Weighting to give this line during automatic layout.
        head_magnet SInt32 -- Which magnet of the destination graphic the line attaches to
        destination k.graphic -- Graphic that the head of the line is connected to.
        head_type UnicodeText -- Type of line ending on the head of the line
        tail_scale ShortFloat -- Scale of line ending on the tail of the line (1.0 being the normal size)
        tail_type UnicodeText -- Type of line ending on the tail of the line

      Elements:

      • labels -- index | relative | range | test | id
        points -- index | relative | range | test