com.github.gwtd3.api.svg

Class Diagonal

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.svg.PathDataGenerator

com.github.gwtd3.api.svg.Diagonal

All Implemented Interfaces:

IsFunction

public class Diagonal
extends PathDataGenerator

Diagonal generator. Assumes the input data is an object with named attributes matching the accessors source() and target(). The returned function generates the path data for a cubic Bezier connecting the source and target points; the tangents are specified to produce smooth fan-in and fan-out when connecting nodes, as in a node-link diagram. Diagonals default to Cartesian orientations, but can be used in radial and other orientations using projection(DatumFunction).

Author:

Evan Shi

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Diagonal()

Method Summary

Methods

Modifier and Type	Method and Description
DatumFunction<?>	projection() The projection converts the starting or ending point returned by the source and target accessors source() and target(), returning a two-element array of numbers.
Diagonal	projection(DatumFunction<?> df) The projection converts the starting or ending point returned by the source and target accessors source() and target(), returning a two-element array of numbers.
com.google.gwt.core.client.JavaScriptObject	source() Returns the current source accessor, which can either be a function or constant object.
Diagonal	source(Coords source) Sets the source accessor to be constant.
Diagonal	source(DatumFunction<?> df) Sets the source accessor function.
com.google.gwt.core.client.JavaScriptObject	target() Returns the current target accessor, which can either be a function or constant object.
Diagonal	target(Coords target) Sets the target accessor to be constant.
Diagonal	target(DatumFunction<?> df) Sets the target accessor function.

Methods inherited from class com.github.gwtd3.api.svg.PathDataGenerator

generate, generate, generate, generate

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

Diagonal

protected Diagonal()

Method Detail

projection

public final DatumFunction<?> projection()

The projection converts the starting or ending point returned by the source and target accessors source() and target(), returning a two-element array of numbers. The default accessor assumes that the input point is an object with x and y attributes. The default accessor is thus compatible with D3's various Node layouts, including Tree, partition and cluster. For example, to produce a radial diagonal see the d3 API reference The projection is invoked in a similar manner as other value functions in D3. The function is passed two arguments, the current source or target point (derived from the current data, d) and the current index (i).

Returns:

the accessor function registered with the diagonal generator

projection

public final Diagonal projection(DatumFunction<?> df)

The projection converts the starting or ending point returned by the source and target accessors source() and target(), returning a two-element array of numbers. The default accessor assumes that the input point is an object with x and y attributes. The default accessor is thus compatible with D3's various Node layouts, including Tree, partition and cluster. For example, to produce a radial diagonal see the d3 API reference The projection is invoked in a similar manner as other value functions in D3. The function is passed two arguments, the current source or target point (derived from the current data, d) and the current index (i).

Parameters:

a - datum function

Returns:

this diagonal object

source

public final com.google.gwt.core.client.JavaScriptObject source()

Returns the current source accessor, which can either be a function or constant object. The default accessor is a function taking a JSO with a source attribute as described in d3 API reference.

Returns:

the current source accessor

target

public final com.google.gwt.core.client.JavaScriptObject target()

Returns the current target accessor, which can either be a function or constant object. The default accessor is a function taking a JSO with a target attribute as described in d3 API reference.

Returns:

the current target accessor

source

public final Diagonal source(Coords source)

Sets the source accessor to be constant. Per the d3 API reference the source describes a point of x, y coordinates, represented by the Coords class.

Parameters:

a - constant source

Returns:

the diagonal object

target

public final Diagonal target(Coords target)

Sets the target accessor to be constant. Per the d3 API reference the target describes a point of x, y coordinates, represented by the Coords class.

Parameters:

a - constant target

Returns:

the diagonal object

source

public final Diagonal source(DatumFunction<?> df)

Sets the source accessor function. The default accessor function takes in a JSO with a source attribute and returns it. The source-accessor is invoked in the same manner as other value functions in D3. The function is passed two arguments, the current datum (d) and the current index (i). It is also possible to specify the source-accessor as a constant source(Coords) rather than a function.

Parameters:

the - source accessor function

Returns:

the diagonal object

target

public final Diagonal target(DatumFunction<?> df)

Sets the target accessor function. The default accessor function takes in a JSO with a target attribute and returns it. The target-accessor is invoked in the same manner as other value functions in D3. The function is passed two arguments, the current datum (d) and the current index (i). It is also possible to specify the target-accessor as a constant target(Coords) rather than a function.

Parameters:

the - target accessor function

Returns:

the diagonal object