In a Funnel Chart (GraphType = 106), the value of this property defines the group to be drawn in the chart. Funnel charts are similar to pie charts except they show only a single group. The series in the selected group are stacked from top to bottom in the funnel.
DATA TYPE:
integer
RANGE:
0...# of groups in the data set
DEFAULT:
0
SYNTAX:
void setDisplayFunnelGroup(int newValue); int getDisplayFunnelGroup();
EXAMPLE:
setUseSampleData(false); setData(0,0,10); setData(1,0,20); setData(2,0,30); setSeriesLabel(0, "Series 0"); setSeriesLabel(1, "Series 1"); setSeriesLabel(2, "Series 2"); setDisplayFunnelGroup(0); setDataRangeToExtent(); setGraphType(106); setTitleString("Funnel Chart"); setSubtitleString("DisplayFunnelGroup = 0"); setTransparentBorderColor(getFrame(), true);
ALSO SEE:
Properties: FunnelLabelValueLocation, PieDepth, PieRotate, PieTilt
Methods that return an object ID: getFunnelFeeler(), getFunnelValueLabel(), getFunnelLabel()
In a Funnel chart, this property defines the location where values labels are drawn.
DATA TYPE:
integer
RANGE:
LOCATION_LABELS_ONTOP_OF_VALUES_BOTH_ON_RIGHT = 0; LOCATION_LABELS_ONLEFT_VALUES_ON_RIGHT = 1; LOCATION_VALUES_ONLEFT_LABELS_ON_RIGHT = 2;
0 = Labels on top of values drawn on the right of the funnel
1 = Labels on the left of the funnel/Values on the right of the funnel
2 = Values on the left or the funnel/Labels on the right of the funnel
DEFAULT:
0 (Labels on top of values drawn on the right of the funnel)
SYNTAX:
void setFunnelLabelValueLocation(int newValue); int getFunnelLabelValueLocation();
EXAMPLE:
setUseSampleData(false); setTitleString("Funnel Chart"); setData(0,0,10); setData(1,0,20); setData(2,0,30); setSeriesLabel(0, "Series 0"); setSeriesLabel(1, "Series 1"); setSeriesLabel(2, "Series 2"); setDisplayFunnelGroup(0); setDataRangeToExtent(); setGraphType(106); setTransparentBorderColor(getFrame(), true); setFunnelLabelValueLocation(0); setSubtitleString("setFunnelLabelValueLocation(0)");
setFunnelLabelValueLocation(1); setSubtitleString("setFunnelLabelValueLocation(1)");
setFunnelLabelValueLocation(2); setSubtitleString("setFunnelLabelValueLocation(2)");
ALSO SEE:
Properties: DisplayFunnelGroup, PieDepth, PieRotate, PieTilt
Methods that return an object ID: getFunnelFeeler(), getFunnelValueLabel(), getFunnelLabel()
This property is used to improve the appearance of pie charts by specifying the number of segments to draw in the arc of the pie.
DATA TYPE:
double
RANGE:
0...1
DEFAULT:
.15
SYNTAX:
void setNumPieArcSegmentsPerPixel(double newValue); double getNumPieArcSegmentsPerPixel();
EXAMPLE:
setPieDepth(60); setPieTilt(30); setGraphType(56); setPrimitiveAntialiasing(true); setNumPieArcSegmentsPerPixel(1);
If this property is TRUE, very small slices in a pie chart are not drawn individually. Instead, they are summed together in an "Other" slice. Very small is defined as a slice whose percent of the total pie is less than the value of the property OtherPercentage (default is 0.5 percent).
DATA TYPE:
integer
RANGE:
0...100
DEFAULT:
0.5%
SYNTAX:
void setOtherPercentage(int newValue); int getOtherPercentage();
EXAMPLE:
setGraphType(55); setOtherSeries(true); setOtherPercentage(3.0);
setOtherPercentage(6.0);
ALSO SEE:
If this property is TRUE, very small slices in a pie chart are not drawn individually. Instead, they are lumped together in an "Other" slice. Very small is defined as a slice whose percent of the total pie is less than the value of the property OtherPercentage (default is 0.5 percent).
DATA TYPE:
boolean
RANGE:
true / false; true = Draw slices less than OtherPercentage% together as an "Other" slice, false = Draw all slices individually
DEFAULT:
true
SYNTAX:
void setOtherSeries(boolean newValue); boolean getOtherSeries();
EXAMPLE:
setGraphType(55); setOtherSeries(true);
setOtherSeries(false);
ALSO SEE:
When the GraphType property selects a Pie-Bar chart (setGraphType(93);), this property enables/disables the pie-bar label display.
DATA TYPE:
boolean
RANGE:
true / false; true = Show Pie-Bar chart label, false = Do not show.
DEFAULT:
true
SYNTAX:
void PieBarLabelDisplay(boolean newValue); boolean getPieBarLabelDisplay();
EXAMPLE:
setPieBarLabelDisplay(true); setPieBarLabelString("PieBarLabel"); setGraphType(93);
setPieBarLabelDisplay(false); setPieBarLabelString("PieBarLabel"); setGraphType(93);
ALSO SEE:
When the GraphType property selects a Pie-Bar chart (setGraphType(93);), this property defines the Pie-Bar label string displayed by PieBarLabelDisplay.
DATA TYPE:
string
RANGE:
Any printable characters
DEFAULT:
null string
SYNTAX:
void PieBarLabelString(String newValue); String getPieBarLabelString();
EXAMPLE:
setPieBarLabelDisplay(true); setPieBarLabelString("PieBarLabel"); setGraphType(93);
ALSO SEE:
When the GraphType property selects a Pie-Bar chart (setGraphType(93);), this property selects the series from which the bar is charted.
DATA TYPE:
integer
RANGE:
0...# of Series in Chart
DEFAULT:
Zero
SYNTAX:
void setPieBarSeries(int newValue); int getPieBarSeries();
EXAMPLE:
setGraphType(93); setPieBarSeries(1);
setGraphType(93); setPieBarSeries(3);
This property specifies the depth of the crust in a pie chart or a funnel chart. The GraphType property must be set to a pie chart (55...60) or funnel chart (106).
DATA TYPE:
integer
RANGE:
0...100
DEFAULT:
30
SYNTAX:
void setPieDepth(int newValue); int getPieDepth();
Pie Chart Example:
setGraphType(55); setPieDepth(90);
setPieDepth(15);
Funnel Chart Example
setTransparentBorderColor(getFrame(), true); setGraphType(106); setTitleString("Funnel Chart"); setSubtitleDisplay(false); setPieRotate(50); setPieTilt(25); setPieDepth(100);
setTransparentBorderColor(getFrame(), true); setGraphType(106); setTitleString("Funnel Chart"); setSubtitleDisplay(false); setPieRotate(50); setPieTilt(25); setPieDepth(10);
ALSO SEE:
This property enables (true) / disables (false) the display of feelers and data text in a pie chart.
DATA TYPE:
integer
RANGE:
0...3; 0 = No labels, 1 = Show feeler lines and text, 2 = Labels only, no feeler lines, 3 = Labels on slices
DEFAULT:
1 (Display text and feeler lines)
SYNTAX:
void setPieFeelerTextDisplay(int newValue); int getPieFeelerTextDisplay();
EXAMPLE:
setGraphType(55); setPieFeelerTextDisplay(2); setPieDepth(60);
setPieFeelerTextDisplay(3);
NOTE:
PieFeelerTextFormat, PieFeelerTextFormatPattern, and PieLabelDisplay define the format of data text displayed next to feelers when this property is enabled.
ALSO SEE:
PieFeelerTextFormat, PieFeelerTextFormatPattern, PieLabelDisplay
This property selects a standard preset format for data values that may be drawn next to feelers in a pie chart. Set this property to minus one and use PieFeelerTextFormatPattern if you want to define a standard-Java format pattern. PieLabelDisplay defines the information that is displayed (i.e., percent value, absolute values, series label, etc.). When this property is used, the GraphType property must be set to one of the pie charts.
DATA TYPE:
integer
RANGE:
-1...21
Value
Description
-1
Use the pattern defined by PieFeelerTextFormatPattern
0/1 =
# (e.g., 123 = 123)
2 =
#% (e.g., 123 = 12,300%)
3 =
#.#% (e.g., 123 = 12,300.0%)
4 =
#.##% (e.g., 123 = 12,300.00%)
5 =
$#.## (e.g., 123 = $123.00)
6 =
$# (e.g., 123 = $123)
7 =
#K (Show K for values over 999) (e.g., 1,234 = 1K)
8 =
$#K (Show K for values over 999) (e.g., 1,234 = $1K)
9 =
#M (Show M for millions)(e.g., 1,234,567 = 1M)
10 =
$#M (Show M for millions)(e.g., 1,234,567 = $1M)
11 =
#B (Show B for billions)(e.g., 1,234,567,891 = 1B)
12 =
$#B (Show B for billions)(e.g., 1,234,567,891 = $1B)
13 =
#T (Show T for trillions)(e.g., 1,234,567,891,234 = 1T)
14 =
$#T (Show T for trillions)(e.g., 1,234,567,891,234 = $1T)
15 =
Number with thousands separators, no decimal places (e.g., 1,234 = 1K)
16 =
Number with thousands separators, two decimal places (e.g., 1,234 = 1.23K)
17 =
General currency format for current Locale
18 =
Short Date Format: MM/DD/YY (e.g., 10/01/03)
19 =
Medium Date Format: Mon. DD, YYYY (e.g., Oct. 01, 2003)
20 =
Long Date Format: Month DD, YYYY (e.g., October 01, 2003)
21 =
Full Date Format: Day, Month DD, YYYY (e.g., Wednesday, October 01, 2003)
DEFAULT:
2(#%)
SYNTAX:
void setPieFeelerTextFormat (int newValue); int getPieFeelerTextFormat();
ALSO SEE:
PieFeelerTextDisplay, PieFeelerTextFormatPattern, PieLabelDisplay
When PieFeelerTextFormat is set to minus one (custom), this property is used to specify a standard Java number format pattern for data text values.
DATA TYPE:
string
RANGE:
A pattern string in the following format:
pattern: = subpattern{;subpattern} subpattern: = {prefix}integer{.fraction}{suffix} prefix: = '\\u0000'..'\\uFFFD' - specialCharacters suffix:= '\\u0000'..'\\uFFFD'- specialCharacters integer:= '#'* '0'* '0' fraction:= '0'* '#'*
Where:
X*
0 or more instances of X
(X|Y)
either X or Y.
X..Y
any character from X up to Y, inclusive.
S - T
characters in S, except those in T
The first subpattern is for positive numbers. The second (optional) subpattern is for negative numbers. In both cases, a comma(,) can occur inside the integer portion. The special characters used in the parts of the subpattern are:
0
a digit
#
a digit, zero shows as absent
.
a period(.) is a placeholder for decimal separator
,
a comma(,) is a placeholder for grouping separator
;
a semicolon(;) separates formats
-
a minus sign/dash(-) is the default negative prefix
%
divide by 100 and show as percentage
x
any other characters can be used in the prefix or suffix
'
a single quote(') is used to quote special characters in a prefix or suffix
If there is no explicit negative subpattern, a minus sign(-) is prefixed to the positive form (i.e, "0.00" alone is equivalent to "0.00;-0.00"). Illegal formats, such as "#.#.#" or mixing '_' and '*' in the same format, will cause a ParseException. The ParseException string will show where the error occurred. The grouping separator is commonly used for thousands, but in some countries for ten-thousands. The interval is a constant number of digits between the grouping characters, such as 100,000,000 or 1,0000,0000. If you supply a pattern with multiple grouping characters, the interval between the last one and the end of the integer is the one that is used. So "#,##,###,####" == "######,####" == "##,####,####". This class only handles localized digits where the 10 digits are contiguous in Unicode, from 0 to 9.
DEFAULT:
"#.#"
SYNTAX:
void setPieFeelerTextFormatPattern (String newValue); String getPieFeelerTextFormatPattern();
ALSO SEE:
This property determines the format of labels displayed next to feelers in a pie chart. The GraphType property must be set to one of the pie charts (55...60).
DATA TYPE:
integer
RANGE:
0...3; 0 = Absolute (true) value of slice, 1 = Percent value of slice, 2 = Series Label, 3 = Series Label and Percent value
DEFAULT:
1 (Percent Value of Slice)
SYNTAX:
void setPieLabelDisplay (int newValue); int getPieLabelDisplay();
EXAMPLE:
setGraphType(55); setPieLabelDisplay(2); setPieDepth(60);
setPieLabelDisplay(3);
ALSO SEE:
PieFeelerTextDisplay, PieFeelerTextFormat, PieFeelerTextFormatPattern
This property determines the relative size of the ring (inner circle) in a ring pie. The GraphType property must be set to one of the pie ring charts (56, 58, or 60).
DATA TYPE:
integer
RANGE:
0...100
DEFAULT:
30
SYNTAX:
void setPieRingSize (int newValue); int getPieRingSize();
EXAMPLE:
setGraphType(56); setPieRingSize(60);
setPieRingSize(15);
ALSO SEE:
PieRingTotalDisplay, PieRingTotalFormat, PieRingTotalFormatPattern
This property controls drawing of a total value in the center of a ring pie chart. PieRingTotalFormat defines the format of the total value that is displayed.
DATA TYPE:
boolean
RANGE:
true / false; true = Display total. false = Do not display total
DEFAULT:
true
SYNTAX:
void setPieRingTotalDisplay (boolean newValue); boolean getPieRingTotalDisplay();
EXAMPLE:
setGraphType(56); setPieRingTotalDisplay(true); setPieRingSize(60);
setPieRingTotalDisplay(false);
ALSO SEE:
When PieRingTotalDisplay is true, this property defines the format of the total data value is displayed in the center of a ring pie chart.
DATA TYPE:
integer
RANGE:
-1...21.
Value
Description
-1
Use the pattern defined by PieRingTotalFormatPattern
0/1 =
# (e.g., 123 = 123)
2 =
#% (e.g., 123 = 12,300%)
3 =
#.#% (e.g., 123 = 12,300.0%)
4 =
#.##% (e.g., 123 = 12,300.00%)
5 =
$#.## (e.g., 123 = $123.00)
6 =
$# (e.g., 123 = $123)
7 =
#K (Show K for values over 999) (e.g., 1,234 = 1K)
8 =
$#K (Show K for values over 999) (e.g., 1,234 = $1K)
9 =
#M (Show M for millions) (e.g., 1,234,567 = 1M)
10 =
$#M (Show M for millions) (e.g., 1,234,567 = $1M)
11 =
#B (Show B for billions) (e.g., 1,234,567,891 = 1B)
12 =
$#B (Show B for billions) (e.g., 1,234,567,891 = $1B)
13 =
#T (Show T for trillions) (e.g., 1,234,567,891,234 = 1T)
14 =
$#T (Show T for trillions) (e.g., 1,234,567,891,234 = $1T)
15 =
Number with thousands separators, no decimal places (e.g., 1,234 = 1K)
16 =
Number with thousands separators, two decimal places (e.g., 1,234 = 1.23K)
17 =
General currency format for current Locale
18 =
Short Date Format: MM/DD/YY (e.g., 10/01/03)
19 =
Medium Date Format: Mon. DD, YYYY (e.g., Oct. 01, 2003)
20 =
Long Date Format: Month DD, YYYY (e.g., October 01, 2003)
21 =
Full Date Format: Day, Month DD, YYYY (e.g., Wednesday, October 01, 2003)
DEFAULT:
Zero (General)
SYNTAX:
void setPieRingTotalFormat(int newValue); int getPieRingTotalFormat();
ALSO SEE:
When PieRingTotalDisplay is true and the total data value is displayed in the center of a ring pie chart, this property can be used to define the format of the data value. This property is used to specify a standard Java number format pattern. See the PieRingTotalFormat property to select one of the standard preset formats.
DATA TYPE:
string
RANGE:
A pattern string in the following format:
pattern: = subpattern{;subpattern} subpattern: = {prefix}integer{.fraction}{suffix} prefix: = '\\u0000'..'\\uFFFD' - specialCharacters suffix: = '\\u0000'..'\\uFFFD' - specialCharacters integer: = '#'* '0'* '0' fraction: = '0'* '#'*
Where:
X*
0 or more instances of X
(X|Y)
either X or Y.
X..Y
any character from X up to Y, inclusive.
S - T
characters in S, except those in T
The first subpattern is for positive numbers. The second (optional) subpattern is for negative numbers. In both cases, a comma(,) can occur inside the integer portion. The special characters used in the parts of the subpattern are:
0
a digit
#
a digit, zero shows as absent
.
a period(.) is a placeholder for decimal separator
,
a comma(,) is a placeholder for grouping separator
;
a semicolon(;) separates formats
-
a minus sign/dash(-) is the default negative prefix
%
divide by 100 and show as percentage
x
any other characters can be used in the prefix or suffix
'
a single quote(') is used to quote special characters in a prefix or suffix
If there is no explicit negative subpattern, a minus sign(-) is prefixed to the positive form (i.e, "0.00" alone is equivalent to "0.00;-0.00"). Illegal formats, such as "#.#.#" or mixing '_' and '*' in the same format, will cause a ParseException. The ParseException string will show where the error occurred. The grouping separator is commonly used for thousands, but in some countries for ten-thousands. The interval is a constant number of digits between the grouping characters (e.g., 100,000,000 or 1,0000,0000). If you supply a pattern with multiple grouping characters, the interval between the last one and the end of the integer is the one that is used. So "#,##,###,####" == "######,####" == "##,####,####". This class only handles localized digits where the 10 digits are contiguous in Unicode, from 0 to 9.
DEFAULT:
"#.#"
SYNTAX:
void setPieRingTotalFormatPattern (String newValue); String getPieRingTotalFormatPattern();
ALSO SEE:
This property rotates a pie or a funnel chart a specified number of degrees.
DATA TYPE:
integer
RANGE:
0...359
DEFAULT:
Zero
SYNTAX:
void setPieRotate(int newValue); int getPieRotate();
Example Pie Chart:
setGraphType(55); setPieRotate(90);
setPieRotate(180);
Example Funnel Chart:
setTransparentBorderColor(getFrame(), true); setGraphType(106); setTitleString("Funnel Chart"); setSubtitleDisplay(false); setPieRotate(359); setPieTilt(25); setPieDepth(50);
setTransparentBorderColor(getFrame(), true); setGraphType(106); setTitleString("Funnel Chart"); setSubtitleDisplay(false); setPieRotate(10); setPieTilt(25); setPieDepth(50);
ALSO SEE:
This property determines the order in which pie slices are drawn.
DATA TYPE:
integer
RANGE:
0...3; 0 = No sorting, leave the original order (default), 1 = Ascending order, 2 = Descending order, 3 = Alternate (largest slice, then smallest slice, then 2nd largest slice, then 2nd smallest slice etc...). This is the best sorting to avoid label overlap when there are a lot of slices).
DEFAULT:
0 (no sorting)
SYNTAX:
void setPieSorting (int newValue); int getPieSorting();
EXAMPLE:
setGraphType(55); setPieSorting(1);
setGraphType(55); setPieSorting(3);
This property specifies the number of pies to be drawn in a row in multi-pie charts.
DATA TYPE:
integer
RANGE:
1...32
DEFAULT:
2
SYNTAX:
void setPiesPerRow(int newValue); int getPiesPerRow();
EXAMPLE:
setPieTilt(5); setGraphType(57); setPiesPerRow(5);
setPiesPerRow(3);
This property tilts a pie or a funnel chart chart a specified number of degrees.
DATA TYPE:
integer
RANGE:
0...100
DEFAULT:
10
SYNTAX:
void setPieTilt(int newValue); int getPieTilt();
Example Pie Chart:
setPieTilt(45); setGraphType(55);
setPieTilt(5);
Example Funnel Chart:
setTransparentBorderColor(getFrame(), true); setGraphType(106); setTitleString("Funnel Chart"); setSubtitleDisplay(false); setPieRotate(50); setPieTilt(1); setPieDepth(50);
setTransparentBorderColor(getFrame(), true); setGraphType(106); setTitleString("Funnel Chart"); setSubtitleDisplay(false); setPieRotate(50); setPieTilt(100); setPieDepth(50);
ALSO SEE: