Package net.pricefx.common.apibuilder.chart

package net.pricefx.common.apibuilder.chart

Fluent builders for chart definitions rendered by the Pricefx user interface. The concrete builder types, for example BarLineChart, PieChart, WaterfallChart, TimeSeriesChart and HeatmapChart, produce Data Analyzer chart definitions backed by the Highcharts library; their methods are mostly equivalent to the Highcharts options described at Highcharts.Chart.

Entry point: obtained through api.newChartBuilder(); see PublicGroovyAPI.newChartBuilder(). The returned ChartBuilder has one factory method per chart type, such as newBarLine(), newPie() or newWaterfall(). A typical chain adds one or more series with addSeries(), configures axes and measures on the series, returns to the parent builder with back(), and finishes with build(). The build result is the object the user interface renders in Dashboard portlets, Quote headers and other areas. A practical starting point is to build the chart in the Data Analyzer user interface and use its View Expression function, which displays the generated builder code for the chart; the generated code can then be refined with these builders.

All chart builders extend AbstractChartBuilder, which carries the portlet layout options (width, height, layout) shared by every chart type. The enums and constants consumed by these builders (chart types, aggregation formulas, filter operators) live in the net.pricefx.common.api.chart package.

See Also:

• View Chart Definition (Pricefx Documentation)

Classes

