Package net.pricefx.common.apibuilder.chart

Class PieChart.PieSeries

Object

ObjectIdentity

BacklinkBuilder<PieChart>

AbstractChartSeries<PieChart,PieChart.PieSeries>

ChartSeries.Basic<PieChart,PieChart.PieSeries>

PieSeries

Enclosing class:

PieChart

public static class PieChart.PieSeries
extends ChartSeries.Basic<PieChart,PieChart.PieSeries>

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

Method Summary

Modifier and Type	Method	Description
PieChart.PieAdditionalMeasure	addAdditionalMeasure()	Adds a further measure to this series, independent of the measure set with setSize(String).
PieChart.PieSeries	setCategories(String category)	Sets the technical name of the dimension field each pie slice represents.
PieChart.PieSeries	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<PieChart.PieSeries>	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.
PieChart.Size	setSize(String size)	Sets the aggregated numeric measure that determines each slice's size.
PieChart.PieSeries	withSortByCategories(SortType sortType)	Sorts this series' slices by their category values.
PieChart.PieSeries	withSortBySize(SortType sortType)	Sorts this series' slices by their size values.

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

Constructor Details

PieSeries

public PieSeries(PieChart backLink,
 String instanceId)

Method Details

setLimitTo

public LimitToMeasure<PieChart.PieSeries> 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<PieChart,PieChart.PieSeries>

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 PieChart.PieSeries 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<PieChart,PieChart.PieSeries>

Parameters:

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

Returns:

this series, for chaining further configuration

setCategories

public PieChart.PieSeries setCategories(String category)

Sets the technical name of the dimension field each pie slice represents.

Parameters:

category - the technical name of the category dimension field

Returns:

this series, for chaining further configuration

See Also:

• setSize(String)

setSize

public PieChart.Size setSize(String size)

Sets the aggregated numeric measure that determines each slice's size.

Parameters:

size - the technical name of the measure field to aggregate

Returns:

a new PieChart.Size for further configuring this measure

See Also:

• setCategories(String)

withSortByCategories

public PieChart.PieSeries withSortByCategories(SortType sortType)

Sorts this series' slices by their category values.

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• withSortBySize(SortType)

withSortBySize

public PieChart.PieSeries withSortBySize(SortType sortType)

Sorts this series' slices by their size values.

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• withSortByCategories(SortType)

addAdditionalMeasure

public PieChart.PieAdditionalMeasure addAdditionalMeasure()

Adds a further measure to this series, independent of the measure set with setSize(String).

Returns:

a new PieChart.PieAdditionalMeasure for this series. Never null.