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()
          Deprecated. please use getGoups
 Fields<IField> getDataFields()
          Returns the fields that indicate what information is plotted as the points on your chart.
 Groups getGroups()
          Gets the chart's groups.
 ChartGroupType getGroupType()
          Gets the chart group type.
 IField getLabelField()
          Get the chart's label field.
 Groups getSeries()
          Get the chart's series groups.
 void setChartType(ChartType chartType)
          Sets the data that you want the chart type to represent.
 void setConditionFields(Fields conditionFields)
          Deprecated. please use setGoups
 void setDataFields(Fields<IField> dataFields)
          Sets the fields that indicate what information is plotted as the points on your chart.
 void setGroupType(ChartGroupType groupType)
          Sets the chart group type.
 void setLabelField(IField field)
          Sets the chart's label field.
 

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()
Deprecated. please use getGoups

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<IField> 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()
Gets the chart group type.

Returns:
the ChartGroupType
See Also:
ChartGroupType

getGroups

Groups getGroups()
Gets the chart's groups.

Returns:
a collection of IGroup objects

getSeries

Groups getSeries()
Get the chart's series groups.

Returns:
a collection of IGroup objects

getLabelField

IField getLabelField()
Get the chart's label field. Used only when the chart group type is set to ChartGroupType.forEachRecord.

Returns:
the label field

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)
Deprecated. please use setGoups

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<IField> 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)
Sets the chart group type.

Parameters:
groupType - a ChartGroupType
See Also:
ChartGroupType

setLabelField

void setLabelField(IField field)
Sets the chart's label field. Used only when the chart group type is set to ChartGroupType.forEachRecord.

Parameters:
field - the field to use as label