Package net.pricefx.common.apibuilder.chart

Class WaterfallComparisonChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<WaterfallComparisonChart>

WaterfallComparisonChart

All Implemented Interfaces:

Portlet, Portlet

public class WaterfallComparisonChart
extends AbstractChartBuilder<WaterfallComparisonChart>

Builder for a Waterfall Comparison Chart, obtained via ChartBuilder.newWaterfallComparison() rather than instantiated directly. See that factory method for how this chart compares multiple named-column waterfalls side by side 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.newWaterfallComparison()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WaterfallComparisonChart.Aggregation	Builder for the aggregation formula applied to a WaterfallComparisonChart.WaterfallComparisonSeries' ADD and SUBTRACT columns, obtained from WaterfallComparisonChart.WaterfallComparisonSeries.getAggregation() rather than instantiated directly.
static class	WaterfallComparisonChart.WaterfallComparisonOptions	The Options for a WaterfallComparisonChart, obtained from getOptions() rather than instantiated directly.
static class	WaterfallComparisonChart.WaterfallComparisonSeries	A single waterfall of a WaterfallComparisonChart, obtained from addSeries() 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
WaterfallComparisonChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
WaterfallComparisonChart.WaterfallComparisonSeries	addSeries()	Adds a new series to this chart, one waterfall among those being compared.
ChartBuilderResult	build()	Finishes this chart's definition.
WaterfallComparisonChart.WaterfallComparisonOptions	getOptions()	Returns this chart's Options builder.

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

WaterfallComparisonChart

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

Method Details

addSeries

public WaterfallComparisonChart.WaterfallComparisonSeries addSeries()

Adds a new series to this chart, one waterfall among those being compared.

Returns:

a new WaterfallComparisonChart.WaterfallComparisonSeries for this chart. Never null.

getOptions

public WaterfallComparisonChart.WaterfallComparisonOptions 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<WaterfallComparisonChart>

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.