com.crystaldecisions.sdk.occa.report.definition
Interface IChartDefinition

All Superinterfaces:
IClone
All Known Implementing Classes:
ChartDefinition

public interface IChartDefinition
extends IClone

This interface specifies the type of chart that appears on the report and defines the fields that are being charted on.


Method Summary
 ChartType getChartType()
          Returns the data that you want the chart type to represent.
 Fields getConditionFields()
          Returns the fields that indicate when to plot a point on a chart.
 Fields getDataFields()
          Returns the fields that indicate what information is plotted as the points on your chart.
 Groups getGroups()
          For internal use only
 ChartGroupType getGroupType()
          For internal use only
 IField getLabelField()
          For internal use only
 Groups getSeries()
          For internal use only
 void setChartType(ChartType chartType)
          Sets the data that you want the chart type to represent.
 void setConditionFields(Fields conditionFields)
          Sets the fields that indicate when to plot a point on a chart.
 void setDataFields(Fields dataFields)
          Sets the fields that indicate what information is plotted as the points on your chart.
 void setGroupType(ChartGroupType groupType)
          For internal use only
 void setLabelField(IField field)
          For internal use only
 

Method Detail

getChartType

ChartType getChartType()
Returns the data that you want the chart type to represent. Your report may include different fields, such as group fields, summary fields, and detail fields. Detail fields are those fields that form the columns of data values in the report.

Returns:
A ChartType object containing the data that you want the chart type to represent.

getConditionFields

Fields getConditionFields()

Returns the fields that indicate when to plot a point on a chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart), and values (the fields that indicate what information is plotted as the points on your chart). Condition fields are the conditions. For example, a chart showing last year's sales for your customers uses the Customer Name field as the condition. Each time the condition changes (the customer name changes), a point is plotted on the x-axis.

You can set two conditions, which may then be used to create a 3D chart. See the setType method.

Returns:
A Fields object containing the fields that indicate when to plot a point on a chart.

getDataFields

Fields getDataFields()

Returns the fields that indicate what information is plotted as the points on your chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart) and values (the fields that indicate what information is plotted as the points on your chart). Data fields are the values. For example, in a chart showing last year's sales for each of your customers, the Last Year's Sales field would be the y-axis value.

You can set multiple values, which may then be used to create a 3D chart. See the setType method.

Returns:
A Fields object containing the fields that indicate what information is plotted as the points on your chart.

getGroupType

ChartGroupType getGroupType()
For internal use only


getGroups

Groups getGroups()
For internal use only


getSeries

Groups getSeries()
For internal use only


getLabelField

IField getLabelField()
For internal use only


setChartType

void setChartType(ChartType chartType)

Sets the data that you want the chart type to represent. Your report may include different fields, such as group fields, summary fields, and detail fields. Detail fields are those fields that form the columns of data values in the report.

This property specifies the type of data--group or detail--that you want the chart to represent:

Parameters:
chartType - A ChartType object containing the data that you want the chart type to represent.

setConditionFields

void setConditionFields(Fields conditionFields)

Sets the fields that indicate when to plot a point on a chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart), and values (the fields that indicate what information is plotted as the points on your chart). Condition fields are the conditions. For example, a chart showing last year's sales for your customers uses the Customer Name field as the condition. Each time the condition changes (the customer name changes), a point is plotted on the x-axis.

You can set two conditions, which may then be used to create a 3D chart. See the setType method.

Parameters:
conditionFields - A Fields object containing the fields that indicate when to plot a point on a chart.

setDataFields

void setDataFields(Fields dataFields)

Sets the fields that indicate what information is plotted as the points on your chart. To create a chart, you must specify two things: conditions (the fields that indicate when to plot a point on a chart) and values (the fields that indicate what information is plotted as the points on your chart). Data fields are the values. For example, in a chart showing last year's sales for each of your customers, the Last Year's Sales field would be the y-axis value.

You can set multiple values, which may then be used to create a 3D chart. See the setType method.

Parameters:
dataFields - A Fields object containing the fields that indicate what information is plotted as the points on your chart.

setGroupType

void setGroupType(ChartGroupType groupType)
For internal use only


setLabelField

void setLabelField(IField field)
For internal use only