|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IChartObject
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 |
---|
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.
IChartDefinition
object that specifies the type of chart that appears on the
report.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.
int
that specifies in which group area to place the chart.AreaSectionKind getChartReportArea()
Returns the AreaSectionKind
on the report where the chart is located.
A report consists of the following kinds of areas:
This section is generally used for the report title and other information you want to appear at the beginning of the report. It can also be used for charts that include data for the entire report.
This section is generally used for information that you want to appear at the top of each page. This can include such things as chapter names, the name of the document, and other similar information. This section can also be used to display field titles above the fields on a report.
This section is used for the body of the report and is printed once per record. The bulk of the report data generally appears in this section.
This section is used for information you want to appear only once at the end of the report (such as grand totals) and for charts that include data for the entire report.
This section usually contains the page number and any other information you want to appear on the bottom of each page.
If a group, summary, or subtotal is added to the report, the program creates two additional sections:
This section typically holds the group name field and can be used to display charts that include data specific to the group. It is printed once at the beginning of a group.
This section generally holds the summary value, if any, and can be used to display charts. It is printed once at the end of a group.
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.
AreaSectionKind
object that specifies the area on the report where the
chart is located.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.
IChartStyle
object that specifies the chart type that appears on the report.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.
chartDefinition
- An IChartDefinition
object that specifies the type of chart that appears on the
report.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.
chartGroupIndex
- An int
that specifies in which group area to place the chart.void setChartReportArea(AreaSectionKind chartReportArea)
Sets the AreaSectionKind
on the report where the chart is located. A report
consists of the following kinds of areas:
This section is generally used for the report title and other information you want to appear . at the beginning of the report. It can also be used for charts that include data for the entire report.
This section is generally used for information that you want to appear at the top of each page. This can include such things as chapter names, the name of the document, and other similar information. This section can also be used to display field titles above the fields on a report.
This section is used for the body of the report and is printed once per record. The bulk of the report data generally appears in this section.
This section is used for information you want to appear only once at the end of the report (such as grand totals) and for charts that include data for the entire report.
This section usually contains the page number and any other information you want to appear on the bottom of each page.
If a group, summary, or subtotal is added to the report, the program creates two additional sections:
This section typically holds the group name field and can be used to display charts that include data specific to the group. It is printed once at the beginning of a group.
This section generally holds the summary value, if any, and can be used to display charts. It is printed once at the end of a group.
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.
chartReportArea
- An AreaSectionKind
object that specifies the area on the report where the
chart is located.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.
chartStyle
- An IChartStyle
object that specifies the chart type that appears on the report.void setGraphicInstance(GraphicInstance graphicInstance)
GraphicInstance getGraphicInstance()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |