Package net.pricefx.common.apibuilder.chart

Class ScatterChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<ScatterChart>

ScatterChart

All Implemented Interfaces:

CanDoLogarithmicAxis, CanDrillDown, CanZoom, Portlet, Portlet

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

Builder for a Scatter Chart, obtained via ChartBuilder.newScatter() rather than instantiated directly. See that factory method for how this chart plots two independent measures against each other 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.newScatter()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScatterChart.ScatterAdditionalMeasure	A measure column on a ScatterChart.ScatterSeries, obtained from ScatterChart.ScatterSeries.addAdditionalMeasure() rather than instantiated directly.
class	ScatterChart.ScatterOnChartClick	The click-event builder for a ScatterChart, obtained from onClick() rather than instantiated directly.
static class	ScatterChart.ScatterOptions	The Options for a ScatterChart, obtained from getOptions() rather than instantiated directly.
static class	ScatterChart.ScatterSeries	A single series of a ScatterChart, obtained from addSeries() rather than instantiated directly.

Field Summary

Fields

Modifier and Type	Field	Description
protected ScatterChart.ScatterOptions	options

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
ScatterChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
AuxLine<ScatterChart>	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.
ScatterChart.ScatterSeries	addSeries()	Adds a new series to this chart.
ChartBuilderResult	build()	Finishes this chart's definition.
boolean	canDoLogarithmicAxis(char xyz)
ScatterChart.ScatterOptions	getOptions()	Returns this chart's Options builder.
ScatterChart.ScatterOnChartClick	onClick()	Configures a click-triggered Dashboard event fired when a user clicks a point 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

Field Details

options

protected ScatterChart.ScatterOptions options

Constructor Details

ScatterChart

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

Method Details

addSeries

public ScatterChart.ScatterSeries addSeries()

Adds a new series to this chart.

Returns:

a new ScatterChart.ScatterSeries for this chart. Never null.

getOptions

public ScatterChart.ScatterOptions 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<ScatterChart>

Returns:

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

addAuxLine

public AuxLine<ScatterChart> 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<ScatterChart>

Returns:

a new AuxLine builder for this chart. Never null.

onClick

public ScatterChart.ScatterOnChartClick onClick()

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

Returns:

a new ScatterChart.ScatterOnChartClick 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 Data Analyzer areas render.

Specified by:

build in class AbstractBuilder

Returns:

the finished chart definition. Never null.

canDoLogarithmicAxis

public boolean canDoLogarithmicAxis(char xyz)

Specified by:

canDoLogarithmicAxis in interface CanDoLogarithmicAxis