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

Object » ibm_ilog.diagram.graphlayout.LayoutRunner
dojo.require("ibm_ilog.diagram.graphlayout.LayoutRunner");

This class provides the graph layout API for a Graph object.

Method Summary

  • getLinkLayout() Gets the link layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
  • getNodeLayout() Gets the graph layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
  • isAnimatedLayout() Returns the flags that determines if an animation must be displayed after a graph layout has been performed.
  • isAutoFitOnLayout() Returne the boolean that determines if fitToContents is called after a graph layout is performed.
  • isAutomaticLinkLayout() Returns the flag specifying if the link layout must be executed automatically whenever the graph changes. returns Boolean: True if the link layout will be executed automatically whenever the graph changes. False if the link layout is executed only by calling performGraphLayout explicitly.
  • isAutomaticNodeLayout() Returns the flag specifying if the graph layout must be executed automatically whenever the graph changes.
  • isLinkLayoutActive() Returns true if the link layout is active, or false otherwise.
  • isNodeLayoutActive() Returns true if the graph layout is active, or false otherwise.
  • performGraphLayout(recursive) Executes the graph layout and/or the link layout specified by the setNodeLayout() and setLinkLayout methods.
  • setAnimatedLayout(animated) Determines if an animation must be displayed after a graph layout has been performed.
  • setAutoFitOnLayout(autoFit) Determines if fitToContents is called after a graph layout is performed.
  • setAutomaticLinkLayout(automatic) Determines if the link layout must be executed automatically whenever the graph changes.
  • setAutomaticNodeLayout(automatic) Determines if the graph layout must be executed automatically whenever the graph changes.
  • setLinkLayout(layout) Sets the link layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
  • setLinkLayoutActive(active) Activates or deactivates the link layout specified by setLinkLayout().
  • setNodeLayout(layout) Sets the graph layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
  • setNodeLayoutActive(active) Activates or deactivates the graph layout specified by setNodeLayout().

Event Summary

  • onLayoutAnimate(v) Called on each step of the graph layout animation, if isAnimatedGraphLayout() is true.
  • onLayoutAnimationEnd() Called when the graph layout animation ends, if isAnimatedGraphLayout() is true.
  • onLayoutAnimationStart() Called when the graph layout animation starts, if isAnimatedGraphLayout() is true.

Methods

getLinkLayout
ibm_ilog.graphlayout.GraphLayout: The link layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
Gets the link layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
getNodeLayout
ibm_ilog.graphlayout.GraphLayout: The graph layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
Gets the graph layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
isAnimatedLayout
boolean: True if graph layout is animated, false otherwise.
Returns the flags that determines if an animation must be displayed after a graph layout has been performed.
isAutoFitOnLayout
boolean: True if fitToContents() is automatically called to show all the graph after a graph layout is performed.
Returne the boolean that determines if fitToContents is called after a graph layout is performed.
isAutomaticLinkLayout
Returns the flag specifying if the link layout must be executed automatically whenever the graph changes. returns Boolean: True if the link layout will be executed automatically whenever the graph changes. False if the link layout is executed only by calling performGraphLayout explicitly.
isAutomaticNodeLayout
Boolean True if the graph layout will be executed automatically whenever the graph changes. False if the graph layout is executed only by calling performGraphLayout explicitly.
Returns the flag specifying if the graph layout must be executed automatically whenever the graph changes.
isLinkLayoutActive
boolean: True if the link layout is active, false otherwise.
Returns true if the link layout is active, or false otherwise.
isNodeLayoutActive
boolean: True if the graph layout is active, false otherwise.
Returns true if the graph layout is active, or false otherwise.
performGraphLayout

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.

ParameterTypeDescription
recursivebooleanboolean: If true, the graph layout is executed recursively on all Subgraphs contained in this Graph. If false, the graph layout is executed only on this Graph.
setAnimatedLayout
Determines if an animation must be displayed after a graph layout has been performed.
ParameterTypeDescription
animatedboolean:If true, an animation moves the nodes and reshapes the links from their position/shape before the layout to their position/shape after the layout.
setAutoFitOnLayout
Determines if fitToContents is called after a graph layout is performed.
ParameterTypeDescription
autoFitboolean:If true, fitToContents() is automatically called to show all the graph after a graph layout is performed.
setAutomaticLinkLayout
Determines if the link layout must be executed automatically whenever the graph changes.
ParameterTypeDescription
automaticboolean:If true, the link layout will be executed automatically whenever the graph changes. If false, the link layout must be executed by calling performGraphLayout explicitly.
setAutomaticNodeLayout
Determines if the graph layout must be executed automatically whenever the graph changes.
ParameterTypeDescription
automaticboolean:If true, the graph layout will be executed automatically whenever the graph changes. If false, the graph layout must be executed by calling performGraphLayout explicitly.
setLinkLayout
Sets the link layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
ParameterTypeDescription
layoutibm_ilog.graphlayout.GraphLayoutibm_ilog.graphlayout.GraphLayout: The link layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
setLinkLayoutActive

If the link layout is active, it will be performed when performGraphLayout() is called. For example, you can call setLinkLayoutActive(false) if you want to perform only a graph layout.

ParameterTypeDescription
activeboolean:True to activate the link layout, false to deactivate it.
setNodeLayout
Sets the graph layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
ParameterTypeDescription
layoutibm_ilog.graphlayout.GraphLayoutibm_ilog.graphlayout.GraphLayout: The graph layout algorithm that will be executed on the contents of this graph when performGraphLayout is called.
setNodeLayoutActive

If the graph layout is active, it will be performed when performGraphLayout() is called. For example, you can call setNodeLayoutActive(false) if you want to perform only a link layout.

ParameterTypeDescription
activeboolean:True to activate the graph layout, false to deactivate it.

Events

onLayoutAnimate
Called on each step of the graph layout animation, if isAnimatedGraphLayout() is true.
ParameterTypeDescription
vnumber:A value between 0 and 100 specifying the progress of the animation.
onLayoutAnimationEnd
Called when the graph layout animation ends, if isAnimatedGraphLayout() is true.
onLayoutAnimationStart
Called when the graph layout animation starts, if isAnimatedGraphLayout() is true.