Pie Chart Commands
The following command line arguments to the PDF Chart Creator are specific to Pie Charts.
Additionally, the Legend can be configured.
Note #1: All color command parameters can be specified in one of three ways, just choose the method that you are most comfortable with:
#RRGGBB - HTML color specification, uses hexadecimal notation to define the amount of red (RR), green (GG) and
blue (BB) in a color. These values are between 0 (hexadecimal 00) and 255 (hexadecimal FF) inclusive.
Click here for more information and examples with hexadecimal colors.
R G B - decimal colour specification, uses normal decimal notation to define the amount of red (RRR), green
(GGG) and blue (BBB) in a color. These values are between 0 and 255 inclusive.
Click here for more information and examples with decimal colors.
R.R G.G B.B - real colour specification, used real number notation to define the amount of red (R.R), green
(G.G) and blue (B.B) in a color. These values are between 0.0 and 1.0 inclusive.
Click here for more information and examples with real colors.
Note #2: All font name command parameters must be specified as one of the following standard PDF fonts (also known as base14 fonts):
Courier
Courier-Bold
Courier-BoldOblique
Courier-Oblique
Helvetica
Helvetica-Bold
Helvetica-BoldOblique
Helvetica-Oblique
Times-Roman
Times-Bold
Times-Italic
Times-BoldItalic
Symbol
ZapfDingbats
|
-Datum |
Parameters: |
label - is the text associated with the pie chart segment value - can be up to 30 characters long.
value - is a numeric value (either integer, real or time).
|
Notes: |
There is an overall limit of 1000 items of data, and at least one item must be defined.
Both this and the -DataSet command can be used either individually or together, and in any order.
If spaces are required in the label then put quotes around the label text.
If a time value is specified as the first value then all values must be time values.
If a time value is not specified as the first value then any subsequent value must NOT be a time value.
A time value has the general form of HH:MM:SS.FFF where:
HH - hours (0 upwards)
MM - minutes (0 to 59)
SS - seconds (0 to 59)
FFF - milliseconds (0 to 999)
Note: HH and FFF are optional
|
|
-PieColor |
Parameters: |
segment color - color of one pie segment.
|
Notes: |
Up to 50 colors can be specified, if there are more than 50 segments displayed then the colors wrap around to the first one again.
There must be at least one segment color specified.
|
|
-PieOutlineColor |
Parameters: |
color - outline color for a pie segment.
width - must be greater than 0.0 and less than or equal to 100.0. Normally a value of 1.0 would be used in order to outline a segment.
|
Notes: |
This is optional, but if defined will draw a border of the specified color around the pie segment.
|
|
-PiePageMargin |
Parameters: |
width - must be between 0 and 100 inclusive.
|
Notes: |
This is optional and defines the amount of space between the pie chart and the edge of the page.
|
|
-PieLabel |
Parameters: |
position - must be one of the following values:
Inside - the pie segment label (see format parameter below) will appear horizontally just inside the pie segment.
Outside - the pie segment label (see format parameter below) will appear horizontally just outside of the pie segment.
Spoke - the pie segment label (see format parameter below) will appear inside the pie segment with the text extending from just inside the pie segment extending along the radius to the center of the pie chart.
format - can be up to 20 characters and allows the inclusion of the pie segment label and value to be included by using TTTT to represent the pie segment label and VVVV to represent the value. For example, "TTTT (VVVV)" would show the pie segment label followed by the value in brackets.
font point size - must be between 1 and 300 inclusive.
font name - must be one of the standard PDF fonts (see above).
text color - see text style below for an explanation of it's use.
text style - must be one of the following:
normal - has the text filled in with the required text color
stroke - has the text filled in with the required text color and the outline of each letter is "stroked" in the extra color
extra color - specified if text style is stroke
|
Notes: |
This is optional and controls where and how the pie segment labels are displayed.
If this command is not specified then no pie segment labels are displayed - however it is recomended that you either specify a label or use the -Legend command (see below) or the pie chart will not make much sense without any sort of descriptive labels shown.
If spaces are required in the format then put quotes around the format text.
|