com.github.gwtd3.api.layout

Class HierarchicalLayout

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.layout.HierarchicalLayout

Direct Known Subclasses:

Cluster, Tree

public class HierarchicalLayout
extends com.google.gwt.core.client.JavaScriptObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HierarchicalLayout.Node A node in d3j's tree layout, see d3 docs on node.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HierarchicalLayout()

Method Summary

Methods

Modifier and Type	Method and Description
Array<Link>	links(Array<HierarchicalLayout.Node> n) Given the specified array of nodes, such as those returned by nodes, returns an array of objects representing the from parent to child for each node.
Array<HierarchicalLayout.Node>	nodes(HierarchicalLayout.Node r) Runs the tree layout, returning the array of nodes associated with the specified root node.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HierarchicalLayout

protected HierarchicalLayout()

Method Detail

nodes

public final Array<HierarchicalLayout.Node> nodes(HierarchicalLayout.Node r)

Runs the tree layout, returning the array of nodes associated with the specified root node. The tree layout is part of D3's family of hierarchical layouts. These layouts follow the same basic structure: the input argument to layout is the root node of the hierarchy, and the output return value is an array representing the computed positions of all nodes. Several attributes are populated on each node:

• parent - the parent HierarchicalLayout.Node, or null for the root.
• children - the array of child nodes, or null for leaf nodes.
• depth - the depth of the node, starting at 0 for the root.
• x - the computed x-coordinate of the node position.
• y - the computed y-coordinate of the node position.

Although the layout has a size in x and y, this represents an arbitrary coordinate system; for example, you can treat x as a radius and y as an angle to produce a radial rather than Cartesian layout.

Parameters:

root - of the the tree

Returns:

array of HierarchicalLayout.Node in the tree stemming from root

links

public final Array<Link> links(Array<HierarchicalLayout.Node> n)

Given the specified array of nodes, such as those returned by nodes, returns an array of objects representing the from parent to child for each node. Leaf nodes will not have any links. Each link is an object with two attributes:

• source - the parent node (as described above).
• target - the child node.

This method is useful for retrieving a set of link descriptions suitable for display, often in conjunction with the Diagonal shape generator.

Parameters:

array - of nodes in tree

Returns:

array of Link connecting nodes