Packagecom.yworks.yfiles.layout
Classpublic class LayouterKeys
InheritanceLayouterKeys Inheritance YObject Inheritance Object



Public Methods
 MethodDefined By
 Inherited
equals(o:Object):Boolean
YObject
 Inherited
getClass():Class
YObject
 Inherited
hashCode():int
YObject
Public Constants
 ConstantDefined By
  EDGE_ID_DPKEY : Object = y.layout.Layouter.EDGE_ID_DPKEY
[static] The data provider key used to look up a unique Object identifier (consistent with hashCode() and equals() ) for each edge in a graph.
LayouterKeys
  NODE_ID_DPKEY : Object = y.layout.Layouter.NODE_ID_DPKEY
[static] The data provider key used to look up a unique Object identifier (consistent with hashCode() and equals() ) for each node in a graph.
LayouterKeys
  SELECTED_EDGES : Object = y.layout.Layouter.SELECTED_EDGES
[static] The data provider key used to look up the selected state of the edges of the graph to be laid out.
LayouterKeys
  SELECTED_NODES : Object = y.layout.Layouter.SELECTED_NODES
[static] The data provider key used to look up the selected state of the nodes of the graph to be laid out.
LayouterKeys
Constant Detail
EDGE_ID_DPKEYConstant
public static const EDGE_ID_DPKEY:Object = y.layout.Layouter.EDGE_ID_DPKEY

The data provider key used to look up a unique Object identifier (consistent with hashCode() and equals() ) for each edge in a graph. Layout algorithms may use this information to provide consistent layouts for multiple runs. The looked up data provider should provide Object values for the edges of that graph. These should be consistent with the Object.hashCode() and Object.equals() methods.

NODE_ID_DPKEYConstant 
public static const NODE_ID_DPKEY:Object = y.layout.Layouter.NODE_ID_DPKEY

The data provider key used to look up a unique Object identifier (consistent with hashCode() and equals() ) for each node in a graph. Layout algorithms may use this information to provide consistent layouts for multiple runs. The looked up data provider should provide Object values for the nodes of that graph. These should be consistent with the Object.hashCode() and Object.equals() methods.

SELECTED_EDGESConstant 
public static const SELECTED_EDGES:Object = y.layout.Layouter.SELECTED_EDGES

The data provider key used to look up the selected state of the edges of the graph to be laid out. A layout algorithm will try to retrieve a data provider from the graph to be laid out with this key. The looked up data provider should provide boolean values for the edges of that graph. The boolean value should signal whether an edge is to be considered as selected or not.

Note that for several layouters this key is used for restricting the sphere of action, e.g. to route only a subset of the edges by the OrthogonalEdgeRouter. However, it is often more convenient to use a specific data provider key for this purpose, for example if you want to combine two layouters of this kind which have to operate on different subsets of the graph. Thus, these layouters provide a method like setSelectedEdgesDpKey(Object) in the case of the OrthogonalEdgeRouter for using a different data provider.

SELECTED_NODESConstant 
public static const SELECTED_NODES:Object = y.layout.Layouter.SELECTED_NODES

The data provider key used to look up the selected state of the nodes of the graph to be laid out. A layout algorithm will try to retrieve a data provider from the graph to be laid out with this key. The looked up data provider should provide boolean values for the nodes of that graph. The boolean value should signal whether a node is to be considered as selected or not.

Note that for several layouters this key is used for restricting the sphere of action, e.g. to layout the subgraph induced by the set of selected nodes in the SubgraphLayouter. However, it is often more convenient to use a specific data provider key for this purpose, for example if you want to combine two layouters of this kind which have to operate on different subsets of the graph. Thus, these layouters provide a method like setSubgraphNodesDpKey(Object) in the case of the SubgraphLayouter for using a different data provider.