Area (gwt-d3 API 1.1.1 API)

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
```
Generates path data for a closed piecewise linear curve, or polygon, as in an area chart:

Conceptually, the polygon is formed using two lines: the top line is formed using the x- and y1-accessor functions, and proceeds from left-to-right; the bottom line is added to this line, using the x- and y0-accessor functions, and proceeds from right-to-left. By setting the transform attribute to rotate the path element by 90 degrees, you can also generate vertical areas. By changing the interpolation, you can also generate splines and step functions.
The area generator is designed to work in conjunction with the line generator. For example, when producing an area chart, you might use an area generator with a fill style, and a line generator with a stroke style to emphasize the top edge of the area. Since the area generator is only used to set the d attribute, you can control the appearance of the area using standard SVG styles and attributes, such as fill.
To create streamgraphs (stacked area charts), use the stack layout. This layout sets the y0 attribute for each value in a series, which can be used from the y0- and y1-accessors. Note that each series must have the same number of values per series, and each value must have the same x-coordinate; if you have missing data or inconsistent x-coordinates per series, you must resample and interpolate your data before computing the stacked layout.

Author:

Anthony Schiochet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Area.InterpolationMode

Nested Classes
Modifier and Type	Class and Description
`static class`	`Area.InterpolationMode`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Area()

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 ???
`Area.InterpolationMode`	`interpolate()` Returns the current interpolation mode.
`Area`	`interpolate(Area.InterpolationMode i)` Set the current interpolation mode.
`double`	`tension()` Returns the current tension
`Area`	`tension(double tension)` Sets the Cardinal spline interpolation tension to the specified number in the range [0, 1].
`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, 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:
  - tension
```
public final double tension()
```
    Returns the current tension
    
    Returns:
    the current tension
  - tension
```
public final Area 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: Area.InterpolationMode.CARDINAL, Area.InterpolationMode.CARDINAL_OPEN and 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 area generator
    See Also:
    live version
  - 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:

Class Area

Nested Class Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Area

Method Detail

interpolate

interpolate

x

x

x0

x0

x1

x1

y

y0

y1

y

y0

y1

defined

tension

tension

apply

apply