All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jclass.chart.JCPieChartFormat 

java.lang.Object
   |
   +----jclass.chart.JCPieChartFormat
public class JCPieChartFormat
extends Object
implements JCSerializable
JCPieChartFormat is an object that manages chart properties specific to pie charts.

Properties

Name Method
ThresholdMethod The ThresholdMethod property determines how the ThresholdValue property is used. If the method is SLICE_CUTOFF, the ThresholdValue is used as a cutoff to determine what items are lumped into the other slice. If the method is PIE_PERCENTILE, items are groups into the other slice until it represents "ThresholdValue" percent of the pie. Default value is SLICE_CUTOFF.
ThresholdValue The ThresholdValue property is a percentage value between 0.0 and 100.0. How this value is used depends on the ThresholdMethod property. Default value is 10.0.
SortOrder The SortOrder property determines the order in which pie slices will be displayed. Note that the other slice is always last in any ordering. Valid values include JCPieChartFormat.ASCENDING_ORDER, JCPieChartFormat.DESCENDING_ORDER and JCPieChartFormat.DATA_ORDER. Default value is JCPieChartFormat.DATA_ORDER.
MinSlices The MinSlices property represents the minimum number of pie slices that Chart will try to display before grouping slices into the other slice. Default value is 5.
OtherLabel The OtherLabel property represents used on the "other" pie slice. As with other point labels, the "other" label is a ChartText instance. Default value is " " (empty string).
OtherStyle The OtherStyle property specifies the style used to render the "other" pie slice.

Variable Index

o ASCENDING_ORDER
o DATA_ORDER
o DESCENDING_ORDER
o OTHER_SLICE
Used to specify the other slice of a pie chart.
o PIE_PERCENTILE
o SLICE_CUTOFF

Constructor Index

o JCPieChartFormat()
o JCPieChartFormat(Changeable)

Method Index

o getExplodeList()
Gets the ExplodeList property, which specifies a list of exploded pie slice in the pie charts..
o getExplodeOffset()
Gets the ExplodeOffset property, which specifies the distance a slice is exploded from the center of a pie chart.
o getMinSlices()
Gets the MinSlices property, which represents the minimum number of pie slices that Chart will try to display before grouping slices into the other slice.
o getOtherLabel()
Gets the OtherLabel property, which represents the label used on the "other" pie slice.
o getOtherStyle()
Gets the OtherStyle property, which specifies the style used to render the "other" pie slice.
o getSortOrder()
Gets the SortOrder property, which is used to determine the order in which pie slices will be displayed.
o getThresholdMethod()
Gets the ThresholdMethod property of the PieChartStyle.
o getThresholdValue()
Gets the ThresholdValue property, which is a percentage value (ie between 0.0 and 100.0).
o setExplodeList(Point[])
Sets the ExplodeList property, which specifies a list of exploded pie slice in the pie charts..
o setExplodeOffset(int)
Sets the ExplodeOffset property, which specifies the distance a slice is exploded from the center of a pie chart.
o setMinSlices(int)
Sets the MinSlices property, which represents the minimum number of pie slices that Chart will try to display before grouping slices into the other slice.
o setOtherLabel(String)
Sets the OtherLabel property, which represents the label used on the "other" pie slice.
o setOtherStyle(JCChartStyle)
Sets the OtherStyle property, which specifies the style used to render the "other" pie slice.
o setSortOrder(int)
Gets the SortOrder property, which is used to determine the order in which pie slices will be displayed.
o setThresholdMethod(int)
Sets the ThresholdMethod property of the PieChartStyle.
o setThresholdValue(double)
Sets the ThresholdValue property, which is a percentage value (ie between 0.0 and 100.0).

Variables

o SLICE_CUTOFF 
 public static final int SLICE_CUTOFF
o PIE_PERCENTILE 
 public static final int PIE_PERCENTILE
o DATA_ORDER 
 public static final int DATA_ORDER
o ASCENDING_ORDER 
 public static final int ASCENDING_ORDER
o DESCENDING_ORDER 
 public static final int DESCENDING_ORDER
o OTHER_SLICE 
 public static final int OTHER_SLICE
Used to specify the other slice of a pie chart.

Constructors

o JCPieChartFormat 
 public JCPieChartFormat()
o JCPieChartFormat 
 public JCPieChartFormat(Changeable p)

Methods

o getThresholdMethod 
 public int getThresholdMethod()
Gets the ThresholdMethod property of the PieChartStyle. This property determines how the ThresholdValue property is used. If the method is SLICE_CUTOFF, the ThresholdValue is used as a cutoff to determine what items are lumped into the other slice. If the method is PIE_PERCENTILE, items are groups into the other slice until it represents "ThresholdValue" percent of the pie.

