IBM ILOG Dojo Diagrammer 1.1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.diagram

Object » ibm_ilog.diagram

Property Summary

Method Summary

  • AbstractSelectionStrategy(selection, useIndividualConnect)
  • AutomaticPort() The AutomaticPort class represents a port that connects a link to the middle of the closest side of a node.
  • BasicPort() The BasicPort class represents ports that define fixed connection points relative to the rectangular bounds of a node. The 'position' property is an object with 'x' and 'y' properties representing ratios (between 0 and 1) of the width and height of the node. For example, the position { x: 0.5, y: 0.5} defines a connection point at the center of a node, and the position { x: 1, y: 0 } defines a connection point at the top-right of a node. The 'offset' property (another x/y object, but in pixels this time) can be used to alter slightly this relative position.
  • GFXSelectionStrategy()
  • Graph() The Graph object acts as a container for Node and Link objects.
  • GraphElement() An element that can be contained in a Graph.
  • Link() A Link is a graphic object that connects two Node objects.
  • Node() A Node is a graphic object that can be connected to other nodes using Link objects.
  • PortBase() The PortBase class represents the base class for ports.
  • Selectable() Selectable class group all the functionality to store and manage the selection state and style of a component. Link and Node must inherit this class in order to be selectable.
  • Selection(diagram, options) creates a new instance
  • StoreSelectionStrategy()
  • Subgraph() A Subgraph is a Node that contains a nested Graph.
  • SwimLane() Represents a swim lane in a Dojo Diagrammer graph.
  • declareTemplate(template)
  • gfxDeclaration(ctor)
  • gfxDeclare(name, superclass, declarations)

Attached Objects

Properties

LinkDecorationOrthogonalAlignment
LinkDecorationParallelAlignment
LinkDecorationPositionType
LinkShapeType
adorners
data
editor
gfxlayout
gfxwidget
graphlayout
interactors
overview
style
templates
templating
util
widget

Methods

AbstractSelectionStrategy
ParameterTypeDescription
selection
useIndividualConnect
AutomaticPort
The AutomaticPort class represents a port that connects a link to the middle of the closest side of a node.
BasicPort

The default position is { x: 0.5, y: 0.5 }, and the default offset is { x: 0, y: 0 }.

GFXSelectionStrategy
Graph
The Graph object acts as a container for Node and Link objects.
GraphElement
An element that can be contained in a Graph.
Link

The link is a templatable object that connects two nodes. A link is created by calling graph.createLink(template), where 'graph' is an ibmilog.diagram.Graph instance, and 'template' is a GFX definition of the shapes that make up the link. The template must contain at least a GFX shape that will represent the polyline shape of the link. This shape must have a "dojoAttachPoint: 'path'" property. The template can contain one or two shapes representing the start and/or end arrows of the link, with "dojoAttachPoint: 'startArrow'" and "dojoAttachPoint: 'endArrow'" properties. The template can also contain decorations, that is, shapes that will placed placed automatically along the link's path. Decorations are identified by a isDecoration property which must be set to true. Additional properties can be specified to define how a decoration is placed and aligned on the path. See the getDecorations() method for more details.

Node
A Node is a graphic object that can be connected to other nodes using Link objects.
PortBase

A port defines a connection point between a Link and a Node. The PortBase class is intended as the base class for subclasses that define different types of ports. PortBase instances should not be created directly, only its subclasses should be used.

Selectable
Selectable class group all the functionality to store and manage the selection state and style of a component. Link and Node must inherit this class in order to be selectable.
Selection
creates a new instance
ParameterTypeDescription
diagram
options
StoreSelectionStrategy
Subgraph

Subgraph objects are used to implemented nested graphs, that is, graphs contained in graphs. A Subgraph can be collapsed (i.e., its nested graph is hidden and replaced by a plain node) or expanded (i.e., its nested graph is fully displayed).

SwimLane

The SwimLane object is a special type of Subgraph used to divide a diagram into horizontal or vertical "stripes" that typically represent the different participants in a business process or workflow diagram. The differences with a plain Subgraph object are:

  • The swim lane has its own position and size, it does not adapt automatically to its contents.
  • The position and orientation of the title bar can be changed using the setVertical() and setRightToLeft() methods.
  • Nested swim lanes (that is, swim lanes contained in another swim lane) can be automatically stacked inside their parent lane (see setStackSublanes).

declareTemplate
ParameterTypeDescription
template
gfxDeclaration
ParameterTypeDescription
ctor
gfxDeclare
ParameterTypeDescription
name
superclass
declarations