Package net.pricefx.common.apibuilder.chart

Class HeatmapChart.HeatmapSeries

Object

ObjectIdentity

BacklinkBuilder<HeatmapChart>

AbstractChartSeries<HeatmapChart,HeatmapChart.HeatmapSeries>

ChartSeries.Basic<HeatmapChart,HeatmapChart.HeatmapSeries>

HeatmapSeries

Enclosing class:

HeatmapChart

public static class HeatmapChart.HeatmapSeries
extends ChartSeries.Basic<HeatmapChart,HeatmapChart.HeatmapSeries>

The single series of a HeatmapChart, obtained from HeatmapChart.getSeries() 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
HeatmapSeries(HeatmapChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
HeatmapChart.HeatmapAdditionalMeasure	addAdditionalMeasure()	Adds a further measure to this series beyond its color axis measure.
HeatmapChart.HeatmapSeries	normalizeAcrossColumns()	Normalizes each Y axis category (row) to sum to 100%, so cell colors within a row show each column's share of that row's total rather than its raw aggregated value.
HeatmapChart.HeatmapSeries	normalizeAcrossRows()	Normalizes each X axis category (column) to sum to 100%, so cell colors within a column show each row's share of that column's total rather than its raw aggregated value.
HeatmapChart.HeatmapSeries	setAxisX(String axisX)	Sets the plain category field shown along the grid's X axis (columns), for example a product group.
HeatmapChart.HeatmapSeries	setAxisY(String axisY)	Sets the plain category field shown along the grid's Y axis (rows), for example a region.
AggrFieldAxis<HeatmapChart.HeatmapSeries>	setColorAxis(String colorAxis)	Sets the aggregated numeric measure that determines each grid cell's color, the "Color Axis" in the Data Analyzer UI.
LimitToMeasure<HeatmapChart.HeatmapSeries>	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.
HeatmapChart.HeatmapSeries	withSortByAxisX(SortType sortType)	Sorts this series by its X axis values.
HeatmapChart.HeatmapSeries	withSortByAxisY(SortType sortType)	Sorts this series by its Y axis 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, setHideOther, setLabel, 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

HeatmapSeries

public HeatmapSeries(HeatmapChart backLink,
 String instanceId)

Method Details

setLimitTo

public LimitToMeasure<HeatmapChart.HeatmapSeries> 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<HeatmapChart,HeatmapChart.HeatmapSeries>

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.

setAxisX

public HeatmapChart.HeatmapSeries setAxisX(String axisX)

Sets the plain category field shown along the grid's X axis (columns), 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)

withSortByAxisX

public HeatmapChart.HeatmapSeries 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<HeatmapChart,HeatmapChart.HeatmapSeries>

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.withSortByAxisY(SortType)

setAxisY

public HeatmapChart.HeatmapSeries setAxisY(String axisY)

Sets the plain category field shown along the grid's Y axis (rows), for example a region.

Parameters:

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

Returns:

this series, for chaining further configuration

See Also:

• setAxisX(String)

withSortByAxisY

public HeatmapChart.HeatmapSeries 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<HeatmapChart,HeatmapChart.HeatmapSeries>

Parameters:

sortType - the sort direction to apply

Returns:

this series, for chaining further configuration

See Also:

• AbstractChartSeries.withSortByAxisX(SortType)

setColorAxis

public AggrFieldAxis<HeatmapChart.HeatmapSeries> setColorAxis(String colorAxis)

Sets the aggregated numeric measure that determines each grid cell's color, the "Color Axis" in the Data Analyzer UI.

Parameters:

colorAxis - the technical name of the field to aggregate and use for cell color

Returns:

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

See Also:

• HeatmapChart.HeatmapOptions.setColorAxisType(ColorAxisType)

normalizeAcrossColumns

public HeatmapChart.HeatmapSeries normalizeAcrossColumns()

Normalizes each Y axis category (row) to sum to 100%, so cell colors within a row show each column's share of that row's total rather than its raw aggregated value.

Returns:

this series, for chaining further configuration

See Also:

• normalizeAcrossRows()

normalizeAcrossRows

public HeatmapChart.HeatmapSeries normalizeAcrossRows()

Normalizes each X axis category (column) to sum to 100%, so cell colors within a column show each row's share of that column's total rather than its raw aggregated value.

Returns:

this series, for chaining further configuration

See Also:

• normalizeAcrossColumns()

addAdditionalMeasure

public HeatmapChart.HeatmapAdditionalMeasure addAdditionalMeasure()

Adds a further measure to this series beyond its color axis measure.

Returns:

a new HeatmapChart.HeatmapAdditionalMeasure for this series. Never null.