Packagecom.yworks.yfiles.layout.grouping
Classpublic class GroupingKeys
InheritanceGroupingKeys Inheritance YObject Inheritance Object

This interface defines data provider keys for those layout algorithms that can handle hierarchically grouped graphs. These keys define the parent-child relationship of nodes within the hierarchy and tag nodes that act as group nodes.



Public Methods
 MethodDefined By
 Inherited
equals(o:Object):Boolean
YObject
 Inherited
getClass():Class
YObject
 Inherited
hashCode():int
YObject
Public Constants
 ConstantDefined By
  GROUP_DPKEY : Object = y.layout.grouping.GroupingKeys.GROUP_DPKEY
[static] This key is used to distinguish normal nodes from group nodes.
GroupingKeys
  GROUP_NODE_INSETS_DPKEY : Object = y.layout.grouping.GroupingKeys.GROUP_NODE_INSETS_DPKEY.
[static] This key is used to provide insets for group nodes.
GroupingKeys
  MINIMUM_NODE_SIZE_DPKEY : Object = y.layout.grouping.GroupingKeys.MINIMUM_BOUNDS_DPKEY
[static] This key is used to provide minimum sizes for nodes.
GroupingKeys
  NODE_ID_DPKEY : Object = y.layout.grouping.GroupingKeys.NODE_ID_DPKEY
[static] This key is used to register a DataProvider instance with a graph, that associates each node instance with a unique (based on hashCode() and equals()) id.
GroupingKeys
  PARENT_NODE_ID_DPKEY : Object = y.layout.grouping.GroupingKeys.PARENT_NODE_ID_DPKEY
[static] This key is used to actually describe the hierarchy of the nodes in the graph.
GroupingKeys
Constant Detail
GROUP_DPKEYConstant
public static const GROUP_DPKEY:Object = y.layout.grouping.GroupingKeys.GROUP_DPKEY

This key is used to distinguish normal nodes from group nodes. For every node the DataProvider should return true iff the node is a group node (and therefore might have children.

GROUP_NODE_INSETS_DPKEYConstant 
public static const GROUP_NODE_INSETS_DPKEY:Object = y.layout.grouping.GroupingKeys.GROUP_NODE_INSETS_DPKEY.

This key is used to provide insets for group nodes. Insets are used to provide space around the contents of a group node. This space can then be used for labels and other visual decorations. For each group node, a com.yworks.yfiles.geom.YInsets (or a com.yworks.bridge.geom.Insets) object can be provided using a data provider bound to the graph using this key.

See also

MINIMUM_NODE_SIZE_DPKEYConstant 
public static const MINIMUM_NODE_SIZE_DPKEY:Object = y.layout.grouping.GroupingKeys.MINIMUM_BOUNDS_DPKEY

This key is used to provide minimum sizes for nodes. For each node, a com.yworks.yfiles.geom.YDimension object can be provided using a data provider that is bound to the graph with this key.

See also

NODE_ID_DPKEYConstant 
public static const NODE_ID_DPKEY:Object = y.layout.grouping.GroupingKeys.NODE_ID_DPKEY

This key is used to register a DataProvider instance with a graph, that associates each node instance with a unique (based on hashCode() and equals()) id.

PARENT_NODE_ID_DPKEYConstant 
public static const PARENT_NODE_ID_DPKEY:Object = y.layout.grouping.GroupingKeys.PARENT_NODE_ID_DPKEY

This key is used to actually describe the hierarchy of the nodes in the graph. For each node that is not at the top level of the hierarchy, the id of the containing node can be obtained through the data provider associated with this key.