Package net.pricefx.common.apibuilder.chart

Class DetailedTimeSeriesChart.DetailedTimeSeriesOptions

Object

ObjectIdentity

BacklinkBuilder<DetailedTimeSeriesChart>

AbstractChartOptions<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

ChartOptions.Basic<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

ChartOptions.XYLabels<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

ChartOptions.ZAxis<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

DetailedTimeSeriesOptions

Enclosing class:

DetailedTimeSeriesChart

public static class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
extends ChartOptions.ZAxis<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

The Options for a DetailedTimeSeriesChart, obtained from DetailedTimeSeriesChart.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
DetailedTimeSeriesOptions(DetailedTimeSeriesChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
DetailedTimeSeriesChart.DetailedTimeSeriesOptions	setComparisonType(ComparisonType comparisonType)	Sets how the compared prior period, enabled with AbstractChartOptions.setComparison(Boolean), is chosen.
DetailedTimeSeriesChart.DetailedTimeSeriesOptions	setDisableZoom(Boolean disableZoom)	Disables zooming on this chart.
DetailedTimeSeriesChart.DetailedTimeSeriesOptions	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).
DetailedTimeSeriesChart.DetailedTimeSeriesOptions	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).
DetailedTimeSeriesChart.DetailedTimeSeriesOptions	setYLogarithmic(boolean enable)	Renders the Y axis on a logarithmic scale.
DetailedTimeSeriesChart.DetailedTimeSeriesOptions	setZLogarithmic(boolean enable)	Renders the Z axis on a logarithmic scale.

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, setBoxplotAxisLabel, setBoxplotAxisMax, setBoxplotAxisMin, setDisableDrilldown, setMarker, setMaxDataPoints, setXLogarithmic, setXMax, 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

DetailedTimeSeriesOptions

public DetailedTimeSeriesOptions(DetailedTimeSeriesChart backLink,
 String instanceId)

Method Details

setDisableZoom

public DetailedTimeSeriesChart.DetailedTimeSeriesOptions 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<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration

setComparisonType

public DetailedTimeSeriesChart.DetailedTimeSeriesOptions setComparisonType(ComparisonType comparisonType)

Description copied from class: AbstractChartOptions

Sets how the compared prior period, enabled with AbstractChartOptions.setComparison(Boolean), is chosen. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example BarLineChart.BarLineOptions or DetailedTimeSeriesChart.DetailedTimeSeriesOptions.

Overrides:

setComparisonType in class AbstractChartOptions<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

Parameters:

comparisonType - the kind of prior period to compare against

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setComparison(Boolean)

setXMin

public DetailedTimeSeriesChart.DetailedTimeSeriesOptions 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<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

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 DetailedTimeSeriesChart.DetailedTimeSeriesOptions 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<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

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)

setYLogarithmic

public DetailedTimeSeriesChart.DetailedTimeSeriesOptions 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<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

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 DetailedTimeSeriesChart.DetailedTimeSeriesOptions 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<DetailedTimeSeriesChart,DetailedTimeSeriesChart.DetailedTimeSeriesOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration