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.graphlayout.ILayoutProvider

Object » ibm_ilog.graphlayout.ILayoutProvider
dojo.require("ibm_ilog.graphlayout.ILayoutProvider");

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

getGraphLayout
The layout instance to be used for 'graphModel', or 'null' if no layout is need for 'graphModel'.

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.

ParameterTypeDescription
graphModelibm_ilog.graphlayout.AbstractGraphLayoutModelThe graph model (eventually the graph model that encapsulates the topmost grapher).