Uses of Package
net.pricefx.common.apibuilder.chart

Packages that use net.pricefx.common.apibuilder.chart

Package	Description
net.pricefx.common.apibuilder.chart	Fluent builders for chart definitions rendered by the Pricefx user interface.
net.pricefx.formulaengine	Formula engine interfaces exposed to Groovy logics.
net.pricefx.formulaengine.scripting	Root package of the public Groovy API available to Pricefx logics.

Classes in net.pricefx.common.apibuilder.chart used by net.pricefx.common.apibuilder.chart

Class	Description
AbstractChartBuilder	Common base class for every chart definition builder returned by ChartBuilder, such as ScatterChart, TimeSeriesChart, and BarLineChart.
AbstractChartEvent	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().
AbstractChartEvent.TriggerEvent	Base class for the event-payload builders returned by a concrete AbstractChartEvent.triggerEvent(String) implementation, for example ChartEvents.OnRowClick.RowClickTriggerEvent.
AbstractChartMeasures	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	Common base class for the Options object returned by every chart type's AbstractChartBuilder.getOptions(), for example ScatterChart.ScatterOptions or BarLineChart.BarLineOptions.
AbstractChartSeries	Common base class for the series builders returned by every chart type's addSeries() or getSeries() method, for example ScatterChart.ScatterSeries or BarLineChart.BarLineSeries.
AggrFieldAxis
AuxLine	Builder for an auxiliary reference line on a chart, obtained from AbstractChartBuilder.addAuxLine() rather than instantiated directly.
AuxLine.Line	A straight AuxLine shape, y = yIntercept + steepness * x, obtained from AuxLine.withLine() rather than instantiated directly.
AuxLine.SteppedLine	A piecewise AuxLine shape defined by explicit (X, Y) points, obtained from AuxLine.withSteppedLine() rather than instantiated directly.
AuxLine.VerticalLine	A single vertical AuxLine shape at a fixed X axis value, obtained from AuxLine.withVerticalLine() rather than instantiated directly.
BandByOptions
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.BarLineOnChartClick	The click-event builder for a BarLineChart, obtained from BarLineChart.onClick() rather than instantiated directly.
BarLineChart.BarLineOnChartClick.BarLineTriggerEvent	The event-payload builder for a bar click on a BarLineChart, obtained from BarLineChart.BarLineOnChartClick.triggerEvent(String) 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.BubbleOnChartClick	The click-event builder for a BubbleChart, obtained from BubbleChart.onClick() rather than instantiated directly.
BubbleChart.BubbleOnChartClick.BubbleTriggerEvent	The event-payload builder for a bubble click on a BubbleChart, obtained from BubbleChart.BubbleOnChartClick.triggerEvent(String) 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.
ChartBuilderResult
ChartEvents.OnCellClick	The click-event builder for a cell click on a chart's Data tab, obtained from AbstractChartBuilder.onCellClick() rather than instantiated directly.
ChartEvents.OnCellClick.CellClickTriggerEvent	The event-payload builder for a cell click, obtained from ChartEvents.OnCellClick.triggerEvent(String) rather than instantiated directly.
ChartEvents.OnChartClick	Base class for a chart-type-specific onClick() click-event builder, for example ScatterChart.ScatterOnChartClick or BarLineChart.BarLineOnChartClick.
ChartEvents.OnChartClick.ClickTriggerEvent	Base class for the event-payload builder returned by a chart-type-specific AbstractChartEvent.triggerEvent(String), for example ScatterChart.ScatterOnChartClick.ScatterTriggerEvent or BarLineChart.BarLineOnChartClick.BarLineTriggerEvent.
ChartEvents.OnRowClick	The click-event builder for a row click on a chart's Data tab, obtained from AbstractChartBuilder.onRowClick() rather than instantiated directly.
ChartEvents.OnRowClick.RowClickTriggerEvent	The event-payload builder for a row click, obtained from ChartEvents.OnRowClick.triggerEvent(String) rather than instantiated directly.
ChartMeasures.Basic	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	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	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.Basic	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	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	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	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	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.Aggregation	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	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	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	Builder for a Data Table, obtained via ChartBuilder.newDataTable() rather than instantiated directly.
DataTableChart.DataTableAdditionalMeasure	A measure column on a DataTableChart.DataTableSeries, obtained from DataTableChart.DataTableSeries.addAdditionalMeasure() rather than instantiated directly.
DataTableChart.DataTableOptions	The Options for a DataTableChart, obtained from DataTableChart.getOptions() rather than instantiated directly.
DataTableChart.DataTableSeries	A single series of a DataTableChart, obtained from DataTableChart.addSeries() rather than instantiated directly.
DetailedTimeSeriesChart	Builder for a Detailed Time Series Chart, obtained via ChartBuilder.newDetailedTimeSeries() rather than instantiated directly.
DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure	A measure column on a DetailedTimeSeriesChart.DetailedTimeSeriesSeries, obtained from DetailedTimeSeriesChart.DetailedTimeSeriesSeries.addAdditionalMeasure() rather than instantiated directly.
DetailedTimeSeriesChart.DetailedTimeSeriesOptions	The Options for a DetailedTimeSeriesChart, obtained from DetailedTimeSeriesChart.getOptions() rather than instantiated directly.
DetailedTimeSeriesChart.DetailedTimeSeriesSeries	A single series of a DetailedTimeSeriesChart, obtained from DetailedTimeSeriesChart.addSeries() rather than instantiated directly.
Dictionary	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	Builder for computing a chart measure or axis from a Datamart Expression instead of a plain field, obtained from AbstractChartMeasures.withExpression(), AbstractChartMeasures.withBoxplotExpression(), AggrFieldAxis.withExpression(), or NonAggrFieldAxis.withExpression() rather than instantiated directly.
Filters	Builder for a group of data filters on a chart series, obtained from AbstractChartSeries.getFilters(), AbstractChartSeries.addFilters(), AbstractChartSeries.addFilters(FilterOperator), AbstractChartSeries.addProductsFilter(), AbstractChartSeries.addCustomersFilter(), AbstractChartSeries.addAggregationsFilter(), or from Filters.addFilters(FilterOperator) on an outer Filters group, rather than instantiated directly.
Formula	Builder for attaching an Analytics Calculation Logic (created under Administration > Logics > Calculation Logic > Analytics) to a series, obtained from AbstractChartSeries.setFormula() rather than instantiated directly.
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	Builder for a Histogram, obtained via ChartBuilder.newHistogram() rather than instantiated directly.
HistogramChart.HistogramAdditionalMeasure	A measure column on a HistogramChart.HistogramSeries, obtained from HistogramChart.HistogramSeries.addAdditionalMeasure() rather than instantiated directly.
HistogramChart.HistogramOptions	The Options for a HistogramChart, obtained from HistogramChart.getOptions() rather than instantiated directly.
HistogramChart.HistogramSeries	The single series of a HistogramChart, obtained from HistogramChart.getSeries() rather than instantiated directly.
LimitToMeasure	Builder for a series' Top-N/Bottom-N row limit, obtained from AbstractChartSeries.setLimitTo(net.pricefx.common.api.chart.LimitPosition, java.math.BigDecimal, net.pricefx.common.api.chart.LimitType) rather than instantiated directly.
NonAggrFieldAxis	Builder for a series' non-aggregated axis or embedded box plot field, obtained from AbstractChartSeries.protectedSetNonAggrFieldAxisX(String), AbstractChartSeries.protectedSetNonAggrFieldAxisY(String), or AbstractChartSeries.setBoxplotAxis() rather than instantiated directly.
PieChart	Builder for a Pie Chart, obtained via ChartBuilder.newPie() rather than instantiated directly.
PieChart.PieAdditionalMeasure	A measure column on a PieChart.PieSeries, obtained from PieChart.PieSeries.addAdditionalMeasure() rather than instantiated directly.
PieChart.PieOptions	The Options for a PieChart, obtained from PieChart.getOptions() rather than instantiated directly.
PieChart.PieSeries	A single series of a PieChart, obtained from PieChart.addSeries() rather than instantiated directly.
PieChart.Size	Builder for the aggregated measure that determines a PieChart.PieSeries' slice sizes, obtained from PieChart.PieSeries.setSize(String) rather than instantiated directly.
Portlet
ScatterChart	Builder for a Scatter Chart, obtained via ChartBuilder.newScatter() rather than instantiated directly.
ScatterChart.ScatterAdditionalMeasure	A measure column on a ScatterChart.ScatterSeries, obtained from ScatterChart.ScatterSeries.addAdditionalMeasure() rather than instantiated directly.
ScatterChart.ScatterOnChartClick	The click-event builder for a ScatterChart, obtained from ScatterChart.onClick() rather than instantiated directly.
ScatterChart.ScatterOnChartClick.ScatterTriggerEvent	The event-payload builder for a point click on a ScatterChart, obtained from ScatterChart.ScatterOnChartClick.triggerEvent(String) rather than instantiated directly.
ScatterChart.ScatterOptions	The Options for a ScatterChart, obtained from ScatterChart.getOptions() rather than instantiated directly.
ScatterChart.ScatterSeries	A single series of a ScatterChart, obtained from ScatterChart.addSeries() rather than instantiated directly.
TimeSeriesChart	Builder for a Time Series Chart, obtained via ChartBuilder.newTimeSeries() rather than instantiated directly.
TimeSeriesChart.TimeSeriesAdditionalMeasure	A measure column on a TimeSeriesChart.TimeSeriesSeries, obtained from TimeSeriesChart.TimeSeriesSeries.addAdditionalMeasure() rather than instantiated directly.
TimeSeriesChart.TimeSeriesOptions	The Options for a TimeSeriesChart, obtained from TimeSeriesChart.getOptions() rather than instantiated directly.
TimeSeriesChart.TimeSeriesSeries	A single series of a TimeSeriesChart, obtained from TimeSeriesChart.addSeries() rather than instantiated directly.
TimeSeriesScatterChart	Builder for a Time Series Scatter Chart, obtained via ChartBuilder.newTimeSeriesScatter() rather than instantiated directly.
TimeSeriesScatterChart.TimeSeriesScatterAdditionalMeasure	A measure column on a TimeSeriesScatterChart.TimeSeriesScatterSeries, obtained from TimeSeriesScatterChart.TimeSeriesScatterSeries.addAdditionalMeasure() rather than instantiated directly.
TimeSeriesScatterChart.TimeSeriesScatterOptions	The Options for a TimeSeriesScatterChart, obtained from TimeSeriesScatterChart.getOptions() rather than instantiated directly.
TimeSeriesScatterChart.TimeSeriesScatterSeries	A single series of a TimeSeriesScatterChart, obtained from TimeSeriesScatterChart.addSeries() rather than instantiated directly.
TrendLine	Builder for a trend line overlay on a chart series, obtained from AbstractChartSeries.withTrendLine() rather than instantiated directly.
WaterfallChart	Builder for a Waterfall Chart, obtained via ChartBuilder.newWaterfall() rather than instantiated directly.
WaterfallChart.Aggregation	Builder for the aggregation formula applied to a WaterfallChart.WaterfallSeries' ADD and SUBTRACT columns, obtained from WaterfallChart.WaterfallSeries.getAggregation() rather than instantiated directly.
WaterfallChart.WaterfallOptions	The Options for a WaterfallChart, obtained from WaterfallChart.getOptions() rather than instantiated directly.
WaterfallChart.WaterfallSeries	The single series of a WaterfallChart, obtained from WaterfallChart.getSeries() rather than instantiated directly.
WaterfallComparisonChart	Builder for a Waterfall Comparison Chart, obtained via ChartBuilder.newWaterfallComparison() rather than instantiated directly.
WaterfallComparisonChart.Aggregation	Builder for the aggregation formula applied to a WaterfallComparisonChart.WaterfallComparisonSeries' ADD and SUBTRACT columns, obtained from WaterfallComparisonChart.WaterfallComparisonSeries.getAggregation() rather than instantiated directly.
WaterfallComparisonChart.WaterfallComparisonOptions	The Options for a WaterfallComparisonChart, obtained from WaterfallComparisonChart.getOptions() rather than instantiated directly.
WaterfallComparisonChart.WaterfallComparisonSeries	A single waterfall of a WaterfallComparisonChart, obtained from WaterfallComparisonChart.addSeries() rather than instantiated directly.

Classes in net.pricefx.common.apibuilder.chart used by net.pricefx.formulaengine

Class	Description
ChartBuilderResult

Classes in net.pricefx.common.apibuilder.chart used by net.pricefx.formulaengine.scripting

Class	Description
ChartBuilder