Class	Description
AbstractChartBuilder<C extends AbstractChartBuilder<C>>	Common base class for every chart definition builder returned by ChartBuilder, such as ScatterChart, TimeSeriesChart, and BarLineChart.
AbstractChartEvent<C extends AbstractChartBuilder<?>,E extends AbstractChartEvent<C,E>>	Common base class for the click-event configuration builders returned by AbstractChartBuilder.onRowClick() and AbstractChartBuilder.onCellClick(), and by each concrete chart type's own onClick() method, for example ScatterChart.onClick().
AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends AbstractChartMeasures<S,M>>	Common base class for the "additional measure" builders returned by a concrete series type's own addAdditionalMeasure() method, for example ScatterChart.ScatterAdditionalMeasure or BarLineChart.BarLineAdditionalMeasure.
AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends AbstractChartOptions<C,O>>	Common base class for the Options object returned by every chart type's AbstractChartBuilder.getOptions(), for example ScatterChart.ScatterOptions or BarLineChart.BarLineOptions.
AbstractChartSeries<C extends AbstractChartBuilder<C>,S extends AbstractChartSeries<C,S>>	Common base class for the series builders returned by every chart type's addSeries() or getSeries() method, for example ScatterChart.ScatterSeries or BarLineChart.BarLineSeries.
AuxLine<C extends AbstractChartBuilder<C>>	Builder for an auxiliary reference line on a chart, obtained from AbstractChartBuilder.addAuxLine() rather than instantiated directly.
AuxLine.Line<C extends ObjectIdentity>	A straight AuxLine shape, y = yIntercept + steepness * x, obtained from AuxLine.withLine() rather than instantiated directly.
AuxLine.SteppedLine<C extends ObjectIdentity>	A piecewise AuxLine shape defined by explicit (X, Y) points, obtained from AuxLine.withSteppedLine() rather than instantiated directly.
AuxLine.VerticalLine<C extends ObjectIdentity>	A single vertical AuxLine shape at a fixed X axis value, obtained from AuxLine.withVerticalLine() rather than instantiated directly.
BarLineChart	Builder for a Bar & Line Chart, obtained via ChartBuilder.newBarLine() rather than instantiated directly.
BarLineChart.BarLineAdditionalMeasure	A further measure on a BarLineChart.BarLineSeries beyond its primary Y axis measure, obtained from BarLineChart.BarLineSeries.addAdditionalMeasure() rather than instantiated directly.
BarLineChart.BarLineOptions	The Options for a BarLineChart, obtained from BarLineChart.getOptions() rather than instantiated directly.
BarLineChart.BarLineSeries	A single series of a BarLineChart, obtained from BarLineChart.addSeries() rather than instantiated directly.
BoxplotChart	Builder for a Box Plot Chart, obtained via ChartBuilder.newBoxplot() rather than instantiated directly.
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.
BoxplotChart.BoxplotOptions	The Options for a BoxplotChart, obtained from BoxplotChart.getOptions() rather than instantiated directly.
BoxplotChart.BoxplotSeries	A single series of a BoxplotChart, obtained from BoxplotChart.addSeries() rather than instantiated directly.
BubbleChart	Builder for a Bubble Chart, obtained via ChartBuilder.newBubble() rather than instantiated directly.
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.
BubbleChart.BubbleOptions	The Options for a BubbleChart, obtained from BubbleChart.getOptions() rather than instantiated directly.
BubbleChart.BubbleSeries	A single series of a BubbleChart, obtained from BubbleChart.addSeries() rather than instantiated directly.
BubbleChart.BubbleSize	The bubble size measure of a BubbleChart.BubbleSeries, obtained from BubbleChart.BubbleSeries.setBubbleSize(String) rather than instantiated directly.
ChartBuilder
ChartEvents	Namespace holding the concrete click-event builders for chart Dashboard events: ChartEvents.OnChartClick (a chart-type-specific onClick(), for example ScatterChart.onClick()), ChartEvents.OnRowClick (from AbstractChartBuilder.onRowClick()), and ChartEvents.OnCellClick (from AbstractChartBuilder.onCellClick()).
ChartEvents.OnCellClick<C extends AbstractChartBuilder<?>>	The click-event builder for a cell click on a chart's Data tab, obtained from AbstractChartBuilder.onCellClick() rather than instantiated directly.
ChartEvents.OnChartClick<C extends AbstractChartBuilder<?>,E extends ChartEvents.OnChartClick<C,E>>	Base class for a chart-type-specific onClick() click-event builder, for example ScatterChart.ScatterOnChartClick or BarLineChart.BarLineOnChartClick.
ChartEvents.OnRowClick<C extends AbstractChartBuilder<?>>	The click-event builder for a row click on a chart's Data tab, obtained from AbstractChartBuilder.onRowClick() rather than instantiated directly.
ChartMeasures	Namespace holding the three intermediate tiers that select which of AbstractChartMeasures' optional methods a concrete additional-measure type re-exposes as public: ChartMeasures.Basic (aggregation formula selection), ChartMeasures.Type (adds per-measure rendering type and Z axis placement, extends Basic), and ChartMeasures.EmbeddedBoxplot (adds embedded boxplot overlay support, extends Type).
ChartMeasures.Basic<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>	Re-exposes AbstractChartMeasures.withAggregation(String), AbstractChartMeasures.withAggregation(net.pricefx.common.api.chart.AggregationFormula), AbstractChartMeasures.withFormula(), AbstractChartMeasures.withPercent(), AbstractChartMeasures.withPerUnit(), AbstractChartMeasures.withAverage(), and AbstractChartMeasures.withTotal() as public; the tier extended by a concrete additional-measure type that supports none of ChartMeasures.Type's or ChartMeasures.EmbeddedBoxplot's further options, for example ScatterChart.ScatterAdditionalMeasure or PieChart.PieAdditionalMeasure.
ChartMeasures.EmbeddedBoxplot<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.EmbeddedBoxplot<S,M>>	Re-exposes AbstractChartMeasures.withBoxplotField() and AbstractChartMeasures.withBoxplotExpression() as public, on top of everything ChartMeasures.Type exposes; the tier extended by a concrete additional-measure type whose series supports an embedded box plot overlay, for example BarLineChart.BarLineAdditionalMeasure or TimeSeriesChart.TimeSeriesAdditionalMeasure.
ChartMeasures.Type<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Type<S,M>>	Re-exposes AbstractChartMeasures.setType(net.pricefx.common.api.chart.SeriesType) and AbstractChartMeasures.setOnZAxis(Boolean) as public, on top of everything ChartMeasures.Basic exposes; the tier extended by a concrete additional-measure type that can render itself differently from its series' primary measure or plot itself on a Z axis, for example HistogramChart.HistogramAdditionalMeasure or DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure.
ChartOptions	Namespace holding the five intermediate tiers that select which of AbstractChartOptions' optional methods a concrete chart type's Options class re-exposes as public: ChartOptions.Basic (title, subtitle, legend, tooltips), ChartOptions.XYLabels (adds X/Y axis labels, extends Basic), ChartOptions.XYMinMax (adds X/Y numeric bounds, extends XYLabels), ChartOptions.ZAxis (adds Y bounds, a Z axis, and period comparison, extends XYLabels independently of XYMinMax), and ChartOptions.EmbeddedBoxplot (adds embedded boxplot axis bounds, extends ZAxis).
ChartOptions.Basic<C extends AbstractChartBuilder<C>,O extends ChartOptions.Basic<C,O>>	Re-exposes AbstractChartOptions.setTitle(String), AbstractChartOptions.setSubtitle(String), AbstractChartOptions.setHideLegend(Boolean), and AbstractChartOptions.setHideTooltips(Boolean) as public; the tier extended by a concrete Options type that supports none of this class's more specific tiers, for example WaterfallChart.WaterfallOptions or WaterfallComparisonChart.WaterfallComparisonOptions.
ChartOptions.EmbeddedBoxplot<C extends AbstractChartBuilder<C>,O extends ChartOptions.EmbeddedBoxplot<C,O>>	Re-exposes AbstractChartOptions.setBoxplotAxisLabel(String), AbstractChartOptions.setBoxplotAxisMin(BigDecimal), and AbstractChartOptions.setBoxplotAxisMax(BigDecimal) as public, on top of everything ChartOptions.ZAxis exposes; the tier extended by a concrete Options type whose series supports an embedded box plot overlay, for example BarLineChart.BarLineOptions or TimeSeriesChart.TimeSeriesOptions.
ChartOptions.XYLabels<C extends AbstractChartBuilder<C>,O extends ChartOptions.XYLabels<C,O>>	Re-exposes AbstractChartOptions.setXLabel(String) and AbstractChartOptions.setYLabel(String) as public, on top of everything ChartOptions.Basic exposes; the tier extended by a concrete Options type that labels its X and Y axes but supports neither ChartOptions.XYMinMax's nor ChartOptions.ZAxis's further bounds, for example HeatmapChart.HeatmapOptions or PieChart.PieOptions.
ChartOptions.XYMinMax<C extends AbstractChartBuilder<C>,O extends ChartOptions.XYMinMax<C,O>>	Re-exposes AbstractChartOptions.setXMin(BigDecimal), AbstractChartOptions.setXMax(BigDecimal), AbstractChartOptions.setYMin(BigDecimal), and AbstractChartOptions.setYMax(BigDecimal) as public, on top of everything ChartOptions.XYLabels exposes; the tier extended by a concrete Options type whose X and Y axes are both plain numeric scales worth bounding, for example ScatterChart.ScatterOptions or BubbleChart.BubbleOptions.
ChartOptions.ZAxis<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>>	Re-exposes AbstractChartOptions.setYMin(BigDecimal), AbstractChartOptions.setYMax(BigDecimal), AbstractChartOptions.setShowZAxis(Boolean), AbstractChartOptions.setZLabel(String), AbstractChartOptions.setZMin(BigDecimal), AbstractChartOptions.setZMax(BigDecimal), and AbstractChartOptions.setComparison(Boolean) as public, on top of everything ChartOptions.XYLabels exposes; the tier extended by a concrete Options type with a Z axis or period comparison but no X axis bounds, for example BoxplotChart.BoxplotOptions or HistogramChart.HistogramOptions.
ChartSeries	Namespace holding the three intermediate tiers that select which of AbstractChartSeries' optional methods a concrete series type re-exposes as public: ChartSeries.Basic (the methods common to nearly every series), ChartSeries.EmbeddedBoxplot (adds an embedded boxplot overlay, extends Basic), and ChartSeries.Aggregation (adds aggregation-by/band-by grouping, also extends Basic).
ChartSeries.Aggregation<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>	Re-exposes AbstractChartSeries.setAggregationBy(String), AbstractChartSeries.setBandBy(String), and AbstractChartSeries.setShowBandByLegend(Boolean) as public, and adds ChartSeries.Aggregation.getBandByOptions(); the tier extended by a concrete series type that supports aggregation-by and band-by grouping, for example ScatterChart.ScatterSeries or BubbleChart.BubbleSeries.
ChartSeries.Basic<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>	Re-exposes AbstractChartSeries.setHideDataLabels(Boolean) as public; the tier extended by a concrete series type that supports hiding data labels but none of ChartSeries.EmbeddedBoxplot's or ChartSeries.Aggregation's further options.
ChartSeries.EmbeddedBoxplot<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>>	Re-exposes AbstractChartSeries.setType(SeriesType), AbstractChartSeries.setShowBoxplot(Boolean), AbstractChartSeries.setBoxplotAxis(), and AbstractChartSeries.setWhisker(WhiskerType) as public; the tier extended by a concrete series type that supports an embedded box plot overlay, for example BarLineChart.BarLineSeries or TimeSeriesChart.TimeSeriesSeries.
DataTableChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
DataTableChart.DataTableAdditionalMeasure
DataTableChart.DataTableOptions
DataTableChart.DataTableSeries
DetailedTimeSeriesChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure
DetailedTimeSeriesChart.DetailedTimeSeriesOptions
DetailedTimeSeriesChart.DetailedTimeSeriesSeries
Dictionary<C extends AbstractChartBuilder<C>>	Builder for a chart's Dictionary, the Data Analyzer panel that controls formatting of dates, numbers, and other display labels (see the Dictionary option in the Data Analyzer UI), obtained from AbstractChartBuilder.getDictionary() rather than instantiated directly.
Expression<O extends ObjectIdentity>
Filters<O extends ObjectIdentity>
Formula<S extends AbstractChartSeries<?,S>>
HeatmapChart	Builder for a Heatmap, obtained via ChartBuilder.newHeatmap() rather than instantiated directly.
HeatmapChart.HeatmapAdditionalMeasure	A further measure on a HeatmapChart.HeatmapSeries beyond its color axis measure, obtained from HeatmapChart.HeatmapSeries.addAdditionalMeasure() rather than instantiated directly.
HeatmapChart.HeatmapInterpolatedColorAxis	Builder for a HeatmapChart's continuous color gradient (ColorAxisType.INTERPOLATED), obtained from HeatmapChart.HeatmapOptions.withInterpolatedColorAxis() rather than instantiated directly.
HeatmapChart.HeatmapOptions	The Options for a HeatmapChart, obtained from HeatmapChart.getOptions() rather than instantiated directly.
HeatmapChart.HeatmapRangedColorAxis	Builder for a HeatmapChart's discrete, banded color axis (ColorAxisType.RANGED), obtained from HeatmapChart.HeatmapOptions.withRangedColorAxis() rather than instantiated directly.
HeatmapChart.HeatmapSeries	The single series of a HeatmapChart, obtained from HeatmapChart.getSeries() rather than instantiated directly.
HistogramChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
HistogramChart.HistogramAdditionalMeasure
HistogramChart.HistogramOptions
HistogramChart.HistogramSeries
LimitToMeasure<S extends AbstractChartSeries<?,S>>
NonAggrFieldAxis<S extends AbstractChartSeries<?,S>>
PieChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
PieChart.PieAdditionalMeasure
PieChart.PieOptions
PieChart.PieSeries
PieChart.Size
ScatterChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
ScatterChart.ScatterAdditionalMeasure
ScatterChart.ScatterOptions
ScatterChart.ScatterSeries
TimeSeriesChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
TimeSeriesChart.TimeSeriesAdditionalMeasure
TimeSeriesChart.TimeSeriesOptions
TimeSeriesChart.TimeSeriesSeries
TimeSeriesScatterChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
TimeSeriesScatterChart.TimeSeriesScatterAdditionalMeasure
TimeSeriesScatterChart.TimeSeriesScatterOptions
TimeSeriesScatterChart.TimeSeriesScatterSeries
TrendLine<S extends AbstractChartSeries<?,?>>
WaterfallChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
WaterfallChart.Aggregation
WaterfallChart.WaterfallOptions
WaterfallChart.WaterfallSeries
WaterfallComparisonChart	Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.
WaterfallComparisonChart.Aggregation
WaterfallComparisonChart.WaterfallComparisonOptions
WaterfallComparisonChart.WaterfallComparisonSeries