com.github.gwtd3.api.svg

Class Line

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.svg.PathDataGenerator

com.github.gwtd3.api.svg.Line

All Implemented Interfaces:

IsFunction

Direct Known Subclasses:

RadialLine

public class Line
extends PathDataGenerator

Generate a piecewise linear curve, as in a line chart.

Data must be an array-like structure. the type of the array elements depends on the x and y functions. the default x and y functions assumes that each input element is a two-element array of numbers.

Author:

Anthony Schiochet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Line.InterpolationMode Interpolation mode to be specified in interpolate(InterpolationMode).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Line()

Method Summary

Methods

Modifier and Type	Method and Description
Line	defined(DatumFunction<Boolean> callback) Sets the function used to controls where the line is defined.
Line.InterpolationMode	interpolate() Returns the current interpolation mode.
Line	interpolate(Line.InterpolationMode i) Set the current interpolation mode.
double	tension() Returns the current tension
Line	tension(double tension) Sets the Cardinal spline interpolation tension to the specified number in the range [0, 1].
Line	x(DatumFunction<Double> callback) Set the function used to compute x coordinates of points generated by this line generator.
Line	x(double d) Set the x coordinates of points generated by this generator.
Line	y(DatumFunction<Double> callback) See x(DatumFunction).
Line	y(double d) Set the y coordinates of points generated by this generator.

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

Line

protected Line()

Method Detail

interpolate

public final Line.InterpolationMode interpolate()

Returns the current interpolation mode.

Returns:

the current interpolation mode.

interpolate

public final Line interpolate(Line.InterpolationMode i)

Set the current interpolation mode.

Parameters:

i - the interpolation mode

Returns:

the current line

tension

public final double tension()

Returns the current tension

Returns:

the current tension

tension

public final Line tension(double tension)

Sets the Cardinal spline interpolation tension to the specified number in the range [0, 1].

The tension only affects the Cardinal interpolation modes: Line.InterpolationMode.CARDINAL, Line.InterpolationMode.CARDINAL_OPEN and Line.InterpolationMode.CARDINAL_CLOSED.

The default tension is 0.7.

In some sense, this can be interpreted as the length of the tangent; 1 will yield all zero tangents, and 0 yields a Catmull-Rom spline.

Parameters:

tension - the tension in the range [0, 1].

Returns:

the current line

See Also:

live version

x

public final Line x(double d)

Set the x coordinates of points generated by this generator.

Parameters:

d -

Returns:

x

public final Line x(DatumFunction<Double> callback)

Set the function used to compute x coordinates of points generated by this line generator. The function is invoked for each element in the data array passed to the line generator.

The default accessor assumes that each input element is a two-element array of numbers.

Parameters:

datumFunction -

Returns:

y

public final Line y(double d)

Set the y coordinates of points generated by this generator.

Parameters:

d -

Returns:

y

public final Line y(DatumFunction<Double> callback)

See x(DatumFunction).

Note that, like most other graphics libraries, SVG uses the top-left corner as the origin and thus higher values of y are lower on the screen. For visualization we often want the origin in the bottom-left corner instead; one easy way to accomplish this is to invert the range of the y-scale by using range([h, 0]) instead of range([0, h]).

Parameters:

callback -

Returns:

defined

public final Line defined(DatumFunction<Boolean> callback)

Sets the function used to controls where the line is defined.

The defined accessor can be used to define where the line is defined and undefined, which is typically useful in conjunction with missing data; the generated path data will automatically be broken into multiple distinct subpaths, skipping undefined data.

Parameters:

callback - the function to be called for each datum and returning if the point is defined

Returns:

the current line