Package net.pricefx.common.apibuilder.chart

Class WaterfallChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<WaterfallChart>

WaterfallChart

All Implemented Interfaces:

Portlet, Portlet

public class WaterfallChart
extends AbstractChartBuilder<WaterfallChart>

Builder for a Waterfall Chart, obtained via ChartBuilder.newWaterfall() rather than instantiated directly. See that factory method for this chart's single-series, named-column shape (one series, obtained with getSeries() rather than addSeries()) and a Groovy example.

Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.

See Also:

• ChartBuilder.newWaterfall()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WaterfallChart.Aggregation	Builder for the aggregation formula applied to a WaterfallChart.WaterfallSeries' ADD and SUBTRACT columns, obtained from WaterfallChart.WaterfallSeries.getAggregation() rather than instantiated directly.
static class	WaterfallChart.WaterfallOptions	The Options for a WaterfallChart, obtained from getOptions() rather than instantiated directly.
static class	WaterfallChart.WaterfallSeries	The single series of a WaterfallChart, obtained from getSeries() rather than instantiated directly.

Field Summary

Fields inherited from class AbstractChartBuilder

dragDropEnabled, layout, messages, queryBuilderState, resizingEnabled

Fields inherited from class AbstractBuilder

METHOD_BUILD

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Fields inherited from interface Portlet

UNIT_GRID, UNIT_PX

Constructor Summary

Constructors

Constructor	Description
WaterfallChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
ChartBuilderResult	build()	Finishes this chart's definition.
WaterfallChart.WaterfallOptions	getOptions()	Returns this chart's Options builder.
WaterfallChart.WaterfallSeries	getSeries()	Returns this chart's single series.

Methods inherited from class AbstractChartBuilder

addAuxLine, addInvocation, build, fromQueryBuilderState, getDictionary, getThis, invokeAddSeries, invokeGetOptions, invokeGetSeries, layout, onCellClick, onRowClick, value, withDragDrop, withError, withHeight, withHeight, withInfo, withLabelOverride, withLayout, withLayout, withLayout, withResizing, withTab, withWarning, withWidth, withWidth

Methods inherited from class ObjectIdentity

addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WaterfallChart

public WaterfallChart(IdGenerator idGenerator,
 Invocations<MethodInvocation> invocations)

Method Details

getSeries

public WaterfallChart.WaterfallSeries getSeries()

Returns this chart's single series. Unlike other chart types, a Waterfall Chart has exactly one series; this method always returns the same instance rather than adding a new one on each call.

Returns:

this chart's WaterfallChart.WaterfallSeries. Never null.

getOptions

public WaterfallChart.WaterfallOptions getOptions()

Description copied from class: AbstractChartBuilder

Returns this chart's Options builder. Each concrete chart type declares its own Options subclass (for example ScatterChart.ScatterOptions, BarLineChart.BarLineOptions) exposing the settings that apply to that chart type, such as title, subtitle, and axis label and bound overrides; the exact set of available options differs per chart type, which is why this method is declared abstract here rather than implemented once for every chart.

Specified by:

getOptions in class AbstractChartBuilder<WaterfallChart>

Returns:

this chart's type-specific AbstractChartOptions instance. Never null.

build

public ChartBuilderResult build()

Finishes this chart's definition. The returned object is what Dashboard portlets, Quote headers, and other Data Analyzer areas render.

Specified by:

build in class AbstractBuilder

Returns:

the finished chart definition. Never null.