Package net.pricefx.common.apibuilder.chart

Class BoxplotChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<BoxplotChart>

BoxplotChart

All Implemented Interfaces:

CanDoComparison, CanDrillDown, CanZoom, Portlet, Portlet

public class BoxplotChart
extends AbstractChartBuilder<BoxplotChart>
implements CanDoComparison, CanDrillDown, CanZoom

Builder for a Box Plot Chart, obtained via ChartBuilder.newBoxplot() rather than instantiated directly. See that factory method for the chart's overall shape (a plain category X axis and a Box Plot expression Y axis supplying each category's statistical distribution) 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.newBoxplot()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BoxplotChart.BoxplotAdditionalMeasure	A further measure on a BoxplotChart.BoxplotSeries beyond its primary Y axis Box Plot expression, obtained from BoxplotChart.BoxplotSeries.addAdditionalMeasure() rather than instantiated directly.
static class	BoxplotChart.BoxplotOptions	The Options for a BoxplotChart, obtained from getOptions() rather than instantiated directly.
static class	BoxplotChart.BoxplotSeries	A single series of a BoxplotChart, obtained from addSeries() 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
BoxplotChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
AuxLine<BoxplotChart>	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.
BoxplotChart.BoxplotSeries	addSeries()	Adds a new series to this chart.
ChartBuilderResult	build()	Finishes this chart's definition.
BoxplotChart.BoxplotOptions	getOptions()	Returns this chart's Options builder.

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

BoxplotChart

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

Method Details

addSeries

public BoxplotChart.BoxplotSeries addSeries()

Adds a new series to this chart.

Returns:

a new BoxplotChart.BoxplotSeries for this chart. Never null.

getOptions

public BoxplotChart.BoxplotOptions 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<BoxplotChart>

Returns:

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

addAuxLine

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

Returns:

a new AuxLine builder for this chart. 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.