Package net.pricefx.common.apibuilder.chart

Class TimeSeriesScatterChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<TimeSeriesScatterChart>

TimeSeriesScatterChart

All Implemented Interfaces:

CanDoLogarithmicAxis, CanDrillDown, CanZoom, Portlet, Portlet

public class TimeSeriesScatterChart
extends AbstractChartBuilder<TimeSeriesScatterChart>
implements CanDoLogarithmicAxis, CanDrillDown, CanZoom

Builder for a Time Series Scatter Chart, obtained via ChartBuilder.newTimeSeriesScatter() rather than instantiated directly. See that factory method for how this chart plots two aggregated measures against each other with a date/time X axis 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.newTimeSeriesScatter()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeSeriesScatterChart.TimeSeriesScatterAdditionalMeasure	A measure column on a TimeSeriesScatterChart.TimeSeriesScatterSeries, obtained from TimeSeriesScatterChart.TimeSeriesScatterSeries.addAdditionalMeasure() rather than instantiated directly.
static class	TimeSeriesScatterChart.TimeSeriesScatterOptions	The Options for a TimeSeriesScatterChart, obtained from getOptions() rather than instantiated directly.
static class	TimeSeriesScatterChart.TimeSeriesScatterSeries	A single series of a TimeSeriesScatterChart, obtained from addSeries() rather than instantiated directly.

Field Summary

Fields

Modifier and Type	Field	Description
protected TimeSeriesScatterChart.TimeSeriesScatterOptions	options

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
TimeSeriesScatterChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
AuxLine<TimeSeriesScatterChart>	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.
TimeSeriesScatterChart.TimeSeriesScatterSeries	addSeries()	Adds a new series to this chart.
ChartBuilderResult	build()	Finishes this chart's definition.
TimeSeriesScatterChart.TimeSeriesScatterOptions	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

Methods inherited from interface CanDoLogarithmicAxis

canDoLogarithmicAxis

Field Details

options

protected TimeSeriesScatterChart.TimeSeriesScatterOptions options

Constructor Details

TimeSeriesScatterChart

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

Method Details

addSeries

public TimeSeriesScatterChart.TimeSeriesScatterSeries addSeries()

Adds a new series to this chart.

Returns:

a new TimeSeriesScatterChart.TimeSeriesScatterSeries for this chart. Never null.

getOptions

public TimeSeriesScatterChart.TimeSeriesScatterOptions 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<TimeSeriesScatterChart>

Returns:

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

addAuxLine

public AuxLine<TimeSeriesScatterChart> 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<TimeSeriesScatterChart>

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.