|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ChartDefinition
public class ChartDefinition
This object implements the type of chart that appears on the report and defines the fields that
are being charted on. When possible, use the IChartDefinition
interface.
Constructor Summary | |
---|---|
ChartDefinition()
|
|
ChartDefinition(IChartDefinition src)
|
Method Summary | |
---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
doControllerModification(java.lang.Object newObject)
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
|
ChartType |
getChartType()
Returns the data that you want the chart type to represent. |
Fields |
getConditionFields()
Deprecated. please use getGroups |
ControllableMixin |
getControllableMixin()
|
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. |
boolean |
hasContent(java.lang.Object srcChartDefinition)
|
boolean |
isDirectlyControllable()
|
void |
onChange(java.util.EventObject event)
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setChartType(ChartType chartType)
Sets the data that you want the chart type to represent. |
void |
setConditionFields(Fields conditionFields)
Deprecated. please use setGroups |
void |
setDataFields(Fields<IField> dataFields)
Sets the fields that indicate what information is plotted as the points on your chart. |
void |
setGroups(Groups groups)
|
void |
setGroupType(ChartGroupType groupType)
Sets the chart group type. |
void |
setLabelField(IField labelFieldOnRecord)
Sets the chart's label field. |
void |
setSeries(Groups series)
|
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ChartDefinition(IChartDefinition src)
public ChartDefinition()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
For internal use only.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public ChartType getChartType()
IChartDefinition
getChartType
in interface IChartDefinition
ChartType
object containing the data that you want the chart type to
represent.public Fields getConditionFields()
IChartDefinition
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.
getConditionFields
in interface IChartDefinition
Fields
object containing the fields that indicate when to plot a point on a
chart.public Fields<IField> getDataFields()
IChartDefinition
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.
getDataFields
in interface IChartDefinition
Fields
object containing the fields that indicate what information is plotted
as the points on your chart.public boolean hasContent(java.lang.Object srcChartDefinition)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setChartType(ChartType chartType)
IChartDefinition
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:
setChartType
in interface IChartDefinition
chartType
- A ChartType
object containing the data that you want the chart type to
represent.public void setConditionFields(Fields conditionFields)
IChartDefinition
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.
setConditionFields
in interface IChartDefinition
conditionFields
- A Fields
object containing the fields that indicate when to plot a point on a
chart.public void setDataFields(Fields<IField> dataFields)
IChartDefinition
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.
setDataFields
in interface IChartDefinition
dataFields
- A Fields
object containing the fields that indicate what information is plotted
as the points on your chart.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public Groups getGroups()
IChartDefinition
getGroups
in interface IChartDefinition
IGroup
objectspublic void setGroups(Groups groups)
public ChartGroupType getGroupType()
IChartDefinition
getGroupType
in interface IChartDefinition
ChartGroupType
ChartGroupType
public void setGroupType(ChartGroupType groupType)
IChartDefinition
setGroupType
in interface IChartDefinition
groupType
- a ChartGroupType
ChartGroupType
public IField getLabelField()
IChartDefinition
ChartGroupType.forEachRecord
.
getLabelField
in interface IChartDefinition
public Groups getSeries()
IChartDefinition
getSeries
in interface IChartDefinition
IGroup
objectspublic void setLabelField(IField labelFieldOnRecord)
IChartDefinition
ChartGroupType.forEachRecord
.
setLabelField
in interface IChartDefinition
labelFieldOnRecord
- the field to use as labelpublic void setSeries(Groups series)
public void onChange(java.util.EventObject event)
public void doControllerModification(java.lang.Object newObject)
public ControllableMixin getControllableMixin()
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |