Package net.pricefx.common.apibuilder.chart

Class WaterfallChart.WaterfallSeries

Object

ObjectIdentity

BacklinkBuilder<WaterfallChart>

AbstractChartSeries<WaterfallChart,WaterfallChart.WaterfallSeries>

ChartSeries.Basic<WaterfallChart,WaterfallChart.WaterfallSeries>

WaterfallSeries

Enclosing class:

WaterfallChart

public static class WaterfallChart.WaterfallSeries
extends ChartSeries.Basic<WaterfallChart,WaterfallChart.WaterfallSeries>

The single series of a WaterfallChart, obtained from WaterfallChart.getSeries() rather than instantiated directly. Unlike other chart types, this series is composed of named columns added with addWaterfallColumn(WaterfallColumnType, String, String), rather than a single aggregated measure.

Field Summary

Fields inherited from class AbstractChartSeries

aggregationsFilter, customersFilter, filters, productsFilter

Fields inherited from class BacklinkBuilder

METHOD_BACK

Fields inherited from class ObjectIdentity

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

Constructor Summary

Constructors

Constructor	Description
WaterfallSeries(WaterfallChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
WaterfallChart.WaterfallSeries	addWaterfallColumn(WaterfallColumnType columnType, String source, String label)	Adds a column to this series' waterfall, either an ADD or SUBTRACT step sourced from a field, or a RESULT step showing the running total.
WaterfallChart.Aggregation	getAggregation()	Returns the builder for the aggregation formula applied to this series' ADD and SUBTRACT columns, for example AggrFieldAxis.withPercent() or AggrFieldAxis.withTotal().

Methods inherited from class ChartSeries.Basic

setHideDataLabels

Methods inherited from class AbstractChartSeries

addAggregationsFilter, addCustomersFilter, addDimFilter, addFilters, addFilters, addProductsFilter, getFilters, getThis, invokeAddAdditionalMeasure, protectedSetAggrFieldAxisX, protectedSetAggrFieldAxisY, protectedSetAxisX, protectedSetAxisY, protectedSetNonAggrFieldAxisX, protectedSetNonAggrFieldAxisY, setAggregationBy, setBandBy, setBoxplotAxis, setComparisonDim, setCurrency, setDatamart, setFormula, setGeneratedQueryDto, setHideOther, setLabel, setLimitTo, setShowBandByLegend, setShowBoxplot, setType, setWhisker, withSortByAxisX, withSortByAxisY, withTrendLine

Methods inherited from class BacklinkBuilder

back, getParent

Methods inherited from class ObjectIdentity

addInvocation, addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

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

Constructor Details

WaterfallSeries

public WaterfallSeries(WaterfallChart backLink,
 String instanceId)

Method Details

getAggregation

public WaterfallChart.Aggregation getAggregation()

Returns the builder for the aggregation formula applied to this series' ADD and SUBTRACT columns, for example AggrFieldAxis.withPercent() or AggrFieldAxis.withTotal().

Returns:

this series' WaterfallChart.Aggregation builder. Never null.

addWaterfallColumn

public WaterfallChart.WaterfallSeries addWaterfallColumn(WaterfallColumnType columnType,
 String source,
 String label)

Adds a column to this series' waterfall, either an ADD or SUBTRACT step sourced from a field, or a RESULT step showing the running total.

Parameters:

columnType - whether this column adds to, subtracts from, or shows the running total of the waterfall

source - the technical name of the field this column's value is sourced from; null for a RESULT column

label - an explicit display label for this column, overriding the source field's own label; null to use that default, or required if columnType is RESULT

Returns:

this series, for chaining further configuration