com.zavtech.morpheus.viz.chart

Interface ChartFactory

All Known Implementing Classes:

ChartFactoryProxy, GChartFactory, JFChartFactory

public interface ChartFactory

The factory interface for creating various types of Charts using the Morpheus Charting API

Author:

Xavier Witdouck

This is open source software released under the Apache 2.0 License

Method Summary

Modifier and Type	Method and Description
boolean	isSupported(Chart<?> chart) Returns true if this factory supports the chart type specified
String	javascript(Chart<?>... charts) Returns Javascript to embed in an HTML page which will plot the charts specified.
String	javascript(Iterable<Chart<?>> charts) Returns Javascript to embed in an HTML page which will plot the charts specified.
<X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>>	ofPiePlot(boolean is3d, Consumer<Chart<PiePlot<X,S>>> configurator) Returns a newly created Pie chart and applies it to the configurator provided
<X extends Comparable> Chart<XyPlot<X>>	ofXY(Class<X> domainType, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created XY chart and applies it to the configurator provided
void	show(int columns, Iterable<Chart<?>> charts) Displays the collection of charts in a grid with the number of columns specified
void	show(int columns, Stream<Chart<?>> charts) Displays the collection of charts in a grid with the number of columns specified
default <R extends Comparable,C extends Comparable> Chart<XyPlot<Integer>>	withAcf(com.zavtech.morpheus.frame.DataFrameLeastSquares<R,C> model, int maxLags, double alpha, Consumer<Chart<XyPlot<Integer>>> consumer) Generates a plot of the Autocorrelation function (ACF) given the Least Squares model
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withAreaPlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame, boolean stacked, S domainKey, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created area chart using a column for the domain axis
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withAreaPlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame, boolean stacked, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created area chart using the row keys for the domain axis
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withBarPlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame, boolean stacked, S domainKey, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created Bar Chart using a column to build the domain axis
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withBarPlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame, boolean stacked, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created Bar Chart using the row keys to build the domain axis
default <R,C extends Comparable> Chart<XyPlot<Double>>	withHistPlot(com.zavtech.morpheus.frame.DataFrame<R,C> frame, int binCount, boolean sharedBins, Consumer<Chart<XyPlot<Double>>> configurator) Returns a Chart to plot a histogram based on the column data in the frame provided
default <R,C extends Comparable> Chart<XyPlot<Double>>	withHistPlot(com.zavtech.morpheus.frame.DataFrame<R,C> frame, int binCount, C columnKey, Consumer<Chart<XyPlot<Double>>> configurator) Returns a Histogram Bar Chart of the frequency distribution for a specific column in a DataFrame
default <R,C extends Comparable> Chart<XyPlot<Double>>	withHistPlot(com.zavtech.morpheus.frame.DataFrame<R,C> frame, int binCount, Consumer<Chart<XyPlot<Double>>> configurator) Returns a Histogram Bar Chart of the frequency distribution for a all columns in a DataFrame
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withLinePlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame, S domainKey, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created Line Chart using a column for the domain axis
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withLinePlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created Line Chart using the row keys for the domain axis
default <X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>>	withPiePlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame, boolean is3d, S dataKey, S labelKey, Consumer<Chart<PiePlot<X,S>>> configurator) Returns a newly created Pie Chart using labels from the column identified by labelKey and the values from the column labelled dataKey
default <X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>>	withPiePlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame, boolean is3d, Consumer<Chart<PiePlot<X,S>>> configurator) Returns a newly created Pie Chart using the row keys for labels and the first numeric column for values
default <X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>>	withPiePlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame, boolean is3d, S dataKey, Consumer<Chart<PiePlot<X,S>>> configurator) Returns a newly created Pie Chart using the row keys for labels and the values from the column labelled dataKey
default <R extends Comparable,C extends Comparable> Chart<XyPlot<Double>>	withResidualsVsFitted(com.zavtech.morpheus.frame.DataFrameLeastSquares<R,C> model, Consumer<Chart<XyPlot<Double>>> consumer) Returns a chart that plots regression residuals against the fitted values in a regression
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withScatterPlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame, boolean shapes, S domainKey, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created scatter chart with shapes using a column for the domain axis
default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>>	withScatterPlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame, boolean shapes, Consumer<Chart<XyPlot<X>>> configurator) Returns a newly created scatter chart with shapes using the row keys for the domain axis

Method Detail

isSupported

boolean isSupported(Chart<?> chart)

Returns true if this factory supports the chart type specified

Parameters:

chart - the chart instance

Returns:

true if chart is supported by this factory

show

