Package net.pricefx.common.api.chart

package net.pricefx.common.api.chart

The value vocabulary of a chart definition.

These constants say which chart to draw, and how each series renders and aggregates its measure. They also say how the data is filtered, sorted and limited, and how the chart-specific features behave. Those features are heatmap coloring, box plot whiskers, waterfall columns and auxiliary lines.

You pass the constants to the fluent chart builders in net.pricefx.common.apibuilder.chart, which a logic obtains with PublicGroovyAPI.newChartBuilder(). The example below builds a bar chart of revenue by country, highest revenue first.

 api.newChartBuilder().newBarLine()
         .addSeries()
             .setLabel("Revenue by Country")
             .setDatamart("datamart_transaction")
             .setType(SeriesType.BAR)
             .setAxisX("Country")
             .setAxisY("InvoicePrice")
                 .withAggregation(AggregationFormula.SUM)
                 .back()
             .addFilters(FilterOperator.AND)
                 .addFilter("Year", FilterOperator.EQUAL, "2026")
                 .back()
             .withSortByAxisY(SortType.DESCENDING)
             .back()
         .build()
 

A quicker start is to build the chart in the Data Analyzer user interface. The View Expression function then shows the generated builder code, including the constants it selected.

Two enums in this package configure a multi-tier input rather than a chart. They are TieredValueSortType and TieredValueValidationType, and MultiTierInputBuilder takes them.

Reference

• ChartType selects the kind of chart.
• SeriesType selects how a series renders.
• AggregationFormula selects the aggregation of a measure.
• FilterOperator selects the comparison of a filter.
• SortType selects the sort direction of a series.
• LimitPosition selects which end of the sorted data a limit keeps.
• LimitType selects the kind of limit.
• ComparisonType selects how two or more series compare.
• ColorAxisType selects how a heatmap colors its cells.
• WhiskerType selects the whisker range of a box plot series.
• WaterfallColumnType selects what a waterfall column does.
• AuxLineType selects the shape of an auxiliary line.
• AuxLineColor selects the color of an auxiliary line.
• TieredValueSortType selects the sort direction of a multi-tier input.
• TieredValueValidationType selects whether a multi-tier input validates.

See Also:

• Chart Options (Pricefx Documentation)

Related Packages

Package	Description
net.pricefx.common.api	The value sets that the published Groovy API shares across modules.
net.pricefx.common.api.pa	The field typing of Analytics data.

Enum Classes

Class	Description
AggregationFormula	The aggregation formula applied to a chart series' measure or additional measure, set with AbstractChartMeasures.withAggregation(AggregationFormula) or an equivalent withAggregation method on a concrete series or axis type.
AuxLineColor	A named color for an auxiliary reference line or trend line overlay, set with AuxLine.setColor(AuxLineColor) or TrendLine.setColor(AuxLineColor).
AuxLineType	Identifies which shape an AuxLine overlay renders as.
ChartType	Identifies which kind of chart a ChartBuilderResult represents.
ColorAxisType	Selects how a HeatmapChart's color axis maps values to color, set with HeatmapChart.HeatmapOptions.setColorAxisType(ColorAxisType).
ComparisonType	Chooses how a chart renders a period comparison enabled with ChartOptions.ZAxis.setComparison(Boolean), set with BarLineChart.BarLineOptions.setComparisonType(ComparisonType) or DetailedTimeSeriesChart.DetailedTimeSeriesOptions.setComparisonType(ComparisonType).
FilterOperator	A comparison, string-matching, null-check, set-membership, or logical-combination operator for a chart series filter condition, used with Filters.addFilter(String, net.pricefx.common.api.chart.FilterOperator), Filters.addFilter(String, net.pricefx.common.api.chart.FilterOperator, Object), or, for the logical-combination constants (FilterOperator.AND, FilterOperator.OR, FilterOperator.NOT), Filters.addFilters(net.pricefx.common.api.chart.FilterOperator).
LimitPosition	Chooses which end of a series' ranked rows a Top-N/Bottom-N limit keeps, set with a concrete series type's setLimitTo(LimitPosition, java.math.BigDecimal, LimitType) method, for example PieChart.PieSeries.setLimitTo(LimitPosition, java.math.BigDecimal, LimitType).
LimitType	Chooses what kind of Top-N/Bottom-N limit a series applies, set with a concrete series type's setLimitTo(net.pricefx.common.api.chart.LimitPosition, java.math.BigDecimal, LimitType) method.
SeriesType	Chooses how a series or additional measure itself is rendered, independently of the chart's overall type, set with a concrete series or measure type's setType(SeriesType) method (or an equivalent method on a concrete series type), for example DetailedTimeSeriesChart.DetailedTimeSeriesSeries.setType(SeriesType) or ChartSeries.EmbeddedBoxplot.setType(SeriesType), for example rendering one series of a Bar & Line Chart as a line while its other series render as bars.
SortType	Chooses the sort direction for a series or dimension, set with a concrete series type's withSortByAxisX(SortType) or withSortByAxisY(SortType) method (or an equivalent method on a concrete series type), for example BoxplotChart.BoxplotSeries.withSortByAxisX(SortType) or BoxplotChart.BoxplotSeries.withSortByAxisY(SortType), or with PieChart.PieSeries.withSortByCategories(SortType).
TieredValueSortType	Chooses whether a Multi Tier Entry input's tiers are sorted by their target value ascending or descending, set with MultiTierInputBuilder.setSortType(TieredValueSortType).
TieredValueValidationType	Chooses whether a Multi Tier Entry input validates its entered tiers, set with MultiTierInputBuilder.setValidationType(TieredValueValidationType).
WaterfallColumnType	Chooses what kind of column a WaterfallChart.WaterfallSeries or WaterfallComparisonChart.WaterfallComparisonSeries adds to its bridge, set with WaterfallChart.WaterfallSeries.addWaterfallColumn(WaterfallColumnType, String, String) or the analogous method on a Waterfall Comparison Chart's series.
WhiskerType	Chooses the statistical method used to compute a box plot's whisker (minimum/maximum) bounds.