com.esri.arcgis.carto
Interface IPieChartRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
ChartRenderer

public interface IPieChartRenderer
extends Serializable

Provides access to members that work with additional chart renderer properties specific to pie charts.

Remarks

Use this interface to set up sizing properties for a ChartRenderer that displays pie charts. If you want all of your pies to appear as the same size, then you do not need to use this interface.

There are three options for chart sizing. First, pies can all be the same size. Second, pies can be sized by the sum of the values making up the pie. For this set ProportionalBySum = True. Third, pies can be sized by a data value from a particular field. For this, set ProportionalField. As with other data values, this field is normalized before the pie is sized. You can change text string that appears in the legend for this field by setting the ProportionalFieldAlias. If you don't set this, ProportionalField will be used in the renderer's legend entry.

For either the second or third sizing options, you must set some additional properties on this interface. Set MinSize to the size in points of the radius of the smallest pie chart. Set MinValue to the data value corresponding to MinSize. FlanneryCompensation is a flag that indicates whether or not appearance compensation is applied when sizing the pie charts. See IProportionalSymbolRenderer::FlanneryCompensation to learn more. Generally it is advisable to set this to True.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getMinSize()
          Symbol size (points) corresponding to the minimum value.
 double getMinValue()
          Minimum value (used for proportional sizing).
 String getProportionalField()
          Field used to determine size of the pie chart symbols.
 String getProportionalFieldAlias()
          Field alias for the proportional field.
 boolean isFlanneryCompensation()
          Indicates if Flannery Compensation is applied.
 boolean isProportionalBySum()
          Indicates if the size of pie chart symbols is determined by the sum of the values.
 void setFlanneryCompensation(boolean flag)
          Indicates if Flannery Compensation is applied.
 void setMinSize(double points)
          Symbol size (points) corresponding to the minimum value.
 void setMinValue(double value)
          Minimum value (used for proportional sizing).
 void setProportionalBySum(boolean flag)
          Indicates if the size of pie chart symbols is determined by the sum of the values.
 void setProportionalField(String name)
          Field used to determine size of the pie chart symbols.
 void setProportionalFieldAlias(String name)
          Field alias for the proportional field.
 

Method Detail

getProportionalField

String getProportionalField()
                            throws IOException,
                                   AutomationException
Field used to determine size of the pie chart symbols.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProportionalField

void setProportionalField(String name)
                          throws IOException,
                                 AutomationException
Field used to determine size of the pie chart symbols.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProportionalFieldAlias

String getProportionalFieldAlias()
                                 throws IOException,
                                        AutomationException
Field alias for the proportional field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProportionalFieldAlias

void setProportionalFieldAlias(String name)
                               throws IOException,
                                      AutomationException
Field alias for the proportional field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isProportionalBySum

boolean isProportionalBySum()
                            throws IOException,
                                   AutomationException
Indicates if the size of pie chart symbols is determined by the sum of the values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProportionalBySum

void setProportionalBySum(boolean flag)
                          throws IOException,
                                 AutomationException
Indicates if the size of pie chart symbols is determined by the sum of the values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinValue

double getMinValue()
                   throws IOException,
                          AutomationException
Minimum value (used for proportional sizing).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinValue

void setMinValue(double value)
                 throws IOException,
                        AutomationException
Minimum value (used for proportional sizing).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinSize

double getMinSize()
                  throws IOException,
                         AutomationException
Symbol size (points) corresponding to the minimum value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinSize

void setMinSize(double points)
                throws IOException,
                       AutomationException
Symbol size (points) corresponding to the minimum value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFlanneryCompensation

boolean isFlanneryCompensation()
                               throws IOException,
                                      AutomationException
Indicates if Flannery Compensation is applied.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlanneryCompensation

void setFlanneryCompensation(boolean flag)
                             throws IOException,
                                    AutomationException
Indicates if Flannery Compensation is applied.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.