Package net.pricefx.common.apibuilder.chart

Class BarLineChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<BarLineChart>

BarLineChart

All Implemented Interfaces:

CanDoComparison, CanDoLogarithmicAxis, CanDrillDown, CanZoom, Portlet, Portlet

public class BarLineChart
extends AbstractChartBuilder<BarLineChart>
implements CanDoComparison, CanDoLogarithmicAxis, CanDrillDown, CanZoom

Builder for a Bar & Line Chart, obtained via ChartBuilder.newBarLine() rather than instantiated directly. See that factory method for the chart's overall shape (a category X axis, one or more aggregated Y axis measures) and a Groovy example.

Beyond the axis and series configuration on BarLineChart.BarLineSeries, this chart type supports an embedded boxplot overlay per series, sorting a series by either axis, and comparing this chart's data against a prior period, all configured on BarLineChart.BarLineSeries and BarLineChart.BarLineOptions. Clicking a bar can also fire a Dashboard event via onClick().

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

See Also:

• ChartBuilder.newBarLine()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BarLineChart.BarLineAdditionalMeasure	A further measure on a BarLineChart.BarLineSeries beyond its primary Y axis measure, obtained from BarLineChart.BarLineSeries.addAdditionalMeasure() rather than instantiated directly.
class	BarLineChart.BarLineOnChartClick	The click-event builder for a BarLineChart, obtained from onClick() rather than instantiated directly.
static class	BarLineChart.BarLineOptions	The Options for a BarLineChart, obtained from getOptions() rather than instantiated directly.
static class	BarLineChart.BarLineSeries	A single series of a BarLineChart, 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
BarLineChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
AuxLine<BarLineChart>	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.
BarLineChart.BarLineSeries	addSeries()	Adds a new series to this chart.
ChartBuilderResult	build()	Finishes this chart's definition.
boolean	canDoLogarithmicAxis(char xyz)	Reports that this chart's Y and Z axes, but not its X axis, may be rendered on a logarithmic scale.
BarLineChart.BarLineOptions	getOptions()	Returns this chart's Options builder.
BarLineChart.BarLineOnChartClick	onClick()	Configures a click-triggered Dashboard event fired when a user clicks a bar 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

BarLineChart

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

Method Details

addSeries

public BarLineChart.BarLineSeries addSeries()

Adds a new series to this chart. A Bar & Line Chart can have multiple series, each rendered as its own group of bars or, via ChartSeries.EmbeddedBoxplot.setType(net.pricefx.common.api.chart.SeriesType), a line overlaid on the others.

Returns:

a new BarLineChart.BarLineSeries for this chart. Never null.

getOptions

public BarLineChart.BarLineOptions 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<BarLineChart>

Returns:

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

addAuxLine

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

Returns:

a new AuxLine builder for this chart. Never null.

onClick

public BarLineChart.BarLineOnChartClick onClick()

Configures a click-triggered Dashboard event fired when a user clicks a bar on this chart. Call BarLineChart.BarLineOnChartClick.triggerEvent(String) on the returned builder, then BarLineChart.BarLineOnChartClick.BarLineTriggerEvent.withXAsEventDataAttr() to include the clicked bar's X axis category in the event payload.

Returns:

a new BarLineChart.BarLineOnChartClick 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 Y and Z axes, but not its X 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 'y' or 'z'; false for 'x' or any other value