Package net.pricefx.common.apibuilder.chart

Class HeatmapChart.HeatmapOptions

Object

ObjectIdentity

BacklinkBuilder<HeatmapChart>

AbstractChartOptions<HeatmapChart,HeatmapChart.HeatmapOptions>

ChartOptions.Basic<HeatmapChart,HeatmapChart.HeatmapOptions>

ChartOptions.XYLabels<HeatmapChart,HeatmapChart.HeatmapOptions>

HeatmapOptions

Enclosing class:

HeatmapChart

public static class HeatmapChart.HeatmapOptions
extends ChartOptions.XYLabels<HeatmapChart,HeatmapChart.HeatmapOptions>

The Options for a HeatmapChart, obtained from HeatmapChart.getOptions() rather than instantiated directly. In addition to the usual title, legend, and axis label settings, this is where the color axis' rendering (discrete bands vs. a continuous gradient) is configured.

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
HeatmapOptions(HeatmapChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
HeatmapChart.HeatmapOptions	setColorAxisType(ColorAxisType colorAxisType)	Sets how the color axis maps values to color: as discrete bands (ColorAxisType.RANGED, configured via withRangedColorAxis()), as a continuous gradient (ColorAxisType.INTERPOLATED, configured via withInterpolatedColorAxis()), or the Data Analyzer's automatic default (ColorAxisType.DEFAULT).
HeatmapChart.HeatmapOptions	setDisableDrilldown(Boolean disableDrilldown)	Disables drilldown on this chart.
HeatmapChart.HeatmapOptions	setDisableZoom(Boolean disableZoom)	Disables zooming on this chart.
HeatmapChart.HeatmapOptions	setZMax(BigDecimal zMax)	Sets the Z axis' upper bound.
HeatmapChart.HeatmapOptions	setZMin(BigDecimal zMin)	Sets the Z axis' lower bound.
HeatmapChart.HeatmapInterpolatedColorAxis	withInterpolatedColorAxis()	Returns the builder for a continuous color gradient.
HeatmapChart.HeatmapRangedColorAxis	withRangedColorAxis()	Returns the builder for a discrete, banded color axis.

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, setMarker, setMaxDataPoints, setShowZAxis, setXLogarithmic, setXMax, setXMax, setXMin, setXMin, setYLogarithmic, setYMax, setYMin, setZLabel, 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

HeatmapOptions

public HeatmapOptions(HeatmapChart backLink,
 String instanceId)

Method Details

setDisableDrilldown

public HeatmapChart.HeatmapOptions 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<HeatmapChart,HeatmapChart.HeatmapOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration

setDisableZoom

public HeatmapChart.HeatmapOptions 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<HeatmapChart,HeatmapChart.HeatmapOptions>

Parameters:

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

Returns:

this Options object, for chaining further configuration

setZMin

public HeatmapChart.HeatmapOptions 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<HeatmapChart,HeatmapChart.HeatmapOptions>

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 HeatmapChart.HeatmapOptions 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<HeatmapChart,HeatmapChart.HeatmapOptions>

Parameters:

zMax - the highest value to show on the Z axis

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setZMin(BigDecimal)

setColorAxisType

public HeatmapChart.HeatmapOptions setColorAxisType(ColorAxisType colorAxisType)

Sets how the color axis maps values to color: as discrete bands (ColorAxisType.RANGED, configured via withRangedColorAxis()), as a continuous gradient (ColorAxisType.INTERPOLATED, configured via withInterpolatedColorAxis()), or the Data Analyzer's automatic default (ColorAxisType.DEFAULT).

Parameters:

colorAxisType - the color axis rendering mode to use

Returns:

this Options object, for chaining further configuration

withRangedColorAxis

public HeatmapChart.HeatmapRangedColorAxis withRangedColorAxis()

Returns the builder for a discrete, banded color axis. Call HeatmapChart.HeatmapRangedColorAxis.addRange(String, java.math.BigDecimal, java.math.BigDecimal) on the returned builder once per color band.

Returns:

a new HeatmapChart.HeatmapRangedColorAxis builder. Never null.

See Also:

• setColorAxisType(ColorAxisType)
• withInterpolatedColorAxis()

withInterpolatedColorAxis

public HeatmapChart.HeatmapInterpolatedColorAxis withInterpolatedColorAxis()

Returns the builder for a continuous color gradient. Call HeatmapChart.HeatmapInterpolatedColorAxis.addStop(String, Integer) on the returned builder once per gradient stop.

Returns:

a new HeatmapChart.HeatmapInterpolatedColorAxis builder. Never null.

See Also:

• setColorAxisType(ColorAxisType)
• withRangedColorAxis()