ibm_ilog.graphlayout.ILayoutProvider (version 1.1-SNAPSHOT)
An interface used to specify the layout instance to be used for laying out a given graph.
This is an advanced API. In Dojo Diagrammer, you specify the layout
to use for a specific Subgraph by calling
ibm_diagram.Subgraph.setNodeLayout(layout)
or
ibm_diagram.Subgraph.setLinkLayout(layout)
.
Method Summary
- getGraphLayout(graphModel) Returns the layout instance to be used for laying out 'graphModel'.
Methods
Returns the layout instance to be used for laying out
graphModel
.
The layout instance that is returned must be attached to
graphModel
via the method
ibm_ilog.graphlayout.GraphLayout.attach()
.
Note that this method must return a different layout instance for each subgraph. The same layout instance should not be returned for two different subgraphs of the same graph. Also, the layout instance returned for a subgraph should not be the same as the one returned for the topmost graph.
This method is called during the recursive layout of a nested graph
. If the method returns null
, this means that no layout
is needed for graphModel
.
Parameter | Type | Description |
---|---|---|
graphModel | ibm_ilog.graphlayout.AbstractGraphLayoutModel | The graph model (eventually the graph model that encapsulates the topmost grapher). |