Package net.pricefx.common.apibuilder.chart

Class BarLineChart.BarLineSeries

Object

ObjectIdentity

BacklinkBuilder<BarLineChart>

AbstractChartSeries<BarLineChart,BarLineChart.BarLineSeries>

ChartSeries.Basic<BarLineChart,BarLineChart.BarLineSeries>

ChartSeries.EmbeddedBoxplot<BarLineChart,BarLineChart.BarLineSeries>

BarLineSeries

Enclosing class:

BarLineChart

public static class BarLineChart.BarLineSeries
extends ChartSeries.EmbeddedBoxplot<BarLineChart,BarLineChart.BarLineSeries>

A single series of a BarLineChart, obtained from BarLineChart.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
BarLineSeries(BarLineChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
BarLineChart.BarLineAdditionalMeasure	addAdditionalMeasure()	Adds a further measure to this series beyond its primary Y axis measure, plotted alongside it.
BarLineChart.BarLineSeries	setAxisX(String axisX)	Sets this series' X axis to a plain category field, for example a country or product group.
AggrFieldAxis<BarLineChart.BarLineSeries>	setAxisY(String axisY)	Sets this series' Y axis to an aggregated numeric measure, for example revenue.
BarLineChart.BarLineSeries	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.
BarLineChart.BarLineSeries	setHideOther(Boolean hideOther)	Hides the "Other" bucket that some chart types add to collect data points not otherwise shown, for example the remainder after a Top-N limit.
LimitToMeasure<BarLineChart.BarLineSeries>	setLimitTo(LimitPosition limitPosition, BigDecimal amount, LimitType limitType)	Limits this series to its top or bottom amount rows by measure value, for example the top 10 customers by revenue.
BarLineChart.BarLineSeries	withSortByAxisX(SortType sortType)	Sorts this series by its X axis values.
BarLineChart.BarLineSeries	withSortByAxisY(SortType sortType)	Sorts this series by its Y axis values.

Methods inherited from class ChartSeries.EmbeddedBoxplot

setBoxplotAxis, setShowBoxplot, setType, setWhisker

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

BarLineSeries

public BarLineSeries(BarLineChart backLink,
 String instanceId)

Method Details

setLimitTo

public LimitToMeasure<BarLineChart.BarLineSeries> setLimitTo(LimitPosition limitPosition,
 BigDecimal amount,
 LimitType limitType)

Description copied from class: AbstractChartSeries

Limits this series to its top or bottom amount rows by measure value, for example the top 10 customers by revenue. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports Top-N/Bottom-N limiting. By default the limit applies to the series' own measure; call LimitToMeasure.setMeasure(String) on the returned builder to limit by a different measure instead.

Overrides:

setLimitTo in class AbstractChartSeries<BarLineChart,BarLineChart.BarLineSeries>

Parameters:

limitPosition - LimitPosition.TOP or LimitPosition.BOTTOM

amount - the number of rows to keep

limitType - the kind of limit to apply; currently only LimitType.ROW exists

Returns:

a new LimitToMeasure builder for this series. Never null.

setHideOther

public BarLineChart.BarLineSeries setHideOther(Boolean hideOther)

Description copied from class: AbstractChartSeries

Hides the "Other" bucket that some chart types add to collect data points not otherwise shown, for example the remainder after a Top-N limit. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports an "Other" bucket.

Overrides:

setHideOther in class AbstractChartSeries<BarLineChart,BarLineChart.BarLineSeries>

Parameters:

hideOther - true to hide the "Other" bucket; false or null to show it

Returns:

this series, for chaining further configuration

setAxisX

public BarLineChart.BarLineSeries setAxisX(String axisX)

Sets this series' X axis to a plain category field, for example a country or 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 AggrFieldAxis<BarLineChart.BarLineSeries> setAxisY(String axisY)

Sets this series' Y axis to an aggregated numeric measure, for example revenue.

Parameters:

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

Returns:

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

See Also:

• setAxisX(String)

withSortByAxisX

public BarLineChart.BarLineSeries 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<BarLineChart,BarLineChart.BarLineSeries>

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.withSortByAxisY(SortType)

withSortByAxisY

public BarLineChart.BarLineSeries 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<BarLineChart,BarLineChart.BarLineSeries>

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.withSortByAxisX(SortType)

setComparisonDim

public BarLineChart.BarLineSeries 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<BarLineChart,BarLineChart.BarLineSeries>

Parameters:

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

Returns:

this series, for chaining further configuration

addAdditionalMeasure

public BarLineChart.BarLineAdditionalMeasure addAdditionalMeasure()

Adds a further measure to this series beyond its primary Y axis measure, plotted alongside it.

Returns:

a new BarLineChart.BarLineAdditionalMeasure for this series. Never null.