Package net.pricefx.common.apibuilder.chart

Class ChartOptions.ZAxis<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Object

ObjectIdentity

BacklinkBuilder<C>

AbstractChartOptions<C,O>

ChartOptions.Basic<C,O>

ChartOptions.XYLabels<C,O>

ZAxis<C,O>

Direct Known Subclasses:

BoxplotChart.BoxplotOptions, ChartOptions.EmbeddedBoxplot, DetailedTimeSeriesChart.DetailedTimeSeriesOptions, HistogramChart.HistogramOptions

Enclosing class:

ChartOptions

public abstract static class ChartOptions.ZAxis<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>
extends ChartOptions.XYLabels<C,O>

Re-exposes AbstractChartOptions.setYMin(BigDecimal), AbstractChartOptions.setYMax(BigDecimal), AbstractChartOptions.setShowZAxis(Boolean), AbstractChartOptions.setZLabel(String), AbstractChartOptions.setZMin(BigDecimal), AbstractChartOptions.setZMax(BigDecimal), and AbstractChartOptions.setComparison(Boolean) as public, on top of everything ChartOptions.XYLabels exposes; the tier extended by a concrete Options type with a Z axis or period comparison but no X axis bounds, for example BoxplotChart.BoxplotOptions or HistogramChart.HistogramOptions. A sibling of ChartOptions.XYMinMax, not a descendant of it: a concrete Options type extends one or the other, not both.

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
ZAxis(C backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
final O	setComparison(Boolean comparison)	Enables comparing this chart's data against a prior period.
final O	setShowZAxis(Boolean showZAxis)	Shows or hides the chart's secondary Z axis.
final O	setYMax(BigDecimal yMax)	Sets the Y axis' upper bound.
final O	setYMin(BigDecimal yMin)	Sets the Y axis' lower bound.
final O	setZLabel(String zLabel)	Sets the Z axis label.
final O	setZMax(BigDecimal zMax)	Sets the Z axis' upper bound.
final O	setZMin(BigDecimal zMin)	Sets the Z 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, setComparisonType, setDisableDrilldown, setDisableZoom, setMarker, setMaxDataPoints, setXLogarithmic, setXMax, setXMax, setXMin, setXMin, setYLogarithmic, setZLogarithmic

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

ZAxis

public ZAxis(C backLink,
 String instanceId)

Method Details

setYMin

public final O setYMin(BigDecimal yMin)

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<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Parameters:

yMin - the lowest value to show on the Y axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setYMax(BigDecimal)

setYMax

public final O setYMax(BigDecimal yMax)

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<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Parameters:

yMax - the highest value to show on the Y axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setYMin(BigDecimal)

setShowZAxis

public final O setShowZAxis(Boolean showZAxis)

Description copied from class: AbstractChartOptions

Shows or hides the chart's secondary Z axis. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).

Overrides:

setShowZAxis in class AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Parameters:

showZAxis - true to show the Z axis; false or null to hide it

Returns:

this Options object, for chaining further configuration

setZLabel

public final O setZLabel(String zLabel)

Description copied from class: AbstractChartOptions

Sets the Z axis label. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).

Overrides:

setZLabel in class AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Parameters:

zLabel - the label to display on the Z axis

Returns:

this Options object, for chaining further configuration

setZMin

public final O setZMin(BigDecimal zMin)

Description copied from class: AbstractChartOptions

Sets the Z axis' lower bound. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).

Overrides:

setZMin in class AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Parameters:

zMin - the lowest value to show on the Z axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setZMax(BigDecimal)

setZMax

public final O setZMax(BigDecimal zMax)

Description copied from class: AbstractChartOptions

Sets the Z axis' upper bound. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).

Overrides:

setZMax in class AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Parameters:

zMax - the highest value to show on the Z axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setZMin(BigDecimal)

setComparison

public final O setComparison(Boolean comparison)

Description copied from class: AbstractChartOptions

Enables comparing this chart's data against a prior period. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).

Overrides:

setComparison in class AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>

Parameters:

comparison - true to enable period comparison; false or null to disable it

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setComparisonType(ComparisonType)