Package net.pricefx.common.apibuilder.chart

Class TimeSeriesChart.TimeSeriesSeries

Object

ObjectIdentity

BacklinkBuilder<TimeSeriesChart>

AbstractChartSeries<TimeSeriesChart,TimeSeriesChart.TimeSeriesSeries>

ChartSeries.Basic<TimeSeriesChart,TimeSeriesChart.TimeSeriesSeries>

ChartSeries.EmbeddedBoxplot<TimeSeriesChart,TimeSeriesChart.TimeSeriesSeries>

TimeSeriesSeries

Enclosing class:

TimeSeriesChart

public static class TimeSeriesChart.TimeSeriesSeries
extends ChartSeries.EmbeddedBoxplot<TimeSeriesChart,TimeSeriesChart.TimeSeriesSeries>

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

Method Summary

Modifier and Type	Method	Description
TimeSeriesChart.TimeSeriesAdditionalMeasure	addAdditionalMeasure()	Adds a further measure to this series, independent of any other measure already added.
TimeSeriesChart.TimeSeriesSeries	setAxisX(String axisX)	Sets the technical name of the date/time field this series plots on the X axis, grouped into periodic buckets.
AggrFieldAxis<TimeSeriesChart.TimeSeriesSeries>	setAxisY(String axisY)	Sets the technical name of the aggregated numeric measure this series plots on the Y axis.
TimeSeriesChart.TimeSeriesSeries	setComparisonPeriod(BigDecimal comparisonPeriod)	Sets how many periods back this series is compared against, when period comparison is enabled with ChartOptions.ZAxis.setComparison(Boolean).
TimeSeriesChart.TimeSeriesSeries	setFromDate(Date fromDate)	Sets the start of this series' date range, restricting it to periods on or after this date.
LimitToMeasure<TimeSeriesChart.TimeSeriesSeries>	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.
TimeSeriesChart.TimeSeriesSeries	setToDate(Date toDate)	Sets the end of this series' date range, restricting it to periods on or before this date.
TrendLine<TimeSeriesChart.TimeSeriesSeries>	withTrendLine()	Adds a trend line overlay to this series.

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

TimeSeriesSeries

public TimeSeriesSeries(TimeSeriesChart backLink,
 String instanceId)

Method Details

setLimitTo

public LimitToMeasure<TimeSeriesChart.TimeSeriesSeries> 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<TimeSeriesChart,TimeSeriesChart.TimeSeriesSeries>

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 TimeSeriesChart.TimeSeriesSeries setAxisX(String axisX)

Sets the technical name of the date/time field this series plots on the X axis, grouped into periodic buckets.

Parameters:

axisX - the technical name of the date/time dimension field

Returns:

this series, for chaining further configuration

See Also:

• setAxisY(String)

setAxisY

public AggrFieldAxis<TimeSeriesChart.TimeSeriesSeries> setAxisY(String axisY)

Sets the technical name of the aggregated numeric measure this series plots on the Y axis.

Parameters:

axisY - the technical name of the measure field to aggregate

Returns:

a new AggrFieldAxis for further configuring this Y axis measure

See Also:

• setAxisX(String)

setFromDate

public TimeSeriesChart.TimeSeriesSeries setFromDate(Date fromDate)

Sets the start of this series' date range, restricting it to periods on or after this date.

Parameters:

fromDate - the earliest date to include

Returns:

this series, for chaining further configuration

See Also:

• setToDate(Date)

setToDate

public TimeSeriesChart.TimeSeriesSeries setToDate(Date toDate)

Sets the end of this series' date range, restricting it to periods on or before this date.

Parameters:

toDate - the latest date to include

Returns:

this series, for chaining further configuration

See Also:

• setFromDate(Date)

setComparisonPeriod

public TimeSeriesChart.TimeSeriesSeries setComparisonPeriod(BigDecimal comparisonPeriod)

Sets how many periods back this series is compared against, when period comparison is enabled with ChartOptions.ZAxis.setComparison(Boolean).

Parameters:

comparisonPeriod - the number of periods back to compare this series against

Returns:

this series, for chaining further configuration

See Also:

• ChartOptions.ZAxis.setComparison(Boolean)

withTrendLine

public TrendLine<TimeSeriesChart.TimeSeriesSeries> 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<TimeSeriesChart,TimeSeriesChart.TimeSeriesSeries>

Returns:

a new TrendLine builder for this series. Never null.

addAdditionalMeasure

public TimeSeriesChart.TimeSeriesAdditionalMeasure addAdditionalMeasure()

Adds a further measure to this series, independent of any other measure already added.

Returns:

a new TimeSeriesChart.TimeSeriesAdditionalMeasure for this series. Never null.