Package net.pricefx.common.apibuilder.chart

Class ChartSeries.Aggregation<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>

Object

ObjectIdentity

BacklinkBuilder<C>

AbstractChartSeries<C,S>

ChartSeries.Basic<C,S>

Aggregation<C,S>

Direct Known Subclasses:

BubbleChart.BubbleSeries, ScatterChart.ScatterSeries, TimeSeriesScatterChart.TimeSeriesScatterSeries

Enclosing class:

ChartSeries

public abstract static class ChartSeries.Aggregation<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>
extends ChartSeries.Basic<C,S>

Re-exposes AbstractChartSeries.setAggregationBy(String), AbstractChartSeries.setBandBy(String), and AbstractChartSeries.setShowBandByLegend(Boolean) as public, and adds getBandByOptions(); the tier extended by a concrete series type that supports aggregation-by and band-by grouping, for example ScatterChart.ScatterSeries or BubbleChart.BubbleSeries.

Field Summary

Fields

Modifier and Type	Field	Description
protected BandByOptions<S>	bandByOptions

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
Aggregation(C backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
final BandByOptions<S>	getBandByOptions()	Returns the builder for further configuring the band-by grouping set with setBandBy(String), creating it on first call, for example customizing each band's legend color or restoring a previously saved band selection.
final S	setAggregationBy(String aggregationBy)	Sets the dimension this series' rows are grouped by.
final S	setBandBy(String bandBy)	Sets the dimension this series' points are additionally banded (color-grouped) by, layered on top of AbstractChartSeries.setAggregationBy(String).
final S	setShowBandByLegend(Boolean showBandByLegend)	Shows or hides the legend entries for the bands added with AbstractChartSeries.setBandBy(String).

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, setBoxplotAxis, setComparisonDim, setCurrency, setDatamart, setFormula, setGeneratedQueryDto, setHideOther, setLabel, setLimitTo, 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

Field Details

bandByOptions

protected BandByOptions<S extends ChartSeries.Basic<C,S>> bandByOptions

Constructor Details

Aggregation

public Aggregation(C backLink,
 String instanceId)

Method Details

setAggregationBy

public final S setAggregationBy(String aggregationBy)

Description copied from class: AbstractChartSeries

Sets the dimension this series' rows are grouped by. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports this grouping.

Overrides:

setAggregationBy in class AbstractChartSeries<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>

Parameters:

aggregationBy - the technical name of the dimension field to group by

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.setBandBy(String)

setBandBy

public final S setBandBy(String bandBy)

Description copied from class: AbstractChartSeries

Sets the dimension this series' points are additionally banded (color-grouped) by, layered on top of AbstractChartSeries.setAggregationBy(String). Declared protected here; a concrete series type re-exposes it as public only if that chart type supports banding.

Overrides:

setBandBy in class AbstractChartSeries<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>

Parameters:

bandBy - the technical name of the dimension field to band by

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.setAggregationBy(String)
• AbstractChartSeries.setShowBandByLegend(Boolean)

setShowBandByLegend

public final S setShowBandByLegend(Boolean showBandByLegend)

Description copied from class: AbstractChartSeries

Shows or hides the legend entries for the bands added with AbstractChartSeries.setBandBy(String). Declared protected here; a concrete series type re-exposes it as public only if that chart type supports banding.

Overrides:

setShowBandByLegend in class AbstractChartSeries<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>

Parameters:

showBandByLegend - true to show the band legend; false or null to hide it

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.setBandBy(String)

getBandByOptions

public final BandByOptions<S> getBandByOptions()

Returns the builder for further configuring the band-by grouping set with setBandBy(String), creating it on first call, for example customizing each band's legend color or restoring a previously saved band selection.

Returns:

this series' BandByOptions builder. Never null.

See Also:

• setBandBy(String)