void show(int columns,
          Iterable<Chart<?>> charts)

Displays the collection of charts in a grid with the number of columns specified

Parameters:

columns - the number of columns for chart grid

charts - the sequence of charts to plot

show

void show(int columns,
          Stream<Chart<?>> charts)

Displays the collection of charts in a grid with the number of columns specified

Parameters:

columns - the number of columns for chart grid

charts - the sequence of charts to plot

javascript

String javascript(Chart<?>... charts)

Returns Javascript to embed in an HTML page which will plot the charts specified. By convention, the user will need to create an html page with div elements which have attributes labelled "chart_N" where N is 0, 1, 2, N. The first chart in the arguments will be plotted in div with id=chart_0, the second will be plotted in the div with id=chart_1 and so on.

Parameters:

charts - the sequence of charts to generate Javascript from

Returns:

the resulting Javascript to embed in an HTML page.

javascript

String javascript(Iterable<Chart<?>> charts)

Returns Javascript to embed in an HTML page which will plot the charts specified. By convention, the user will need to create an html page with div elements which have attributes labelled "chart_N" where N is 0, 1, 2, N. The first chart in the arguments will be plotted in div with id=chart_0, the second will be plotted in the div with id=chart_1 and so on.

Parameters:

charts - the sequence of charts to generate Javascript from

Returns:

the resulting Javascript to embed in an HTML page.

ofXY

<X extends Comparable> Chart<XyPlot<X>> ofXY(Class<X> domainType,
                                             Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created XY chart and applies it to the configurator provided

Type Parameters:

X - the domain key type

Parameters:

configurator - the chart configurator

domainType - the data type for the domain axis

Returns:

the newly created chart

ofPiePlot

<X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>> ofPiePlot(boolean is3d,
                                                                          Consumer<Chart<PiePlot<X,S>>> configurator)

Returns a newly created Pie chart and applies it to the configurator provided

Type Parameters:

X - the item key type

Parameters:

is3d - true for a 3d plot

configurator - the chart configurator

Returns:

the newly created chart

withLinePlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withLinePlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame,
                                                                                  Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created Line Chart using the row keys for the domain axis

Parameters:

frame - the DataFrame for the chart

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withLinePlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withLinePlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame,
                                                                                  S domainKey,
                                                                                  Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created Line Chart using a column for the domain axis

Parameters:

frame - the DataFrame for the chart

domainKey - the column key in the frame that defines the domain

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withAreaPlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withAreaPlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame,
                                                                                  boolean stacked,
                                                                                  Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created area chart using the row keys for the domain axis

Parameters:

frame - the DataFrame for the chart

stacked - true to generate a stacked area plot, false for overlapping

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withAreaPlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withAreaPlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame,
                                                                                  boolean stacked,
                                                                                  S domainKey,
                                                                                  Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created area chart using a column for the domain axis

Parameters:

frame - the DataFrame for the chart

stacked - true to generate a stacked area plot, false for overlapping

domainKey - the column key in the frame that defines the domain

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withScatterPlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withScatterPlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame,
                                                                                     boolean shapes,
                                                                                     Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created scatter chart with shapes using the row keys for the domain axis

Parameters:

frame - the DataFrame for the chart

shapes - true for series specific shapes

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withScatterPlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withScatterPlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame,
                                                                                     boolean shapes,
                                                                                     S domainKey,
                                                                                     Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created scatter chart with shapes using a column for the domain axis

Parameters:

frame - the DataFrame for the chart

shapes - true for series specific shapes

domainKey - the column key in the frame that defines the domain

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withBarPlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withBarPlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame,
                                                                                 boolean stacked,
                                                                                 Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created Bar Chart using the row keys to build the domain axis

Parameters:

frame - the DataFrame for the chart

stacked - true to generate a stacked bar plot, false for non-statcked

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withBarPlot

default <X extends Comparable,S extends Comparable> Chart<XyPlot<X>> withBarPlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame,
                                                                                 boolean stacked,
                                                                                 S domainKey,
                                                                                 Consumer<Chart<XyPlot<X>>> configurator)

Returns a newly created Bar Chart using a column to build the domain axis

Parameters:

frame - the DataFrame for the chart

stacked - true to generate a stacked bar plot, false for non-statcked

domainKey - the column key in the frame that defines the domain

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withPiePlot

default <X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>> withPiePlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame,
                                                                                    boolean is3d,
                                                                                    Consumer<Chart<PiePlot<X,S>>> configurator)

Returns a newly created Pie Chart using the row keys for labels and the first numeric column for values

Type Parameters:

X - the frame row axis type

S - the frame column axis type

Parameters:

