Package net.pricefx.common.apibuilder.chart

Class DetailedTimeSeriesChart.DetailedTimeSeriesSeries

Object

ObjectIdentity

BacklinkBuilder<DetailedTimeSeriesChart>

AbstractChartSeries<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesSeries>

ChartSeries.Basic<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesSeries>

DetailedTimeSeriesSeries

Enclosing class:

DetailedTimeSeriesChart

public static class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
extends ChartSeries.Basic<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesSeries>

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
DetailedTimeSeriesSeries(DetailedTimeSeriesChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure	addAdditionalMeasure()
DetailedTimeSeriesChart.DetailedTimeSeriesSeries	setAxisX(String axisX)
AggrFieldAxis<DetailedTimeSeriesChart.DetailedTimeSeriesSeries>	setAxisY(String axisY)
DetailedTimeSeriesChart.DetailedTimeSeriesSeries	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.
LimitToMeasure<DetailedTimeSeriesChart.DetailedTimeSeriesSeries>	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.
DetailedTimeSeriesChart.DetailedTimeSeriesSeries	setType(SeriesType seriesType)	Sets how this series itself is rendered, independently of the chart's overall type, for example rendering one series of a Bar & Line Chart as a line while its other series render as bars.

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

DetailedTimeSeriesSeries

public DetailedTimeSeriesSeries(DetailedTimeSeriesChart backLink,
 String instanceId)

Method Details

setLimitTo

public LimitToMeasure<DetailedTimeSeriesChart.DetailedTimeSeriesSeries> 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<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesSeries>

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 DetailedTimeSeriesChart.DetailedTimeSeriesSeries setAxisX(String axisX)

setAxisY

public AggrFieldAxis<DetailedTimeSeriesChart.DetailedTimeSeriesSeries> setAxisY(String axisY)

setType

public DetailedTimeSeriesChart.DetailedTimeSeriesSeries setType(SeriesType seriesType)

Description copied from class: AbstractChartSeries

Sets how this series itself is rendered, independently of the chart's overall type, for example rendering one series of a Bar & Line Chart as a line while its other series render as bars. Declared protected here; a concrete series type re-exposes it as public only if that chart type supports mixing rendering types across series.

Overrides:

setType in class AbstractChartSeries<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesSeries>

Parameters:

seriesType - the rendering type to use for this series

Returns:

this series, for chaining further configuration

setComparisonDim

public DetailedTimeSeriesChart.DetailedTimeSeriesSeries 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<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesSeries>

Parameters:

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

Returns:

this series, for chaining further configuration

addAdditionalMeasure

public DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure addAdditionalMeasure()