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

All Superinterfaces:
IClone, IReportObject
All Known Implementing Classes:
ChartObject

public interface IChartObject
extends IReportObject

This is the main interface for determining how a chart will look when it appears on the report. It inherits properties and methods from the ReportObject object. As well as containing information about the chart's size and border, this object gives you access to the ChartDefinition object and the ChartStyle object.

NOTE: At this time, the RAS SDK does not support manipulating charts based on crosstabs or charts based on OLAP fields. You can only delete these objects.


Method Summary
 IChartDefinition getChartDefinition()
           Returns an IChartDefinition object.
 int getChartGroupIndex()
           Returns in which group area to place the chart.
 AreaSectionKind getChartReportArea()
           Returns the AreaSectionKind on the report where the chart is located.
 IChartStyle getChartStyle()
           Returns an IChartStyle object.
 GraphicInstance getGraphicInstance()
           
 void setChartDefinition(IChartDefinition chartDefinition)
           Returns an IChartDefinition object.
 void setChartGroupIndex(int chartGroupIndex)
           Sets in which group area to place the chart.
 void setChartReportArea(AreaSectionKind chartReportArea)
           Sets the AreaSectionKind on the report where the chart is located.
 void setChartStyle(IChartStyle chartStyle)
           Sets an IChartStyle object.
 void setGraphicInstance(GraphicInstance graphicInstance)
           
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Method Detail

getChartDefinition

IChartDefinition getChartDefinition()

Returns an IChartDefinition object. The IChartDefinition object specifies the type of chart that appears on the report and defines the fields that are being charted on.

Returns:
An IChartDefinition object that specifies the type of chart that appears on the report.

getChartGroupIndex

int getChartGroupIndex()

Returns in which group area to place the chart. Use the getChartReportArea method to determine if the chart appears in the report's group area. If it does, you can then use the setChartGroupIndex method to specify the group area in which to place the chart.

Returns:
An int that specifies in which group area to place the chart.

getChartReportArea

AreaSectionKind getChartReportArea()

Returns the AreaSectionKind on the report where the chart is located. A report consists of the following kinds of areas:

If a group, summary, or subtotal is added to the report, the program creates two additional sections:

When a group, summary, or subtotal is added, the Group Header area appears directly above the Details area and the Group Footer area appears directly below the Details area.

If you set up additional groups, the program creates new group areas between the Details area and the existing Group Header and Group Footer area(s).

Like the original areas, each of these newly added areas can contain one or more sections. By default, they each contain a single section.

Returns:
An AreaSectionKind object that specifies the area on the report where the chart is located.

getChartStyle

IChartStyle getChartStyle()

Returns an IChartStyle object. The IChartStyle object specifies the chart type (for example, a bar chart or pie chart) that appears on the report and gives you access to the text options for the chart title, subtitle, and footnote.

Returns:
An IChartStyle object that specifies the chart type that appears on the report.

setChartDefinition

void setChartDefinition(IChartDefinition chartDefinition)

Returns an IChartDefinition object. The IChartDefinition object specifies the type of chart that appears on the report and defines the fields that are being charted on.

Parameters:
chartDefinition - An IChartDefinition object that specifies the type of chart that appears on the report.

setChartGroupIndex

void setChartGroupIndex(int chartGroupIndex)

Sets in which group area to place the chart. Use the getChartReportArea method to determine if the chart appears in the report's group area. If it does, you can then use the setChartGroupIndex method to specify the group area in which to place the chart.

Parameters:
chartGroupIndex - An int that specifies in which group area to place the chart.

setChartReportArea

void setChartReportArea(AreaSectionKind chartReportArea)

Sets the AreaSectionKind on the report where the chart is located. A report consists of the following kinds of areas:

If a group, summary, or subtotal is added to the report, the program creates two additional sections:

When a group, summary, or subtotal is added, the Group Header area appears directly above the Details area and the Group Footer area appears directly below the Details area.

If you set up additional groups, the program creates new group areas between the Details area and the existing Group Header and Group Footer area(s).

Like the original areas, each of these newly added areas can contain one or more sections. By default, they each contain a single section.

Parameters:
chartReportArea - An AreaSectionKind object that specifies the area on the report where the chart is located.

setChartStyle

void setChartStyle(IChartStyle chartStyle)

Sets an IChartStyle object. The IChartStyle object specifies the chart type (for example, a bar chart or pie chart) that appears on the report and gives you access to the text options for the chart title, subtitle, and footnote.

Parameters:
chartStyle - An IChartStyle object that specifies the chart type that appears on the report.

setGraphicInstance

void setGraphicInstance(GraphicInstance graphicInstance)

getGraphicInstance

GraphicInstance getGraphicInstance()