Package net.pricefx.common.apibuilder.chart

Class TimeSeriesScatterChart.TimeSeriesScatterOptions

Object

ObjectIdentity

BacklinkBuilder<TimeSeriesScatterChart>

AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

ChartOptions.Basic<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

ChartOptions.XYLabels<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

TimeSeriesScatterOptions

Enclosing class:

TimeSeriesScatterChart

public static class TimeSeriesScatterChart.TimeSeriesScatterOptions
extends ChartOptions.XYLabels<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

The Options for a TimeSeriesScatterChart, obtained from TimeSeriesScatterChart.getOptions() rather than instantiated directly. Unlike ScatterChart.ScatterOptions, this does not extend ChartOptions.XYMinMax, since its X axis bounds are dates rather than plain numbers; setXMin(java.util.Date) and setXMax(java.util.Date) are overridden directly instead.

Field Summary

Fields inherited from class BacklinkBuilder

METHOD_BACK

Fields inherited from class ObjectIdentity

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

Constructor Summary

Constructors

Constructor	Description
TimeSeriesScatterOptions(TimeSeriesScatterChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
TimeSeriesScatterChart.TimeSeriesScatterOptions	setDisableDrilldown(Boolean disableDrilldown)	Disables drilldown on this chart.
TimeSeriesScatterChart.TimeSeriesScatterOptions	setDisableZoom(Boolean disableZoom)	Disables zooming on this chart.
TimeSeriesScatterChart.TimeSeriesScatterOptions	setMarker(BigDecimal xValue, BigDecimal yValue)	Adds a reference marker at the given X/Y coordinate.
TimeSeriesScatterChart.TimeSeriesScatterOptions	setXMax(Date xMaxDate)	Sets the X axis' upper bound for a chart type whose X axis is a continuous date/time scale, unlike AbstractChartOptions.setXMax(BigDecimal).
TimeSeriesScatterChart.TimeSeriesScatterOptions	setXMin(Date xMinDate)	Sets the X axis' lower bound for a chart type whose X axis is a continuous date/time scale, unlike AbstractChartOptions.setXMin(BigDecimal).
TimeSeriesScatterChart.TimeSeriesScatterOptions	setYLogarithmic(boolean enable)	Renders the Y axis on a logarithmic scale.
TimeSeriesScatterChart.TimeSeriesScatterOptions	setYMax(BigDecimal xMaxDecimal)	Sets the Y axis' upper bound.
TimeSeriesScatterChart.TimeSeriesScatterOptions	setYMin(BigDecimal yMinDecimal)	Sets the Y axis' lower bound.

Methods inherited from class ChartOptions.XYLabels

setXLabel, setYLabel

Methods inherited from class ChartOptions.Basic

setHideLegend, setHideTooltips, setSubtitle, setTitle

Methods inherited from class AbstractChartOptions

getThis, setBoxplotAxisLabel, setBoxplotAxisMax, setBoxplotAxisMin, setComparison, setComparisonType, setMaxDataPoints, setShowZAxis, setXLogarithmic, setXMax, setXMin, setZLabel, setZLogarithmic, setZMax, setZMin

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

TimeSeriesScatterOptions

public TimeSeriesScatterOptions(TimeSeriesScatterChart backLink,
 String instanceId)

Method Details

setDisableDrilldown

public TimeSeriesScatterChart.TimeSeriesScatterOptions setDisableDrilldown(Boolean disableDrilldown)

Description copied from class: AbstractChartOptions

Disables drilldown on this chart. Not exposed through any ChartOptions tier; almost every concrete Options type overrides it directly, since drilldown applies broadly across chart types.

Overrides:

setDisableDrilldown in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

disableDrilldown - true to disable drilldown; false or null to allow it

Returns:

this Options object, for chaining further configuration

setDisableZoom

public TimeSeriesScatterChart.TimeSeriesScatterOptions setDisableZoom(Boolean disableZoom)

Description copied from class: AbstractChartOptions

Disables zooming on this chart. Not exposed through any ChartOptions tier; most concrete Options types that support zoom override it directly.

Overrides:

setDisableZoom in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

disableZoom - true to disable zoom; false or null to allow it

Returns:

this Options object, for chaining further configuration

setXMin

public TimeSeriesScatterChart.TimeSeriesScatterOptions setXMin(Date xMinDate)

Description copied from class: AbstractChartOptions

Sets the X axis' lower bound for a chart type whose X axis is a continuous date/time scale, unlike AbstractChartOptions.setXMin(BigDecimal). Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example DetailedTimeSeriesChart.DetailedTimeSeriesOptions or TimeSeriesScatterChart.TimeSeriesScatterOptions.

Overrides:

setXMin in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

xMinDate - the earliest date/time to show on the X axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setXMax(java.util.Date)

setXMax

public TimeSeriesScatterChart.TimeSeriesScatterOptions setXMax(Date xMaxDate)

Description copied from class: AbstractChartOptions

Sets the X axis' upper bound for a chart type whose X axis is a continuous date/time scale, unlike AbstractChartOptions.setXMax(BigDecimal). Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example DetailedTimeSeriesChart.DetailedTimeSeriesOptions or TimeSeriesScatterChart.TimeSeriesScatterOptions.

Overrides:

setXMax in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

xMaxDate - the latest date/time to show on the X axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setXMin(java.util.Date)

setYMin

public TimeSeriesScatterChart.TimeSeriesScatterOptions setYMin(BigDecimal yMinDecimal)

Description copied from class: AbstractChartOptions

Sets the Y axis' lower bound. Declared protected here; re-exposed as public independently via both ChartOptions.XYMinMax and ChartOptions.ZAxis, since most chart types have a Y axis worth bounding regardless of which of those two tiers they otherwise build on.

Overrides:

setYMin in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

yMinDecimal - the lowest value to show on the Y axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setYMax(BigDecimal)

setYMax

public TimeSeriesScatterChart.TimeSeriesScatterOptions setYMax(BigDecimal xMaxDecimal)

Description copied from class: AbstractChartOptions

Sets the Y axis' upper bound. Declared protected here; re-exposed as public independently via both ChartOptions.XYMinMax and ChartOptions.ZAxis, since most chart types have a Y axis worth bounding regardless of which of those two tiers they otherwise build on.

Overrides:

setYMax in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

xMaxDecimal - the highest value to show on the Y axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setYMin(BigDecimal)

setMarker

public TimeSeriesScatterChart.TimeSeriesScatterOptions setMarker(BigDecimal xValue,
 BigDecimal yValue)

Description copied from class: AbstractChartOptions

Adds a reference marker at the given X/Y coordinate. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example ScatterChart.ScatterOptions, BubbleChart.BubbleOptions, or TimeSeriesScatterChart.TimeSeriesScatterOptions. Only meaningful for a chart type whose X and Y axes are both aggregated numeric measures.

Overrides:

setMarker in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

xValue - the marker's X coordinate

yValue - the marker's Y coordinate

Returns:

this Options object, for chaining further configuration

setYLogarithmic

public TimeSeriesScatterChart.TimeSeriesScatterOptions setYLogarithmic(boolean enable)

Description copied from class: AbstractChartOptions

Renders the Y axis on a logarithmic scale. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example ScatterChart.ScatterOptions or BarLineChart.BarLineOptions.

Overrides:

setYLogarithmic in class AbstractChartOptions<TimeSeriesScatterChart,TimeSeriesScatterChart.TimeSeriesScatterOptions>

Parameters:

enable - true to use a logarithmic Y axis; false for a linear one

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setXLogarithmic(boolean)