Search this API

Package y.layout.grouping

Provides classes and interfaces that are necessary for layout calculation of graph hierarchies (a.k.a. hierarchically organized graphs).

See:
          Description

Interface Summary
GroupBoundsCalculator Implementations of this interface are responsible for calculating the bounds of a group node during a layout process.
GroupingKeys This interface defines data provider keys for those layout algorithms that can handle hierarchically grouped graphs.
 

Class Summary
FixedGroupLayoutStage A layout stage for hierarchically grouped graphs.
Grouping Instances of this class can be used by algorithms to efficiently query the structure of such type of graphs.
GroupNodeHider A layout stage for hierarchically grouped graphs.
InsetsGroupBoundsCalculator Convenience implementation which allows for custom insets for each group node.
IsolatedGroupComponentLayouter A special component layouter that handles hierarchically grouped graphs in a special way.
MinimumSizeGroupBoundsCalculator This subclass of InsetsGroupBoundsCalculator does not only allow custom insets for each group node, but also makes sure to keep provided minimum sizes registered for each node that are provided through a DataProvider which must be registered with the graph prior to the invocation of the layout algorithm.
ParentEdgeAugmentationStage This class can be used as a decorating stage for layout algorithms that cannot handle node groups.
RecursiveGroupLayouter Recursively traverses a hierarchically organized graph in a bottom-up fashion and applies the given layout algorithm (i.e. the core layouter) to the contents of each group node.
 

Package y.layout.grouping Description

Provides classes and interfaces that are necessary for layout calculation of graph hierarchies (a.k.a. hierarchically organized graphs).

Interface GroupingKeys defines look-up keys that are used to register data providers with hierarchically organized graphs. These data providers are expected to hold the grouping information, e.g., the parent-child relation of nodes, in a way that is understood by layout algorithms.
(Layout algorithms that are able to handle hierarchically organized graphs rely on the grouping information to be properly bound to a given input graph.)

Related Documentation

See the yFiles Developer's Guide section on Automatic Layout in the Graph Hierarchies chapter for a brief discussion of layout preparation of hierarchically organized graphs.


© Copyright 2000-2013,
yWorks GmbH.
All rights reserved.