Returns:
one of SLICE_CUTOFF or PIE_PERCENTILE
o setThresholdMethod 
 public synchronized void setThresholdMethod(int meth)
Sets the ThresholdMethod property of the PieChartStyle. This property determines how the ThresholdValue property is used. If the method is SLICE_CUTOFF, the ThresholdValue is used as a cutoff to determine what items are lumped into the other slice. If the method is PIE_PERCENTILE, items are groups into the other slice until it represents "ThresholdValue" percent of the pie.

Parameters:
meth - one of SLICE_CUTOFF or PIE_PERCENTILE
Throws: IllegalArgumentException
If the value for ThresholdMethod is not one of SLICE_CUTOFF or PIE_PERCENTILE.
o getThresholdValue 
 public double getThresholdValue()
Gets the ThresholdValue property, which is a percentage value (ie between 0.0 and 100.0). How this value is used depends on the ThresholdMethod property.

Returns:
percentage value between 0.0 and 100.0
See Also:
getThresholdMethod
o setThresholdValue 
 public synchronized void setThresholdValue(double per)
Sets the ThresholdValue property, which is a percentage value (ie between 0.0 and 100.0). How this value is used depends on the ThresholdMethod property.

Parameters:
per - percentage value between 0.0 and 100.0
Throws: IllegalArgumentException
If the new threshold value is less than 0.0 or greater than 100.0.
See Also:
getThresholdMethod
o getSortOrder 
 public int getSortOrder()
Gets the SortOrder property, which is used to determine the order in which pie slices will be displayed. Note that the other slice is always last in any ordering.

Returns:
one of ASCENDING_ORDER, DESCENDING_ORDER or DATA_ORDER
o setSortOrder 
 public synchronized void setSortOrder(int order)
Gets the SortOrder property, which is used to determine the order in which pie slices will be displayed. Note that the other slice is always last in any ordering.

Parameters:
order - one of ASCENDING_ORDER, DESCENDING_ORDER or DATA_ORDER
Throws: IllegalArgumentException
If the ordering value is not one of ASCENDING_ORDER, DESCENDING_ORDER or DATA_ORDER.
o getMinSlices 
 public int getMinSlices()
Gets the MinSlices property, which represents the minimum number of pie slices that Chart will try to display before grouping slices into the other slice.

Returns:
a positive integer representing the number of slices to attempt to display
o setMinSlices 
 public synchronized void setMinSlices(int min)
Sets the MinSlices property, which represents the minimum number of pie slices that Chart will try to display before grouping slices into the other slice.

Parameters:
min - a positive integer representing the number of slices to attempt to display
o getOtherLabel 
 public String getOtherLabel()
Gets the OtherLabel property, which represents the label used on the "other" pie slice. As with other point labels, the "other" label is a ChartText instance.

Returns:
ChartText instance used as the label for the "other" pie slice
o setOtherLabel 
 public synchronized void setOtherLabel(String label)
Sets the OtherLabel property, which represents the label used on the "other" pie slice.

Parameters:
label - string used as the label for the "other" pie slice
o getOtherStyle 
 public JCChartStyle getOtherStyle()
Gets the OtherStyle property, which specifies the style used to render the "other" pie slice.

Returns:
JCChartStyle instance outlining rendering information for the "other" slice
o setOtherStyle 
 public synchronized void setOtherStyle(JCChartStyle style)
Sets the OtherStyle property, which specifies the style used to render the "other" pie slice.

Parameters:
style - JCChartStyle instance outlining rendering information for the "other" slice
o getExplodeList 
 public Point[] getExplodeList()
Gets the ExplodeList property, which specifies a list of exploded pie slice in the pie charts..

Returns:
an array of Point objects. Each point object contains the data point index (pie number) in the x value and the series number (slice index) in the y value, specifying the pie slice to explode. To explode the "other" slice, the series number should be OTHER_SLICE. If no slices are exploded, this function will return null.
o setExplodeList 
 public synchronized void setExplodeList(Point pts[])
Sets the ExplodeList property, which specifies a list of exploded pie slice in the pie charts..

Parameters:
pts - an array of Point objects. Each point object contains the data point index (pie number) in the x value and the series number (slice index) in the y value, specifying the pie slice to explode. To explode the "other" slice, the series number should be OTHER_SLICE. If null, no slices are exploded.
o getExplodeOffset 
 public int getExplodeOffset()
Gets the ExplodeOffset property, which specifies the distance a slice is exploded from the center of a pie chart.

Returns:
the explode offset
o setExplodeOffset 
 public synchronized void setExplodeOffset(int off)
Sets the ExplodeOffset property, which specifies the distance a slice is exploded from the center of a pie chart.

Parameters:
off - the explode offset 
All Packages  Class Hierarchy  This Package  Previous  Next  Index