Package net.pricefx.common.apibuilder.chart

Class HeatmapChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<HeatmapChart>

HeatmapChart

All Implemented Interfaces:

CanDrillDown, CanZoom, Portlet, Portlet

public class HeatmapChart
extends AbstractChartBuilder<HeatmapChart>
implements CanDrillDown, CanZoom

Builder for a Heatmap, obtained via ChartBuilder.newHeatmap() rather than instantiated directly. See that factory method for the chart's overall shape (a two-category grid whose cell color comes from a separate aggregated color axis) and a Groovy example.

Unlike other chart types, a Heatmap has exactly one series, on HeatmapChart.HeatmapSeries, and its color axis can be configured as discrete color bands or a continuous gradient via HeatmapChart.HeatmapOptions.

Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.

See Also:

• ChartBuilder.newHeatmap()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeatmapChart.HeatmapAdditionalMeasure	A further measure on a HeatmapChart.HeatmapSeries beyond its color axis measure, obtained from HeatmapChart.HeatmapSeries.addAdditionalMeasure() rather than instantiated directly.
static class	HeatmapChart.HeatmapInterpolatedColorAxis	Builder for a HeatmapChart's continuous color gradient (ColorAxisType.INTERPOLATED), obtained from HeatmapChart.HeatmapOptions.withInterpolatedColorAxis() rather than instantiated directly.
static class	HeatmapChart.HeatmapOptions	The Options for a HeatmapChart, obtained from getOptions() rather than instantiated directly.
static class	HeatmapChart.HeatmapRangedColorAxis	Builder for a HeatmapChart's discrete, banded color axis (ColorAxisType.RANGED), obtained from HeatmapChart.HeatmapOptions.withRangedColorAxis() rather than instantiated directly.
static class	HeatmapChart.HeatmapSeries	The single series of a HeatmapChart, obtained from getSeries() rather than instantiated directly.

Field Summary

Fields inherited from class AbstractChartBuilder

dragDropEnabled, layout, messages, queryBuilderState, resizingEnabled

Fields inherited from class AbstractBuilder

METHOD_BUILD

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Fields inherited from interface Portlet

UNIT_GRID, UNIT_PX

Constructor Summary

Constructors

Constructor	Description
HeatmapChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
ChartBuilderResult	build()	Finishes this chart's definition.
HeatmapChart.HeatmapOptions	getOptions()	Returns this chart's Options builder.
HeatmapChart.HeatmapSeries	getSeries()	Returns this chart's single series, creating it on first call.

Methods inherited from class AbstractChartBuilder

addAuxLine, addInvocation, build, fromQueryBuilderState, getDictionary, getThis, invokeAddSeries, invokeGetOptions, invokeGetSeries, layout, onCellClick, onRowClick, value, withDragDrop, withError, withHeight, withHeight, withInfo, withLabelOverride, withLayout, withLayout, withLayout, withResizing, withTab, withWarning, withWidth, withWidth

Methods inherited from class ObjectIdentity

addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HeatmapChart

public HeatmapChart(IdGenerator idGenerator,
 Invocations<MethodInvocation> invocations)

Method Details

getSeries

public HeatmapChart.HeatmapSeries getSeries()

Returns this chart's single series, creating it on first call. Unlike most chart types, a Heatmap has exactly one series rather than a list added via an addSeries() method.

Returns:

this chart's HeatmapChart.HeatmapSeries. Never null.

getOptions

public HeatmapChart.HeatmapOptions getOptions()

Description copied from class: AbstractChartBuilder

Returns this chart's Options builder. Each concrete chart type declares its own Options subclass (for example ScatterChart.ScatterOptions, BarLineChart.BarLineOptions) exposing the settings that apply to that chart type, such as title, subtitle, and axis label and bound overrides; the exact set of available options differs per chart type, which is why this method is declared abstract here rather than implemented once for every chart.

Specified by:

getOptions in class AbstractChartBuilder<HeatmapChart>

Returns:

this chart's type-specific AbstractChartOptions instance. Never null.

build

public ChartBuilderResult build()

Finishes this chart's definition. The returned object is what Dashboard portlets, quote headers, and other areas render.

Specified by:

build in class AbstractBuilder

Returns:

the finished chart definition. Never null.