Used to represent a "Pie"-type chart. Based on the Java XChart PieChart class.
Style parameter
Hash object for which the keys are style property names and the values the value associated with each property. This object groups together a set of base properties which are common to all types of chart as well as a set of properties which are specific to "Pie" charts.
Property type
Each property is defined in an XChart class (Styler base class or specific PieStyler class) by its "setter" method. When one of these properties is used in this macro, its Freemarker type is that which corresponds to the associated Java type.
Java Font Type
Certain Java properties are complex Font types (https://docs.oracle.com/javase/8/docs/api/java/awt/Font.html). In this case, the corresponding FreeMarker type is an alphanumeric string in the following format:
"fontName-style-pointsize" where:
- fontName represents the font name,
- style represents the font style: "PLAIN", "BOLD", "BOLDITALIC" or "ITALIC",
- pointsize represents the font size in points.
Examples:"Arial-BOLD-18", "SansSerif-PLAIN-24"
Java Color Type
Certain Java properties are complex Font types ( https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html). In this case, the corresponding FreeMarker type is an alphanumeric string in the following format:
- "0xRRGGBB" or "#rrggbb" (Red Green Blue components of the color in hexadecimal mode),
- The literal name of a color: "red", "orange", "yellow", "olive", "purple", "fuchsia", "white", "lime", "green", "navy", "blue", "aqua", "teal", "black", "silver", "gray", "magenta", "pink", "cyan", "light_gray", "lightgray", "brown", "gray", "dark_gray", "darkgray",
- "rgb(r,g,b)" " (Red Green Blue components of the color in decimal mode),
Base styles (Java XChart Styler class) |
|
Property name |
Value type |
AnnotationsFont |
Cf. Java Font Type |
AntiAlias |
Boolean |
BaseFont |
Cf. Java Font Type |
ChartBackgroundColor |
Cf. Java Color Type |
ChartFontColor |
Cf. Java Color Type |
ChartPadding |
Number (integer) |
ChartTitleBoxBackgroundColor |
Cf. Java Color Type |
ChartTitleBoxBorderColor |
Cf. Java Color Type |
ChartTitleBoxVisible |
Boolean |
ChartTitleFont |
Cf. Java Font Type |
ChartTitlePadding |
Number (integer) |
ChartTitleVisible |
Boolean |
DecimalPattern |
String |
HasAnnotations |
Boolean |
LegendBackgroundColor |
Cf. Java Color Type |
LegendBorderColor |
Cf. Java Color Type |
LegendFont |
Cf. Java Font Type |
LegendLayout |
Strings "Vertical", "Horizontal" |
LegendPadding |
Number (integer) |
LegendPosition |
Strings "OutsideE", "InsideNW", "InsideNE", "InsideSE", "InsideSW", "InsideN", "InsideS", "OutsideS" |
LegendSeriesLineLength |
Number (integer) |
LegendVisible |
Boolean |
PlotBackgroundColor |
Cf. Java Color Type |
PlotBorderColor |
Cf. Java Color Type |
PlotBorderVisible |
Boolean |
PlotContentSize |
Number (decimal) |
SeriesColors |
Color sequence |
|
Property not supported |
SeriesMarkers |
"Circle", "Cross", "Diamond", "None", "Oval", "Plus", "Rectangle", "Square", "Trapezoid", "TriangleDown", "TriangleUp" string sequence |
Theme |
Strings |
ToolTipBackgroundColor |
Cf. Java Color Type |
ToolTipBorderColor |
Cf. Java Color Type |
ToolTipFont |
Cf. Java Font Type |
ToolTipHighlightColor |
Cf. Java Color Type |
ToolTipsAlwaysVisible |
Boolean |
ToolTipsEnabled |
Boolean |
ToolTipType |
Strings "xLabels", "yLabels", "xAndYLabels" |
YAxisGroupPosition |
Sequence of sequences with a length of 2. Each sub-sequence contains a Number (integer) and a "Left", "Right" String. |
Specific styles (Java XChart PieStyler class) |
|
AnnotationDistance |
Number (decimal) |
AnnotationType |
Strings "Value", "Percentage", "Label", "LabelAndPercentage" |
Circular |
Boolean |
DefaultSeriesRenderStyle |
String "Pie", "Donut" |
DonutThickness |
Number (decimal) |
DrawAllAnnotations |
Boolean |
StartAngleInDegrees |
Number (decimal) |
SumFont |
Cf. Java Font Type |
SumFontSize |
Number (decimal) |
SumVisible |
Boolean |
↑ Top of page
Series parameter
Sequence of Hash objects representing the data series of the "Pie" chart. Also, style properties can be defined for each series. Each Hash object represents a series: these properties enable data values as well as style property values to be stored.
Data properties of a series
A "Pie" chart series is represented by its name and a single value (Cf. addSeries method https://knowm.org/javadocs/xchart/org/knowm/xchart/PieChart.html).
Property name |
Value type |
Mandatory |
name |
String |
Y |
value |
Number |
Y |
↑ Top of page
Style properties of a series
These properties are used to specify a series by overloading a style property defined in the Hash object of the macro's Style parameter. Each property is defined in an XChart class (Series base class or specific PieSeries class) by its "setter" method.
When one of these properties is used in this macro, its Freemarker type is that which corresponds to the associated Java type.
Base series styles (Java XChart Series class) |
|
Property name |
Value type |
Enabled |
Boolean |
FillColor |
Cf. Java Color Type |
Label |
String |
ShowInLegend |
Boolean |
YAxisGroup |
Number (integer) |
Specific series styles (Java XChart PieSeries class) |
|
Strings "Pie", "Donut" |
↑ Top of page