Package net.pricefx.common.apibuilder.chart

Class BubbleChart.BubbleSeries

Object

ObjectIdentity

BacklinkBuilder<BubbleChart>

AbstractChartSeries<BubbleChart,BubbleChart.BubbleSeries>

ChartSeries.Basic<BubbleChart,BubbleChart.BubbleSeries>

ChartSeries.Aggregation<BubbleChart,BubbleChart.BubbleSeries>

BubbleSeries

Enclosing class:

BubbleChart

public static class BubbleChart.BubbleSeries
extends ChartSeries.Aggregation<BubbleChart,BubbleChart.BubbleSeries>

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

Field Summary

Fields inherited from class ChartSeries.Aggregation

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
BubbleSeries(BubbleChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
BubbleChart.BubbleAdditionalMeasure	addAdditionalMeasure()	Adds a further measure to this series beyond its X axis, Y axis, and bubble size measures.
AggrFieldAxis<BubbleChart.BubbleSeries>	setAxisX(String axisX)	Sets this series' X axis to an aggregated numeric measure, for example quantity.
AggrFieldAxis<BubbleChart.BubbleSeries>	setAxisY(String axisY)	Sets this series' Y axis to an aggregated numeric measure, for example price.
BubbleChart.BubbleSize	setBubbleSize(String bubbleSize)	Sets the third aggregated numeric measure that determines each point's bubble size, the "Bubble Size" setting in the Data Analyzer UI.
BubbleChart.BubbleSeries	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<BubbleChart.BubbleSeries>	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.
TrendLine<BubbleChart.BubbleSeries>	withTrendLine()	Adds a trend line overlay to this series.

Methods inherited from class ChartSeries.Aggregation

getBandByOptions, setAggregationBy, setBandBy, setShowBandByLegend

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, setLabel, setShowBoxplot, setType, setWhisker, withSortByAxisX, withSortByAxisY

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

BubbleSeries

public BubbleSeries(BubbleChart backLink,
 String instanceId)

Method Details

setAxisX

public AggrFieldAxis<BubbleChart.BubbleSeries> setAxisX(String axisX)

Sets this series' X axis to an aggregated numeric measure, for example quantity.

Parameters:

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

Returns:

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

See Also:

• setAxisY(String)
• setBubbleSize(String)

setAxisY

public AggrFieldAxis<BubbleChart.BubbleSeries> setAxisY(String axisY)

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

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)
• setBubbleSize(String)

setLimitTo

public LimitToMeasure<BubbleChart.BubbleSeries> 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<BubbleChart,BubbleChart.BubbleSeries>

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 BubbleChart.BubbleSeries 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<BubbleChart,BubbleChart.BubbleSeries>

Parameters:

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

Returns:

this series, for chaining further configuration

setBubbleSize

public BubbleChart.BubbleSize setBubbleSize(String bubbleSize)

Sets the third aggregated numeric measure that determines each point's bubble size, the "Bubble Size" setting in the Data Analyzer UI.

Parameters:

bubbleSize - the technical name of the field to aggregate and use for bubble size

Returns:

a new BubbleChart.BubbleSize builder for the bubble size measure. Never null.

See Also:

• setAxisX(String)
• setAxisY(String)

addAdditionalMeasure

public BubbleChart.BubbleAdditionalMeasure addAdditionalMeasure()

Adds a further measure to this series beyond its X axis, Y axis, and bubble size measures.

Returns:

a new BubbleChart.BubbleAdditionalMeasure for this series. Never null.

withTrendLine

public TrendLine<BubbleChart.BubbleSeries> withTrendLine()

Description copied from class: AbstractChartSeries

Adds a trend line overlay to this series. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports trend lines. Call TrendLine.setLabel(String) and the regression-type setter on the returned builder to configure it.

Overrides:

withTrendLine in class AbstractChartSeries<BubbleChart,BubbleChart.BubbleSeries>

Returns:

a new TrendLine builder for this series. Never null.