com.github.gwtd3.api.layout

Class Force.Node<T>

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.layout.Force.Node<T>

Enclosing class:

Force<T>

public static class Force.Node<T>
extends com.google.gwt.core.client.JavaScriptObject

A node in d3j's force layout, see d3 docs on node. The node class is used in Force, The class provides accessors for the nodes key attributes, its position, previous position, fixed (immovable) and weight (number of links).

These attributes do not need to be set before passing the nodes to the layout; if they are not set, suitable defaults will be initialized by the layout when start is called. However, be aware that if you are storing other data on your nodes, your data attributes should not conflict with the above properties used by the layout.

Author:

Vassilis Virvilis, Anthony Schiochet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Node()

Method Summary

Modifier and Type	Method and Description
T	datum()
void	datum(T datum)
boolean	fixed()
void	fixed(boolean fixed) sets a boolean indicating whether node position is locked.
int	index()
double	px()
void	px(double px) sets the previous the x coordinate
double	py()
void	py(double py) sets the previous y coordinate
int	weight()
double	x()
void	x(double x) sets the x coordinate
double	y()
void	y(double y) sets the y coordinate

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

Node

protected Node()

Method Detail

index

public final int index()

Returns:

the zero-based index of the node within the nodes array.

x

public final double x()

Returns:

the computed x-coordinate of the node position.

x

public final void x(double x)

sets the x coordinate

y

public final double y()

Returns:

the computed y-coordinate of the node position.

y

public final void y(double y)

sets the y coordinate

px

public final double px()

Returns:

the previous x coordinate

px

public final void px(double px)

sets the previous the x coordinate

py

public final double py()

Returns:

the previous y coordinate

py

public final void py(double py)

sets the previous y coordinate

fixed

public final boolean fixed()

Returns:

a boolean indicating whether node position is locked.

fixed

public final void fixed(boolean fixed)

sets a boolean indicating whether node position is locked.

weight

public final int weight()

Returns:

the node weight; the number of associated links.

datum

public final T datum()

Returns:

the user datum of this node

datum

public final void datum(T datum)

Parameters:

datum - the user datum of this node