Methods
Overrides ibm_ilog.diagram.widget._Diagram
The entity being annotated
Parameter | Type | Description |
---|
ge | ibm_ilog.diagram.GraphElement | The entity being annotated |
kwArgs | | |
Overrides ibm_ilog.diagram.widget._Diagram
this method is called after any graph element is disposed
Parameter | Type | Description |
---|
graphElement | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
itemOrGraphElement | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
iid | | |
assignments | | |
beforeGraphElementDispose Overrides ibm_ilog.diagram.widget._Diagram
this method is called before any graph element is disposed
Parameter | Type | Description |
---|
graphElement | | |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Centers the viewport on an object of the graph. Does not change the zoom level.
Parameter | Type | Description |
---|
nodeOrLink | Node|Link | |
options | {animate} | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
focus | | |
newFocus | | |
possibleCursors | | |
mustchangeAdornersFocus | | |
Overrides ibm_ilog.diagram.widget._Diagram
Connects the specified nodes.
This method creates a ibm_ilog.diagram.Link instance invoking the createLink() method
and connects its extremities to the specified nodes. Optionally, one may specify
the linksStore item associated with this link.
Parameter | Type | Description |
---|
start | ibm_ilog.diagram.Node | : the link start node. |
end | ibm_ilog.diagram.Node | ibm_ilog.diagram.Node: the link end node. |
template | String||Object | Object or String : the template to use. Optional. |
linkItem | dojo.data.Item | dojo.data.Item: the data item corresponding to this link, if any. Optional. |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
clazz | | |
templates | | |
rootId | | |
Overrides ibm_ilog.diagram.widget._Diagram
a ibm_ilog.diagram.Link instance.
This method only creates the Link instance and does not connect the nodes. Caller may invoke
the Diagram.connectNodes() method instead, which invokes this method and perfom the connection.
Parameter | Type | Description |
---|
start | ibm_ilog.diagram.Node | the link start node. |
end | ibm_ilog.diagram.Node | the link end node. |
template | Object | or String
the template to use. Optional. |
linkItem | dojo.data.Item | the data item corresponding to this link, if any. Optional.
nodeType: Function
The type of the node instance. Optional. |
linkType | Function | Optional. |
Overrides ibm_ilog.diagram.widget._Diagram
An optional function that creates the ibm_ilog.diagram.Link instance for a given data
item.
The function receives the following parameters:
linkItem : the link data item, if any.
startNode: the link start node.
endNode: the link end node.
templateObj : the template object.
graph : the parent graph of the link.
diagram : a reference to this diagram widget.
Overrides ibm_ilog.diagram.widget._Diagram
A ibm_ilog.diagram.Node instance.
Creates a Node that represents the specified data item.
Parameter | Type | Description |
---|
template | Object | or String
The template to use for this node. Optional. |
item | dojo.data.api.Item | a data item associated with this node. Optional. |
onGraph | ibm_ilog.diagram.Graph | The parent graph of the node. If null, the top-level graph is used. Optional. |
nodeType | Function | Optional. The type of the node instance. Optional. |
Overrides ibm_ilog.diagram.widget._Diagram
An optional function that creates the ibm_ilog.diagram.Node instance for a given data
item.
The function receives the following parameters:
item : the data item associated with this node.
templateObj : A template object.
graph : the target graph to create the node from.
diagram : a reference to this diagram widget.
Overrides ibm_ilog.diagram.widget._Diagram
A ibm_ilog.diagram.Subgraph instance.
Creates a Subgraph that represents the specified data item.
Parameter | Type | Description |
---|
template | Object | or String The template to use for this subgraph. Optional. |
item | dojo.data.api.Item | a data item associated with this subgraph. Optional. |
onGraph | ibm_ilog.diagram.Graph | The parent graph of the subgraph. If null, the top-level graph is used. Optional. |
nodeType | Function | Optional. The type of the node instance. Optional. |
Overrides ibm_ilog.diagram.widget._Diagram
An optional function that creates the ibm_ilog.diagram.Subgraph instance for a given data
item.
The function receives the following parameters:
item : associated with this node.
templateObj : the template object.
graph : the target graph to create the subgraph from.
diagram : a reference to this diagram widget.
Overrides ibm_ilog.diagram.widget._Diagram
This method creates an instance of the specified type and populates it with the specified template.
If the template defines bindings to the shape or the data item (if any), bindings are resolved.
Parameter | Type | Description |
---|
shapeType | Function | The type of the instance. |
template | String||Object | Optional. a template defining the shape contents. If no template is specified, the default Subgraph template will be used. Optional. |
onGraph | ibm_ilog.diagram.Graph | Optional. the parent graph. Optional.
store : dojo.data.api.Read
a data store. Optional. |
style | Object | Optional. |
store | dojo.data.api.Read | Optional. |
item | Object | Optional. dojo.data.api.Item: a data item associated with this shape. Optional. |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
a | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
enable | | |
enableMarqueePartialSelection Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
b | boolean | |
Overrides ibm_ilog.diagram.widget._Diagram
TODO TBD. Probably to be renamed also
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
margin | | |
zoomOutOnly | | |
Overrides ibm_ilog.diagram.widget._Diagram
A dojox.collections.ArrayList with the annotations created for the graph element.
note:
Creates an empty list if none is registered yet.
Parameter | Type | Description |
---|
ge | | |
Overrides ibm_ilog.diagram.widget._Diagram
Returns the data item, if any, associated with the specified node or link.
Parameter | Type | Description |
---|
nodeOrLink | ibm_ilog.diagram.Node | || ibm_ilog.diagram.Link || ibm_ilog.diagram.Subgraph:
the node, link or subgraph instance. |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
An ibm_ilog.diagram.Graph instance.
Returns the ibm_ilog.diagram.Graph instance that displays the graph.
getGraphElementFromDataItem Overrides ibm_ilog.diagram.widget._Diagram
Gets the GFX object, for the given Data Item.
Parameter | Type | Description |
---|
item | | |
getGraphToClientTransform Overrides ibm_ilog.diagram.widget._Diagram
Returns dojox.gfx.matrix.Matrix2D: A dojox.gfx.matrix.Matrix2D instance.
Returns the matrix used to transform coordinates of objects contained
in this diagram's graph (returned by <code>getGraph()</code>) to coordinates
relative to the client browser's page.
getGraphToDiagramTransform Overrides ibm_ilog.diagram.widget._Diagram
Returns dojox.gfx.matrix.Matrix2D: A dojox.gfx.matrix.Matrix2D instance.
Returns the matrix used to transform coordinates of objects contained
in this diagram's graph (returned by <code>getGraph()</code>) to coordinates
relative to this Diagram object.
Overrides ibm_ilog.diagram.widget._Diagram
A dojox.gfx.matrix.Matrix2D instance that represents the current graph transform.
Returns the graph transform.
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
id | | |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Returns the current link adorners focus.
Overrides ibm_ilog.diagram.widget._Diagram
Returns the current node adorners focus.
Overrides ibm_ilog.diagram.widget._Diagram
Returns Object: An object with x, y, width and height properties.
This method computes the bounding rectangle of a node contained in this Diagram widget.
The returned rectangle is either relative to the whole browser page (if inClient is true or omitted),
or relative to the bounds of the Diagram widget (if inClient is false).
Parameter | Type | Description |
---|
node | ibm_ilog.diagram.Node | A Node of the Graph displayed in this Diagram. |
inClient | Boolean | If true (the default), the returned rectangle is relative to the whole browser page.
If false, the returned rectangle is relative to the bounds of the Diagram widget. |
Overrides ibm_ilog.diagram.widget._Diagram
Returns the parent widget of this widget, assuming the parent
specifies isContainer
Overrides ibm_ilog.diagram.widget._Diagram
Return the selection object
Overrides ibm_ilog.diagram.widget._Diagram
A dojox.gfx.Surface instance.
Returns the dojox.gfx.Surface object displaying the graph.
Overrides ibm_ilog.diagram.widget._Diagram
Gets the Viewport instance.
Overrides ibm_ilog.diagram.widget._Diagram
Hides the dijit master tooltip, if currently in use by the Diagram.
Returns whether the initialization process is done.
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
This function is an optional callback to configure how the MoveInteractor tests movability of elements
function(graphElement) {
// summary:
// Return true if the given graph element is allowed to move
// graphElement:
// The graph element to test.
}
Overrides ibm_ilog.diagram.widget._Diagram
an optional function that computes the link template dynamically based on the item.
The function receives the following parameters:
linkItem : the link data item, if any.
startNode: the link start node.
endNode: the link end node.
diagram : a reference to this diagram widget.
Overrides ibm_ilog.diagram.widget._Diagram
loads the data stores and creates the diagram.
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
This function is an optional callback to configure how the MoveInteractor applies the movement deltas on entities.
function(graphElement,originalTransform,delta) {
// summary:
// Concrete the movement to a graph element.
// graphElement:
// The graph element to move.
// originalTransform:
// The matrix representing the location from which the delta is computed.
// delta:
// The ammount to translate the entity from its original location.
},
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
graphElement | | |
point | | |
margin | | |
outOfBounds | | |
Overrides ibm_ilog.diagram.widget._Diagram
an optional function that computes the node template based on the item.
The function receives the following parameters:
item : the data item to create node from
diagram : a reference to this diagram widget.
Overrides ibm_ilog.diagram.widget._Diagram
If a non-null graph layout has been specified by calling setNodeLayout(),
and if the graph layout is active (that is, unless setNodeLayoutActive(false) has been called),
then the graph layout algorithm is performed on the contents of this graph.
Then, if a non-null link layout has been specified by calling setLinkLayout(),
and if the link layout is active (that is, unless setLinkLayoutActive(false) has been called),
then the link layout algorithm is performed on the contents of this graph.
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Hook executed just after Diagram postCreate. Used by DiagramEditor subclass.
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
annotation | | |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
info | | |
Overrides ibm_ilog.diagram.widget._Diagram
Returns the link template to represent the specified relationship.
Parameter | Type | Description |
---|
linkItem | dojo.data.Item | dojo.data.Item: the data item corresponding to this link, if any. |
start | ibm_ilog.diagram.Node | : the link start node. |
end | ibm_ilog.diagram.Node | ibm_ilog.diagram.Node: the link end node. |
Overrides ibm_ilog.diagram.widget._Diagram
Returns the template to represent the specified node item.
Parameter | Type | Description |
---|
item | dojo.data.Item | dojo.data.Item: the node data item. |
Overrides ibm_ilog.diagram.widget._Diagram
Returns the template to represent the specified subgraph item.
Parameter | Type | Description |
---|
item | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
Overrides ibm_ilog.diagram.widget._Diagram
Sets the link adorners focus on a graph element. Used by the adorners focus interactor;
Parameter | Type | Description |
---|
ge | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
b | int | |
Overrides ibm_ilog.diagram.widget._Diagram
Sets the node adorners focus on a graph element. Used by the adorners focus interactor;
Parameter | Type | Description |
---|
ge | | |
Overrides ibm_ilog.diagram.widget._Diagram
Opens a tooltip for a graph element. The content is get using the
getTooltipContentFunction function. Optionally,
the content can be overriden using the 'innerHTML' argument.
Parameter | Type | Description |
---|
ge | ibm_ilog.diagram.GraphElement | the graph element |
innerHTML | String | Optional. optional argument that overrides the content of the tooltip. |
dontHideOnChange | boolean | option to disable auto-hiding of the tooltip then the element reports changes |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
an optional function that computes the subgraph template based on the item.
The function receives the following parameters:
item : the data item to create subgraph from.
diagram : a reference to this diagram widget.
Overrides ibm_ilog.diagram.widget._Diagram
Export the graph as an SVG string. This features requires Dojo 1.4.x or greater.
Parameter | Type | Description |
---|
onComplete | Function | The callback that receives the resulting SVG. |
onError | Function | The function called when the generation fails. |
all | Boolean | Indicates whether the whole graph should be visible in the resulting svg. If false, only the visible area is displayed. The default value is false. |
Overrides ibm_ilog.diagram.widget._Diagram
Overrides ibm_ilog.diagram.widget._Diagram
Makes the bounds of a graph object visible, givin it an extra air between the
area and the borders of the viewport if possible. The view may be zoomed out
if required, but it is never zoomed in.
Parameter | Type | Description |
---|
graphic | Node|Link|Subgraph | The object to make visible |
options | {expandCurrent:false,airFactor} | Viewport options kwArgs |
Registers a callback to be executed after the instance has
been initialized, or executes immediately if already initialized.
Parameter | Type | Description |
---|
cb | | |
eb | | |
Events
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
oldValue | | |
newValue | | |
onLinkAdornersFocusChanged Overrides ibm_ilog.diagram.widget._Diagram
event that occurs when the link adorners focus has changed.
Parameter | Type | Description |
---|
oldValue | | |
newValue | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
l | | |
e | | |
Overrides ibm_ilog.diagram.widget._Diagram
Invoked when the specified link has been created.
Parameter | Type | Description |
---|
link | ibm_ilog.diagram.Link | ibm_ilog.diagram.Link: the new link instance. |
start | ibm_ilog.diagram.Node | ibm_ilog.diagram.Node: the link start node, if any. |
end | ibm_ilog.diagram.Node | ibm_ilog.diagram.Node: the link end node, if any. |
diagram | ibm_ilog.diagram.widget.Diagram | ibm_ilog.diagram.widget.Diagram: the diagram instance that fired the event. |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Parameter | Type | Description |
---|
error | | |
request | | |
Overrides ibm_ilog.diagram.widget._Diagram
Invoked when the diagram has loaded the data.
onNodeAdornersFocusChanged Overrides ibm_ilog.diagram.widget._Diagram
event that occurs when the adorners focus has changed.
Parameter | Type | Description |
---|
oldValue | | |
newValue | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
n | | |
e | | |
Overrides ibm_ilog.diagram.widget._Diagram
Invoked when the specified node has been created.
Parameter | Type | Description |
---|
node | ibm_ilog.diagram.Node: | the new node instance. |
diagram | ibm_ilog.diagram.widget.Diagram: | the diagram instance that fired the event. |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Parameter | Type | Description |
---|
error | | |
request | | |
Overrides ibm_ilog.diagram.widget._Diagram
An extension point invoked when a property has changed.
Parameter | Type | Description |
---|
name | String | String: the property name. |
oldValue | Object | Object: the old property value. |
newValue | Object | Object: the new property value. |
Parameter | Type | Description |
---|
error | | |
request | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
s | | |
e | | |
Overrides ibm_ilog.diagram.widget._Diagram
Invoked when the specified subgraph object has been created and initialized.
The default implementation does nothing.
Parameter | Type | Description |
---|
subgraph | ibm_ilog.diagram.Subgraph | ibm_ilog.diagram.Subgraph: the new subgraph instance. |
diagram | ibm_ilog.diagram.widget.Diagram | ibm_ilog.diagram.widget.Diagram: the diagram instance that fired the event. |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |
Overrides ibm_ilog.diagram.widget._Diagram
Parameter | Type | Description |
---|
ge | | |
event | | |