Package net.pricefx.common.apibuilder.chart

Class BoxplotChart.BoxplotSeries

Object

ObjectIdentity

BacklinkBuilder<BoxplotChart>

AbstractChartSeries<BoxplotChart,BoxplotChart.BoxplotSeries>

BoxplotSeries

Enclosing class:

BoxplotChart

public static class BoxplotChart.BoxplotSeries
extends AbstractChartSeries<BoxplotChart,BoxplotChart.BoxplotSeries>

A single series of a BoxplotChart, obtained from BoxplotChart.addSeries() rather than instantiated directly.

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
BoxplotSeries(BoxplotChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
BoxplotChart.BoxplotAdditionalMeasure	addAdditionalMeasure()	Adds a further measure to this series beyond its primary Y axis Box Plot expression.
BoxplotChart.BoxplotSeries	setAxisX(String axisX)	Sets this series' X axis to a plain category field, for example a product group.
NonAggrFieldAxis<BoxplotChart.BoxplotSeries>	setAxisY(String axisY)	Sets this series' Y axis to a Box Plot expression field, which supplies the statistical distribution (minimum, quartiles, maximum) plotted for each category rather than a single aggregated value.
BoxplotChart.BoxplotSeries	setComparisonDim(String comparisonDimension)	Sets the dimension this series is compared against a prior period on, for example comparing this period's revenue to the same dimension value last period.
BoxplotChart.BoxplotSeries	withSortByAxisX(SortType sortType)	Sorts this series by its X axis values.
BoxplotChart.BoxplotSeries	withSortByAxisY(SortType sortType)	Sorts this series by its Y axis values.
BoxplotChart.BoxplotSeries	withWhisker(WhiskerType whiskerType)	Sets the whisker calculation method for this series' box plot.

Methods inherited from class AbstractChartSeries

addAggregationsFilter, addCustomersFilter, addDimFilter, addFilters, addFilters, addProductsFilter, getFilters, getThis, invokeAddAdditionalMeasure, protectedSetAggrFieldAxisX, protectedSetAggrFieldAxisY, protectedSetAxisX, protectedSetAxisY, protectedSetNonAggrFieldAxisX, protectedSetNonAggrFieldAxisY, setAggregationBy, setBandBy, setBoxplotAxis, setCurrency, setDatamart, setFormula, setGeneratedQueryDto, setHideDataLabels, setHideOther, setLabel, setLimitTo, setShowBandByLegend, setShowBoxplot, setType, setWhisker, 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

BoxplotSeries

public BoxplotSeries(BoxplotChart backLink,
 String instanceId)

Method Details

setAxisX

public BoxplotChart.BoxplotSeries setAxisX(String axisX)

Sets this series' X axis to a plain category field, for example a product group.

Parameters:

axisX - the technical name of the field to plot on the X axis

Returns:

this series, for chaining further configuration

See Also:

• setAxisY(String)

setAxisY

public NonAggrFieldAxis<BoxplotChart.BoxplotSeries> setAxisY(String axisY)

Sets this series' Y axis to a Box Plot expression field, which supplies the statistical distribution (minimum, quartiles, maximum) plotted for each category rather than a single aggregated value.

Parameters:

axisY - the technical name of the field to plot on the Y axis

Returns:

a new NonAggrFieldAxis builder for the Y axis. Never null.

See Also:

• setAxisX(String)

withSortByAxisX

public BoxplotChart.BoxplotSeries withSortByAxisX(SortType sortType)

Description copied from class: AbstractChartSeries

Sorts this series by its X axis values. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports sorting by the X axis.

Overrides:

withSortByAxisX in class AbstractChartSeries<BoxplotChart,BoxplotChart.BoxplotSeries>

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.withSortByAxisY(SortType)

withSortByAxisY

public BoxplotChart.BoxplotSeries withSortByAxisY(SortType sortType)

Description copied from class: AbstractChartSeries

Sorts this series by its Y axis values. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports sorting by the Y axis.

Overrides:

withSortByAxisY in class AbstractChartSeries<BoxplotChart,BoxplotChart.BoxplotSeries>

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.withSortByAxisX(SortType)

setComparisonDim

public BoxplotChart.BoxplotSeries setComparisonDim(String comparisonDimension)

Description copied from class: AbstractChartSeries

Sets the dimension this series is compared against a prior period on, for example comparing this period's revenue to the same dimension value last period. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports period-over-period comparison.

Overrides:

setComparisonDim in class AbstractChartSeries<BoxplotChart,BoxplotChart.BoxplotSeries>

Parameters:

comparisonDimension - the technical name of the dimension field to compare by

Returns:

this series, for chaining further configuration

withWhisker

public BoxplotChart.BoxplotSeries withWhisker(WhiskerType whiskerType)

Sets the whisker calculation method for this series' box plot.

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

addAdditionalMeasure

public BoxplotChart.BoxplotAdditionalMeasure addAdditionalMeasure()

Adds a further measure to this series beyond its primary Y axis Box Plot expression.

Returns:

a new BoxplotChart.BoxplotAdditionalMeasure for this series. Never null.