frame - the DataFrame for the chart

is3d - true for 3D PiePlot

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withPiePlot

default <X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>> withPiePlot(com.zavtech.morpheus.frame.DataFrame<X,S> frame,
                                                                                    boolean is3d,
                                                                                    S dataKey,
                                                                                    Consumer<Chart<PiePlot<X,S>>> configurator)

Returns a newly created Pie Chart using the row keys for labels and the values from the column labelled dataKey

Type Parameters:

X - the frame row axis type

S - the frame column axis type

Parameters:

frame - the DataFrame containing data

is3d - true for 3D PiePlot

dataKey - the column key to use for data values

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withPiePlot

default <X extends Comparable,S extends Comparable> Chart<PiePlot<X,S>> withPiePlot(com.zavtech.morpheus.frame.DataFrame<?,S> frame,
                                                                                    boolean is3d,
                                                                                    S dataKey,
                                                                                    S labelKey,
                                                                                    Consumer<Chart<PiePlot<X,S>>> configurator)

Returns a newly created Pie Chart using labels from the column identified by labelKey and the values from the column labelled dataKey

Type Parameters:

X - the frame row axis type

S - the frame column axis type

Parameters:

frame - the DataFrame containing data

is3d - true for 3D PiePlot

dataKey - the column key to use for data values

labelKey - the column key to use for labels

configurator - the configurator to accept config to the chart

Returns:

the newly created chart

withHistPlot

default <R,C extends Comparable> Chart<XyPlot<Double>> withHistPlot(com.zavtech.morpheus.frame.DataFrame<R,C> frame,
                                                                    int binCount,
                                                                    Consumer<Chart<XyPlot<Double>>> configurator)

Returns a Histogram Bar Chart of the frequency distribution for a all columns in a DataFrame

Type Parameters:

C - the series key type for frame

Parameters:

frame - the data from which to generate a histogram for each column

binCount - the number of bins to include in the histogram

configurator - the optional consumer to configure the chart

Returns:

the newly created chart

withHistPlot

default <R,C extends Comparable> Chart<XyPlot<Double>> withHistPlot(com.zavtech.morpheus.frame.DataFrame<R,C> frame,
                                                                    int binCount,
                                                                    boolean sharedBins,
                                                                    Consumer<Chart<XyPlot<Double>>> configurator)

Returns a Chart to plot a histogram based on the column data in the frame provided

Type Parameters:

C - the column key type for frame

Parameters:

frame - the data from which to generate a histogram for each column

binCount - the number of bins to include in the histogram

sharedBins - if true and the frame has multiple columns, each series will share the same width bin rather than being computed independently

configurator - the optional consumer to configure the chart

Returns:

the newly created chart

withHistPlot

default <R,C extends Comparable> Chart<XyPlot<Double>> withHistPlot(com.zavtech.morpheus.frame.DataFrame<R,C> frame,
                                                                    int binCount,
                                                                    C columnKey,
                                                                    Consumer<Chart<XyPlot<Double>>> configurator)

Returns a Histogram Bar Chart of the frequency distribution for a specific column in a DataFrame

Type Parameters:

C - the column key type for frame

Parameters:

frame - the DataFrame of data to generate a histogram for

binCount - the number of bins to include in the histogram

columnKey - the key of the column to generate the histogram for

configurator - the optional consumer to configure the chart

Returns:

the newly created chart

withAcf

default <R extends Comparable,C extends Comparable> Chart<XyPlot<Integer>> withAcf(com.zavtech.morpheus.frame.DataFrameLeastSquares<R,C> model,
                                                                                   int maxLags,
                                                                                   double alpha,
                                                                                   Consumer<Chart<XyPlot<Integer>>> consumer)

Generates a plot of the Autocorrelation function (ACF) given the Least Squares model

Type Parameters:

R - the row key type

C - the column key type

Parameters:

model - the least squares model

maxLags - the max lags for ACF plot

alpha - the significance level for confidence intervals (e.g. 0.05 implies 5% level, or 95% confidence interval)

consumer - the consumer to configure additional options on the chart

Returns:

the resulting chart object

withResidualsVsFitted

default <R extends Comparable,C extends Comparable> Chart<XyPlot<Double>> withResidualsVsFitted(com.zavtech.morpheus.frame.DataFrameLeastSquares<R,C> model,
                                                                                                Consumer<Chart<XyPlot<Double>>> consumer)

Returns a chart that plots regression residuals against the fitted values in a regression

Type Parameters:

R - the row key type

C - the column key type

Parameters:

model - the least squares model

consumer - the user provide chart configurator

Returns:

the resulting chart