Package net.pricefx.common.apibuilder.chart

Class BubbleChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<BubbleChart>

BubbleChart

All Implemented Interfaces:

CanDoLogarithmicAxis, CanDrillDown, CanZoom, Portlet, Portlet

public class BubbleChart
extends AbstractChartBuilder<BubbleChart>
implements CanDoLogarithmicAxis, CanDrillDown, CanZoom

Builder for a Bubble Chart, obtained via ChartBuilder.newBubble() rather than instantiated directly. See that factory method for the chart's overall shape (like a ScatterChart, but with a third aggregated measure encoded as marker size) and a Groovy example.

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

See Also:

• ChartBuilder.newBubble()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BubbleChart.BubbleAdditionalMeasure	A further measure on a BubbleChart.BubbleSeries beyond its X axis, Y axis, and bubble size measures, obtained from BubbleChart.BubbleSeries.addAdditionalMeasure() rather than instantiated directly.
class	BubbleChart.BubbleOnChartClick	The click-event builder for a BubbleChart, obtained from onClick() rather than instantiated directly.
static class	BubbleChart.BubbleOptions	The Options for a BubbleChart, obtained from getOptions() rather than instantiated directly.
static class	BubbleChart.BubbleSeries	A single series of a BubbleChart, obtained from addSeries() rather than instantiated directly.
static class	BubbleChart.BubbleSize	The bubble size measure of a BubbleChart.BubbleSeries, obtained from BubbleChart.BubbleSeries.setBubbleSize(String) 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
BubbleChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
AuxLine<BubbleChart>	addAuxLine()	Adds a horizontal, vertical, or stepped reference line to this chart, independent of its data series, for example a fixed target or threshold value.
BubbleChart.BubbleSeries	addSeries()	Adds a new series to this chart.
ChartBuilderResult	build()	Finishes this chart's definition.
boolean	canDoLogarithmicAxis(char xyz)	Reports that this chart's X and Y axes, but not its Z axis, may be rendered on a logarithmic scale.
BubbleChart.BubbleOptions	getOptions()	Returns this chart's Options builder.
BubbleChart.BubbleOnChartClick	onClick()	Configures a click-triggered Dashboard event fired when a user clicks a bubble on this chart.

Methods inherited from class AbstractChartBuilder

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

BubbleChart

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

Method Details

addSeries

public BubbleChart.BubbleSeries addSeries()

Adds a new series to this chart.

Returns:

a new BubbleChart.BubbleSeries for this chart. Never null.

getOptions

public BubbleChart.BubbleOptions 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<BubbleChart>

Returns:

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

addAuxLine

public AuxLine<BubbleChart> addAuxLine()

Adds a horizontal, vertical, or stepped reference line to this chart, independent of its data series, for example a fixed target or threshold value. Call AuxLine.withLine(), AuxLine.withSteppedLine(), or AuxLine.withVerticalLine() on the returned builder to choose the line's shape.

Overrides:

addAuxLine in class AbstractChartBuilder<BubbleChart>

Returns:

a new AuxLine builder for this chart. Never null.

onClick

public BubbleChart.BubbleOnChartClick onClick()

Configures a click-triggered Dashboard event fired when a user clicks a bubble on this chart. Call BubbleChart.BubbleOnChartClick.triggerEvent(String) on the returned builder, then BubbleChart.BubbleOnChartClick.BubbleTriggerEvent.withAggregationByAsEventDataAttr() and/or BubbleChart.BubbleOnChartClick.BubbleTriggerEvent.withBandByAsEventDataAttr() to include the clicked bubble's grouping dimension(s) in the event payload.

Returns:

a new BubbleChart.BubbleOnChartClick builder for this chart. Never null.

See Also:

• Interactive Embedded Dashboards

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.

canDoLogarithmicAxis

public boolean canDoLogarithmicAxis(char xyz)

Reports that this chart's X and Y axes, but not its Z axis, may be rendered on a logarithmic scale.

Specified by:

canDoLogarithmicAxis in interface CanDoLogarithmicAxis

Parameters:

xyz - which axis is being asked about; 'x', 'y', or 'z'

Returns:

true for 'x' or 'y'; false for 'z' or any other value