Package net.pricefx.common.apibuilder.chart

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

Object

ObjectIdentity

BacklinkBuilder<C>

AbstractChartSeries<C,S>

ChartSeries.Basic<C,S>

EmbeddedBoxplot<C,S>

Direct Known Subclasses:

BarLineChart.BarLineSeries, TimeSeriesChart.TimeSeriesSeries

Enclosing class:

ChartSeries

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

Re-exposes AbstractChartSeries.setType(SeriesType), AbstractChartSeries.setShowBoxplot(Boolean), AbstractChartSeries.setBoxplotAxis(), and AbstractChartSeries.setWhisker(WhiskerType) as public; the tier extended by a concrete series type that supports an embedded box plot overlay, for example BarLineChart.BarLineSeries or TimeSeriesChart.TimeSeriesSeries.

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

Method Summary

Modifier and Type	Method	Description
final NonAggrFieldAxis<S>	setBoxplotAxis()	Returns the builder for the field supplying the embedded box plot overlay's statistical distribution (minimum, quartiles, maximum), analogous to BoxplotChart.BoxplotSeries.setAxisY(String) on the standalone BoxplotChart.
final S	setShowBoxplot(Boolean showBoxplot)	Shows or hides an embedded box plot overlay on this series, distinct from the standalone BoxplotChart.
final S	setType(SeriesType seriesType)	Sets how this series itself is rendered, independently of the chart's overall type, for example rendering one series of a Bar & Line Chart as a line while its other series render as bars.
final S	setWhisker(WhiskerType whiskerType)	Sets the whisker calculation method for this series' embedded box plot overlay.

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

EmbeddedBoxplot

public EmbeddedBoxplot(C backLink,
 String instanceId)

Method Details

setType

public final S setType(SeriesType seriesType)

Description copied from class: AbstractChartSeries

Sets how this series itself is rendered, independently of the chart's overall type, for example rendering one series of a Bar & Line Chart as a line while its other series render as bars. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports mixing rendering types across series.

Overrides:

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

Parameters:

seriesType - the rendering type to use for this series

Returns:

this series, for chaining further configuration

setShowBoxplot

public final S setShowBoxplot(Boolean showBoxplot)

Description copied from class: AbstractChartSeries

Shows or hides an embedded box plot overlay on this series, distinct from the standalone BoxplotChart. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports an embedded boxplot overlay, for example TimeSeriesChart.TimeSeriesSeries or BarLineChart.BarLineSeries.

Overrides:

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

Parameters:

showBoxplot - true to show the embedded boxplot overlay; false or null to hide it

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.setBoxplotAxis()

setBoxplotAxis

public final NonAggrFieldAxis<S> setBoxplotAxis()

Description copied from class: AbstractChartSeries

Returns the builder for the field supplying the embedded box plot overlay's statistical distribution (minimum, quartiles, maximum), analogous to BoxplotChart.BoxplotSeries.setAxisY(String) on the standalone BoxplotChart. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports an embedded boxplot overlay.

Overrides:

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

Returns:

a new NonAggrFieldAxis builder for the boxplot field. Never null.

See Also:

• AbstractChartSeries.setShowBoxplot(Boolean)

setWhisker

public final S setWhisker(WhiskerType whiskerType)

Description copied from class: AbstractChartSeries

Sets the whisker calculation method for this series' embedded box plot overlay. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports an embedded boxplot overlay.

Overrides:

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

Parameters:

whiskerType - the whisker calculation method to use, for example WhiskerType.MIN_MAX or one of the percentile- or IQR-outlier-based methods

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.setShowBoxplot(Boolean)