Package net.pricefx.common.apibuilder.chart

Class TimeSeriesChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<TimeSeriesChart>

TimeSeriesChart

All Implemented Interfaces:

CanDoComparison, CanDoLogarithmicAxis, CanDrillDown, CanZoom, Portlet, Portlet

public class TimeSeriesChart
extends AbstractChartBuilder<TimeSeriesChart>
implements CanDoComparison, CanDoLogarithmicAxis, CanDrillDown, CanZoom

Builder for a Time Series Chart, obtained via ChartBuilder.newTimeSeries() rather than instantiated directly. See that factory method for how this chart plots aggregated measures against a date/time X axis, grouped into periodic buckets unlike the continuous axis of DetailedTimeSeriesChart, and a Groovy example.

Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.

See Also:

• ChartBuilder.newTimeSeries()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeSeriesChart.TimeSeriesAdditionalMeasure	A measure column on a TimeSeriesChart.TimeSeriesSeries, obtained from TimeSeriesChart.TimeSeriesSeries.addAdditionalMeasure() rather than instantiated directly.
static class	TimeSeriesChart.TimeSeriesOptions	The Options for a TimeSeriesChart, obtained from getOptions() rather than instantiated directly.
static class	TimeSeriesChart.TimeSeriesSeries	A single series of a TimeSeriesChart, obtained from addSeries() rather than instantiated directly.

Field Summary

Fields inherited from class AbstractChartBuilder

dragDropEnabled, layout, messages, queryBuilderState, resizingEnabled

Fields inherited from class AbstractBuilder

METHOD_BUILD

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Fields inherited from interface Portlet

UNIT_GRID, UNIT_PX

Constructor Summary

Constructors

Constructor	Description
TimeSeriesChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
AuxLine<TimeSeriesChart>	addAuxLine()	Adds a horizontal, vertical, or stepped reference line to this chart, independent of its data series, for example a fixed target or threshold value.
TimeSeriesChart.TimeSeriesSeries	addSeries()	Adds a new series to this chart.
ChartBuilderResult	build()	Finishes this chart's definition.
boolean	canDoLogarithmicAxis(char xyz)
TimeSeriesChart.TimeSeriesOptions	getOptions()	Returns this chart's Options builder.

Methods inherited from class AbstractChartBuilder

addInvocation, build, fromQueryBuilderState, getDictionary, getThis, invokeAddSeries, invokeGetOptions, invokeGetSeries, layout, onCellClick, onRowClick, value, withDragDrop, withError, withHeight, withHeight, withInfo, withLabelOverride, withLayout, withLayout, withLayout, withResizing, withTab, withWarning, withWidth, withWidth

Methods inherited from class ObjectIdentity

addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TimeSeriesChart

public TimeSeriesChart(IdGenerator idGenerator,
 Invocations<MethodInvocation> invocations)

Method Details

addSeries

public TimeSeriesChart.TimeSeriesSeries addSeries()

Adds a new series to this chart.

Returns:

a new TimeSeriesChart.TimeSeriesSeries for this chart. Never null.

getOptions

public TimeSeriesChart.TimeSeriesOptions getOptions()

Description copied from class: AbstractChartBuilder

Returns this chart's Options builder. Each concrete chart type declares its own Options subclass (for example ScatterChart.ScatterOptions, BarLineChart.BarLineOptions) exposing the settings that apply to that chart type, such as title, subtitle, and axis label and bound overrides; the exact set of available options differs per chart type, which is why this method is declared abstract here rather than implemented once for every chart.

Specified by:

getOptions in class AbstractChartBuilder<TimeSeriesChart>

Returns:

this chart's type-specific AbstractChartOptions instance. Never null.

addAuxLine

public AuxLine<TimeSeriesChart> addAuxLine()

Adds a horizontal, vertical, or stepped reference line to this chart, independent of its data series, for example a fixed target or threshold value. Call AuxLine.withLine(), AuxLine.withSteppedLine(), or AuxLine.withVerticalLine() on the returned builder to choose the line's shape.

Overrides:

addAuxLine in class AbstractChartBuilder<TimeSeriesChart>

Returns:

a new AuxLine builder for this chart. Never null.

build

public ChartBuilderResult build()

Finishes this chart's definition. The returned object is what Dashboard portlets, Quote headers, and other Data Analyzer areas render.

Specified by:

build in class AbstractBuilder

Returns:

the finished chart definition. Never null.

canDoLogarithmicAxis

public boolean canDoLogarithmicAxis(char xyz)

Specified by:

canDoLogarithmicAxis in interface CanDoLogarithmicAxis