com.github.gwtd3.api.svg

Class Area

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.svg.PathDataGenerator

com.github.gwtd3.api.svg.Area

All Implemented Interfaces:

IsFunction

public class Area
extends PathDataGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Area.InterpolationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Area()

Method Summary

Methods

Modifier and Type	Method and Description
<T> String	apply(T data) Generate a piecewise linear area, as in an area chart.
<T> String	apply(T data, int index) Generate a piecewise linear area, as in an area chart.
Line	defined(DatumFunction<Boolean> callback) FIXME: D3 bug ??? Does not seem to work...
Area.InterpolationMode	interpolate() Returns the current interpolation mode.
Area	interpolate(Area.InterpolationMode i) Set the current interpolation mode.
Area	x(DatumFunction<Double> callback) Set the function used to compute x coordinates of points generated by this area generator.
Area	x(double d) Set the x coordinates of points generated by this generator.
Area	x0(DatumFunction<Double> callback)
Area	x0(double d) Set the x0 coordinates of points generated by this generator.
Area	x1(DatumFunction<Double> callback)
Area	x1(double d) Set the x1 coordinates of points generated by this generator.
Area	y(DatumFunction<Double> callback) See x(DatumFunction).
Area	y(double d) Set the y coordinates of points generated by this generator.
Area	y0(DatumFunction<Double> callback) See y(DatumFunction).
Area	y0(double d) Set the y0 coordinates of points generated by this generator.
Area	y1(DatumFunction<Double> callback) See y(DatumFunction).
Area	y1(double d) Set the y1 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, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Area

protected Area()

Method Detail

interpolate

public final Area.InterpolationMode interpolate()

Returns the current interpolation mode.

Returns:

the current interpolation mode.

interpolate

public final Area interpolate(Area.InterpolationMode i)

Set the current interpolation mode.

Parameters:

i - the interpolation mode

Returns:

the current area

x

public final Area x(DatumFunction<Double> callback)

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

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

Parameters:

datumFunction -

Returns:

x

public final Area x(double d)

Set the x coordinates of points generated by this generator.

Parameters:

d -

Returns:

x0

public final Area x0(double d)

Set the x0 coordinates of points generated by this generator.

Parameters:

d -

Returns:

x0

public final Area x0(DatumFunction<Double> callback)

Parameters:

callback -

Returns:

See Also:

x(DatumFunction).

x1

public final Area x1(double d)

Set the x1 coordinates of points generated by this generator.

Parameters:

d -

Returns:

x1

public final Area x1(DatumFunction<Double> callback)

Parameters:

callback -

Returns:

See Also:

x(DatumFunction).

y

public final Area y(double d)

Set the y coordinates of points generated by this generator.

Parameters:

d -

Returns:

y0

public final Area y0(double d)

Set the y0 coordinates of points generated by this generator.

Parameters:

d -

Returns:

y1

public final Area y1(double d)

Set the y1 coordinates of points generated by this generator.

Parameters:

d -

Returns:

y

public final Area 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:

the current area

y0

public final Area y0(DatumFunction<Double> callback)

See y(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:

the current area

y1

public final Area y1(DatumFunction<Double> callback)

See y(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:

the current area

defined

public final Line defined(DatumFunction<Boolean> callback)

FIXME: D3 bug ??? Does not seem to work... Sets the function used to controls where the area is defined.

The defined accessor can be used to define where the area 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 -

Returns:

apply

public final <T> String apply(T data)

Generate a piecewise linear area, as in an area 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.

Returns:

apply

public final <T> String apply(T data,
               int index)

Generate a piecewise linear area, as in an area 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.

The index will be passed through to the line's accessor functions.

Parameters:

data -

index -

Returns: