Package net.pricefx.common.apibuilder.chart

Class HeatmapChart.HeatmapRangedColorAxis

Object

ObjectIdentity

BacklinkBuilder<HeatmapChart.HeatmapOptions>

HeatmapRangedColorAxis

Enclosing class:

HeatmapChart

public static class HeatmapChart.HeatmapRangedColorAxis
extends BacklinkBuilder<HeatmapChart.HeatmapOptions>

Builder for a HeatmapChart's discrete, banded color axis (ColorAxisType.RANGED), obtained from HeatmapChart.HeatmapOptions.withRangedColorAxis() 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
HeatmapRangedColorAxis(HeatmapChart.HeatmapOptions backLink, String instanceId, String classId)

Method Summary

Modifier and Type	Method	Description
HeatmapChart.HeatmapRangedColorAxis	addRange(String color, BigDecimal from, BigDecimal to)	Adds one discrete color band covering the given value range.

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

HeatmapRangedColorAxis

public HeatmapRangedColorAxis(HeatmapChart.HeatmapOptions backLink,
 String instanceId,
 String classId)

Method Details

addRange

public HeatmapChart.HeatmapRangedColorAxis addRange(String color,
 BigDecimal from,
 BigDecimal to)

Adds one discrete color band covering the given value range. Call this once per band; bands are typically added in ascending order to cover the color axis measure's full range.

Parameters:

color - the color to use for cells whose color axis value falls in this band

from - the band's lower bound

to - the band's upper bound

Returns:

this builder, for chaining further bands