Package net.pricefx.common.apibuilder.chart

Class BarLineChart.BarLineOptions

Object

ObjectIdentity

BacklinkBuilder<BarLineChart>

AbstractChartOptions<BarLineChart,BarLineChart.BarLineOptions>

ChartOptions.Basic<BarLineChart,BarLineChart.BarLineOptions>

ChartOptions.XYLabels<BarLineChart,BarLineChart.BarLineOptions>

ChartOptions.ZAxis<BarLineChart,BarLineChart.BarLineOptions>

ChartOptions.EmbeddedBoxplot<BarLineChart,BarLineChart.BarLineOptions>

BarLineOptions

Enclosing class:

BarLineChart

public static class BarLineChart.BarLineOptions
extends ChartOptions.EmbeddedBoxplot<BarLineChart,BarLineChart.BarLineOptions>

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

Method Summary

Modifier and Type	Method	Description
BarLineChart.BarLineOptions	setComparisonType(ComparisonType comparisonType)	Sets how the compared prior period, enabled with AbstractChartOptions.setComparison(Boolean), is chosen.
BarLineChart.BarLineOptions	setDisableDrilldown(Boolean disableDrilldown)	Disables drilldown on this chart.
BarLineChart.BarLineOptions	setDisableZoom(Boolean disableZoom)	Disables zooming on this chart.
BarLineChart.BarLineOptions	setMaxDataPoints(BigDecimal maximumNumberOfDataPoints)	Limits how many data points this chart renders.
BarLineChart.BarLineOptions	setYLogarithmic(boolean enable)	Renders the Y axis on a logarithmic scale.
BarLineChart.BarLineOptions	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, setMarker, 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

BarLineOptions

public BarLineOptions(BarLineChart backLink,
 String instanceId)

Method Details

setDisableDrilldown

public BarLineChart.BarLineOptions 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<BarLineChart,BarLineChart.BarLineOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration

setDisableZoom

public BarLineChart.BarLineOptions 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<BarLineChart,BarLineChart.BarLineOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration

setComparisonType

public BarLineChart.BarLineOptions 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<BarLineChart,BarLineChart.BarLineOptions>

Parameters:

comparisonType - the kind of prior period to compare against

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setComparison(Boolean)

setMaxDataPoints

public BarLineChart.BarLineOptions setMaxDataPoints(BigDecimal maximumNumberOfDataPoints)

Description copied from class: AbstractChartOptions

Limits how many data points this chart renders. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example BarLineChart.BarLineOptions, PieChart.PieOptions, or BoxplotChart.BoxplotOptions.

Overrides:

setMaxDataPoints in class AbstractChartOptions<BarLineChart,BarLineChart.BarLineOptions>

Parameters:

maximumNumberOfDataPoints - the maximum number of data points to render

Returns:

this Options object, for chaining further configuration

setYLogarithmic

public BarLineChart.BarLineOptions 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<BarLineChart,BarLineChart.BarLineOptions>

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 BarLineChart.BarLineOptions 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<BarLineChart,BarLineChart.BarLineOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration