Package net.pricefx.common.apibuilder.chart

Class TimeSeriesChart.TimeSeriesOptions

Object

ObjectIdentity

BacklinkBuilder<TimeSeriesChart>

AbstractChartOptions<TimeSeriesChart,TimeSeriesChart.TimeSeriesOptions>

ChartOptions.Basic<TimeSeriesChart,TimeSeriesChart.TimeSeriesOptions>

ChartOptions.XYLabels<TimeSeriesChart,TimeSeriesChart.TimeSeriesOptions>

ChartOptions.ZAxis<TimeSeriesChart,TimeSeriesChart.TimeSeriesOptions>

ChartOptions.EmbeddedBoxplot<TimeSeriesChart,TimeSeriesChart.TimeSeriesOptions>

TimeSeriesOptions

Enclosing class:

TimeSeriesChart

public static class TimeSeriesChart.TimeSeriesOptions
extends ChartOptions.EmbeddedBoxplot<TimeSeriesChart,TimeSeriesChart.TimeSeriesOptions>

The Options for a TimeSeriesChart, obtained from TimeSeriesChart.getOptions() rather than instantiated directly.

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
TimeSeriesOptions(TimeSeriesChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
TimeSeriesChart.TimeSeriesOptions	setDisableDrilldown(Boolean disableDrilldown)	Disables drilldown on this chart.
TimeSeriesChart.TimeSeriesOptions	setDisableZoom(Boolean disableZoom)	Disables zooming on this chart.
TimeSeriesChart.TimeSeriesOptions	setLegacyComparisonMode(Boolean legacyComparisonMode)	Sets whether this chart's period comparison uses the legacy rendering mode, the "Legacy comparison mode" setting in the Data Analyzer UI.
TimeSeriesChart.TimeSeriesOptions	setYLogarithmic(boolean enable)	Renders the Y axis on a logarithmic scale.
TimeSeriesChart.TimeSeriesOptions	setZLogarithmic(boolean enable)	Renders the Z axis on a logarithmic scale.

Methods inherited from class ChartOptions.EmbeddedBoxplot

setBoxplotAxisLabel, setBoxplotAxisMax, setBoxplotAxisMin

Methods inherited from class ChartOptions.ZAxis

setComparison, setShowZAxis, setYMax, setYMin, setZLabel, setZMax, setZMin

Methods inherited from class ChartOptions.XYLabels

setXLabel, setYLabel

Methods inherited from class ChartOptions.Basic

setHideLegend, setHideTooltips, setSubtitle, setTitle

Methods inherited from class AbstractChartOptions

getThis, setComparisonType, setMarker, setMaxDataPoints, setXLogarithmic, setXMax, setXMax, setXMin, setXMin

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

TimeSeriesOptions

public TimeSeriesOptions(TimeSeriesChart backLink,
 String instanceId)

Method Details

setDisableDrilldown

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

Parameters:

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

Returns:

this Options object, for chaining further configuration

setDisableZoom

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

Parameters:

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

Returns:

this Options object, for chaining further configuration

setLegacyComparisonMode

public TimeSeriesChart.TimeSeriesOptions setLegacyComparisonMode(Boolean legacyComparisonMode)

Sets whether this chart's period comparison uses the legacy rendering mode, the "Legacy comparison mode" setting in the Data Analyzer UI.

Parameters:

legacyComparisonMode - true to use the legacy comparison rendering; false or null to use the current rendering

Returns:

this Options object, for chaining further configuration

setYLogarithmic

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

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)

setZLogarithmic

public TimeSeriesChart.TimeSeriesOptions setZLogarithmic(boolean enable)

Description copied from class: AbstractChartOptions

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

Overrides:

setZLogarithmic in class AbstractChartOptions<TimeSeriesChart,TimeSeriesChart.TimeSeriesOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration