Package net.pricefx.common.apibuilder.chart
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:
-
ClassesClassDescriptionAbstractChartBuilder<C extends AbstractChartBuilder<C>>AuxLine<C extends AbstractChartBuilder<C>>AuxLine.Line<C extends ObjectIdentity>AuxLine.SteppedLine<C extends ObjectIdentity>AuxLine.VerticalLine<C extends ObjectIdentity>Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods, described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.ChartEvents.OnCellClick<C extends AbstractChartBuilder<?>>ChartEvents.OnRowClick<C extends AbstractChartBuilder<?>>ChartMeasures.EmbeddedBoxplot<S extends AbstractChartSeries<?,
S>, M extends ChartMeasures.EmbeddedBoxplot<S, M>> ChartOptions.EmbeddedBoxplot<C extends AbstractChartBuilder<C>,O extends ChartOptions.EmbeddedBoxplot<C, O>> Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Dictionary<C extends AbstractChartBuilder<C>>Expression<O extends ObjectIdentity>Filters<O extends ObjectIdentity>Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.