com.f1j.ss
Class GRChart

java.lang.Object
  |
  +--com.actuate.util.Debug
        |
        +--com.f1j.util.Debug
              |
              +--com.f1j.util.ObjConst
                    |
                    +--com.f1j.util.Obj
                          |
                          +--com.f1j.ss.GRObject
                                |
                                +--com.f1j.ss.GRChart

Deprecated. Replaced by FcChart.

public class GRChart

extends GRObject

implements Constants

This class provides methods for manipulating chart objects in the worksheet.

See Also:

com.f1j.chart

Fields inherited from class com.f1j.ss.GRObject

eArc, eArrowFilled, eArrowHollow, eArrowLarge, eArrowMedium, eArrowNone, eArrowSmall, eButton, eCellNone, eCellText, eCellValue, eChart, eCheckBox, eDropDown, eGroup, eLine, eListBox, eOval, ePicture, ePolygon, eRadioButton, eRectangle, eText

Method Summary

void	addSeries() Deprecated. Replaced by FcChart.addSeries().
java.lang.String	getAxisTitle(short sAxisType, int iAxisIndex) Deprecated. Replaced by FcChart.getAxisTitle(short, int).
java.lang.String	getAxisTitleLocal(short sAxisType, int iAxisIndex) Deprecated. Replaced by FcChart.getAxisTitleLocal(short, int).
java.lang.String	getCategoryFormula() Deprecated. Replaced by FcChart.getCategoryFormula().
java.lang.String	getCategoryFormulaLocal() Deprecated. Replaced by FcChart.getCategoryFormulaLocal().
ChartModel	getChartModel() Deprecated. Replaced by FcChart.getChartModel().
short	getChartType() Deprecated. Replaced by FcChart.getChartType().
FcChart	getFcChart() Deprecated. Returns the FcChart associated with this GRChart.
static GRChart	getGRChart(FcChart chart) Deprecated.
java.lang.String	getLinkRange() Deprecated. Replaced by FcChart.getLinkRange().
java.lang.String	getLinkRangeLocal() Deprecated. Replaced by FcChart.getLinkRangeLocal().
java.lang.String	getSeriesName(int iSeries) Deprecated. Replaced by FcChart.getSeriesName(int).
java.lang.String	getSeriesNameLocal(int iSeries) Deprecated. Replaced by FcChart.getSeriesNameLocal(int).
java.lang.String	getSeriesSizeValueFormula(int iSeries) Deprecated. Replaced by FcChart.getSeriesSizeValueFormula(int).
java.lang.String	getSeriesSizeValueFormulaLocal(int iSeries) Deprecated. Replaced by FcChart.getSeriesSizeValueFormulaLocal(int).
java.lang.String	getSeriesXValueFormula(int iSeries) Deprecated. Replaced by FcChart.getSeriesXValueFormula(int).
java.lang.String	getSeriesXValueFormulaLocal(int iSeries) Deprecated. Replaced by FcChart.getSeriesXValueFormulaLocal(int).
java.lang.String	getSeriesYValueFormula(int iSeries) Deprecated. Replaced by FcChart.getSeriesYValueFormula(int).
java.lang.String	getSeriesYValueFormulaLocal(int iSeries) Deprecated. Replaced by FcChart.getSeriesYValueFormulaLocal(int).
java.lang.String	getTitle() Deprecated. Replaced by FcChart.getTitle().
java.lang.String	getTitleLocal() Deprecated. Replaced by FcChart.getTitleLocal().
boolean	isSeriesInRows() Deprecated. Replaced by FcChart.isSeriesInRows().
void	removeSeries(int iSeries) Deprecated. Replaced by FcChart.removeSeries(int).
void	setAxisTitle(short sAxisType, int iAxisIndex, java.lang.String title) Deprecated. Replaced by FcChart.setAxisTitle(short, int, String).
void	setAxisTitleLocal(short sAxisType, int iAxisIndex, java.lang.String title) Deprecated. Replaced by FcChart.setAxisTitleLocal(short, int, String).
void	setCategoryFormula(java.lang.String formula) Deprecated. Replaced by FcChart.setCategoryFormula(String).
void	setCategoryFormulaLocal(java.lang.String formula) Deprecated. Replaced by FcChart.setCategoryFormulaLocal(String).
void	setChartType(short sType) Deprecated. Replaced by FcChart.setChartType(short).
void	setLinkRange(java.lang.String range, boolean bSeriesInRows) Deprecated. Replaced by FcChart.setLinkRange(String, boolean).
void	setLinkRangeLocal(java.lang.String range, boolean bSeriesInRows) Deprecated. Replaced by FcChart.setLinkRangeLocal(String, boolean).
void	setSeriesName(int iSeries, java.lang.String name) Deprecated. Replaced by FcChart.setSeriesName(int, String).
void	setSeriesNameLocal(int iSeries, java.lang.String name) Deprecated. Replaced by FcChart.setSeriesNameLocal(int, String).
void	setSeriesSizeValueFormula(int iSeries, java.lang.String formula) Deprecated. Replaced by FcChart.setSeriesSizeValueFormula(int, String).
void	setSeriesSizeValueFormulaLocal(int iSeries, java.lang.String formula) Deprecated. Replaced by FcChart.setSeriesSizeValueFormulaLocal(int, String).
void	setSeriesXValueFormula(int iSeries, java.lang.String formula) Deprecated. Replaced by FcChart.setSeriesXValueFormula(int, String).
void	setSeriesXValueFormulaLocal(int iSeries, java.lang.String formula) Deprecated. Replaced by FcChart.setSeriesXValueFormulaLocal(int, String).
void	setSeriesYValueFormula(int iSeries, java.lang.String formula) Deprecated. Replaced by FcChart.setSeriesYValueFormula(int, String).
void	setSeriesYValueFormulaLocal(int iSeries, java.lang.String formula) Deprecated. Replaced by FcChart.setSeriesYValueFormulaLocal(int, String).
void	setTitle(java.lang.String title) Deprecated. Replaced by FcChart.setTitle(String).
void	setTitleLocal(java.lang.String title) Deprecated. Replaced by FcChart.setTitleLocal(String).

Methods inherited from class com.f1j.ss.GRObject

addItem, addObject, allowsMultipleSelections, copy, deleteItem, getArrowLength, getArrowStyle, getArrowWidth, getCell, getCellCol, getCellRow, getCellType, getFontBold, getFontBold, getFontColor, getFontColor, getFontItalic, getFontItalic, getFontName, getFontName, getFontSize, getFontSize, getFontUnderline, getFontUnderline, getGRObject, getHorizontalAlignment, getID, getImage, getImageFileName, getImageURL, getItem, getItemCount, getItems, getLineColor, getLineStyle, getLineWeight, getName, getNextObject, getPattern, getPatternBG, getPatternFG, getPatternURL, getPos, getSelectionCount, getSelections, getSelections, getShape, getText, getType, getValue, getVerticalAlignment, insertItem, isAutoSize, isLineAuto, isSelectable, isValidObjectType, isVisible, removeAllObjects, setArrowLength, setArrowStyle, setArrowWidth, setAutoSize, setCell, setCell, setCell, setCellCol, setCellRow, setCellType, setFontBold, setFontBold, setFontColor, setFontColor, setFontItalic, setFontItalic, setFontName, setFontName, setFontSize, setFontSize, setFontUnderline, setFontUnderline, setHorizontalAlignment, setImage, setImageFileName, setImageURL, setItem, setItems, setLineAuto, setLineColor, setLineStyle, setLineWeight, setMultipleSelections, setName, setPattern, setPatternBG, setPatternFG, setPatternURL, setPoints, setPos, setSelections, setText, setValue, setVerticalAlignment, setVisible

Method Detail

addSeries

public void addSeries()
               throws F1Exception

Deprecated. Replaced by FcChart.addSeries().

Adds a series to the chart.

Note: Series do not appear on a chart until attached to data.

Throws:

F1Exception - if selection is invalid.

See Also:

removeSeries(int iSeries)

getAxisTitle

public java.lang.String getAxisTitle(short sAxisType,
                                     int iAxisIndex)
                              throws F1Exception

Deprecated. Replaced by FcChart.getAxisTitle(short, int).

Returns the title of the specified axis.

Parameters:

sAxisType - a short indicating the axis type. Either eXAxis or eYAxis.

iAxisIndex - an integer indicating which axis. The X axis is always 0 since there's currently only one. Y-Axes can be any number 0 to (Y axis count -1).

Returns:

the axis title as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

setAxisTitle(short sAxisType, int iAxisIndex, String title)

getAxisTitleLocal

public java.lang.String getAxisTitleLocal(short sAxisType,
                                          int iAxisIndex)
                                   throws F1Exception

Deprecated. Replaced by FcChart.getAxisTitleLocal(short, int).

Returns the title of the specified axis, in the user's language.

Parameters:

sAxisType - a short indicating the axis type. Either eXAxis.

iAxisIndex - an integer indicating which axis. The X axis is always 0 since there's currently only one. Y-Axes can be any number 0 to (Y axis count -1).

Returns:

the axis title as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

setAxisTitleLocal(short sAxisType, int iAxisIndex, String title)

getCategoryFormula

public java.lang.String getCategoryFormula()
                                    throws F1Exception

Deprecated. Replaced by FcChart.getCategoryFormula().

Returns a formula that the categories are linked to, in U.S. English.

Returns:

the formula that the categories are linked to.

Throws:

F1Exception - if the chart does not use categories.

See Also:

setCategoryFormula(java.lang.String)

getCategoryFormulaLocal

public java.lang.String getCategoryFormulaLocal()
                                         throws F1Exception

Deprecated. Replaced by FcChart.getCategoryFormulaLocal().

Returns a formula that the categories are linked to, in the user's language.

Returns:

the formula that the categories are linked to.

Throws:

F1Exception - if the chart does not use categories.

See Also:

setCategoryFormulaLocal(java.lang.String)

getChartModel

public ChartModel getChartModel()

Deprecated. Replaced by FcChart.getChartModel().

Returns a chart model interface for accessing public API methods.

Returns:

a ChartModel implementation.

See Also:

ChartModel

getChartType

public short getChartType()

Deprecated. Replaced by FcChart.getChartType().

Returns the current chart type.

Returns:

a short indicating the current chart type.

See Also:

setChartType(short)

getFcChart

public FcChart getFcChart()

Deprecated.

Returns the FcChart associated with this GRChart.

Returns:

an instance of the FcChart object.

See Also:

GRObject.getGRObject(com.f1j.drawing.Shape sp)

getGRChart

public static GRChart getGRChart(FcChart chart)

Deprecated.

Returns a GRChart associated with the FcChart.

Parameters:

chart - FcChart

Returns:

an instance of the GRChart object.

See Also:

GRObject.getShape()

getLinkRange

public java.lang.String getLinkRange()

Deprecated. Replaced by FcChart.getLinkRange().

Returns a formula indicating the range that the chart is linked to. This formula can be null if the range is too complex.

Returns:

the formula of the range.

See Also:

setLinkRange(java.lang.String, boolean)

getLinkRangeLocal

public java.lang.String getLinkRangeLocal()

Deprecated. Replaced by FcChart.getLinkRangeLocal().

Returns a formula indicating the range that the chart is linked to, in the user's language. This formula can be null if the range is too complex.

Returns:

the formula of the range.

See Also:

setLinkRangeLocal(java.lang.String, boolean)

getSeriesName

public java.lang.String getSeriesName(int iSeries)
                               throws F1Exception

Deprecated. Replaced by FcChart.getSeriesName(int).

Returns the name of the specified series.

Parameters:

iSeries - an integer indicating which series.

Returns:

the series name as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

setSeriesName(int iSeries, String name)

getSeriesNameLocal

public java.lang.String getSeriesNameLocal(int iSeries)
                                    throws F1Exception

Deprecated. Replaced by FcChart.getSeriesNameLocal(int).

Returns the name of the specified series, in the user's language.

Parameters:

iSeries - an integer indicating the series.

Returns:

the series name as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

setSeriesNameLocal(int iSeries, String name)

getTitle

public java.lang.String getTitle()

Deprecated. Replaced by FcChart.getTitle().

Returns the current chart title.

Returns:

the chart title as a formula or a text string.

See Also:

setTitle(java.lang.String)

getTitleLocal

public java.lang.String getTitleLocal()

Deprecated. Replaced by FcChart.getTitleLocal().

Returns the current chart title, in the user's language.

Returns:

the chart title as a formula or a text string.

See Also:

setTitleLocal(String title)

getSeriesXValueFormula

public java.lang.String getSeriesXValueFormula(int iSeries)
                                        throws F1Exception

Deprecated. Replaced by FcChart.getSeriesXValueFormula(int).

Returns the X axis value formula of the specified series. This method applies to bubble and XY (scatter) charts only.

Parameters:

iSeries - an integer indicating the series.

Returns:

a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use X values.

See Also:

setSeriesXValueFormula(int iSeries, String formula)

getSeriesXValueFormulaLocal

public java.lang.String getSeriesXValueFormulaLocal(int iSeries)
                                             throws F1Exception

Deprecated. Replaced by FcChart.getSeriesXValueFormulaLocal(int).

Returns the X axis value formula of the specified series, in the user's language. This method applies to bubble and XY (scatter) charts only.

Parameters:

iSeries - an integer indicating the series.

Returns:

a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use X values.

See Also:

setSeriesXValueFormulaLocal(int iSeries, String formula)

getSeriesYValueFormula

public java.lang.String getSeriesYValueFormula(int iSeries)
                                        throws F1Exception

Deprecated. Replaced by FcChart.getSeriesYValueFormula(int).

Returns the Y axis value formula of the specified series.

Parameters:

iSeries - an integer indicating the series.

Returns:

a formula indicating the values.

Throws:

F1Exception - if argument is invalid.

See Also:

setSeriesYValueFormula(int iSeries, String formula)

getSeriesYValueFormulaLocal

public java.lang.String getSeriesYValueFormulaLocal(int iSeries)
                                             throws F1Exception

Deprecated. Replaced by FcChart.getSeriesYValueFormulaLocal(int).

Returns the Y axis value formula of the specified series, in the user's language.

Parameters:

iSeries - an integer indicating the series.

Returns:

a formula indicating the values.

Throws:

F1Exception - if argument is invalid.

See Also:

setSeriesYValueFormulaLocal(int iSeries, String formula)

getSeriesSizeValueFormula

public java.lang.String getSeriesSizeValueFormula(int iSeries)
                                           throws F1Exception

Deprecated. Replaced by FcChart.getSeriesSizeValueFormula(int).

Returns the size value formula of the specified series. This method applies to bubble charts only.

Parameters:

iSeries - an integer indicating the series.

Returns:

a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use size values.

See Also:

setSeriesSizeValueFormula(int iSeries, String formula)

getSeriesSizeValueFormulaLocal

public java.lang.String getSeriesSizeValueFormulaLocal(int iSeries)
                                                throws F1Exception

Deprecated. Replaced by FcChart.getSeriesSizeValueFormulaLocal(int).

Returns the size value formula of the specified series, in the user's language. This method applies to bubble charts only.

Parameters:

iSeries - an integer indicating the series.

Returns:

a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use size values.

See Also:

setSeriesSizeValueFormulaLocal(int iSeries, String formula)

isSeriesInRows

public boolean isSeriesInRows()

Deprecated. Replaced by FcChart.isSeriesInRows().

Indicates whether series data is in rows.

Returns:

boolean. true = data is in rows.

removeSeries

public void removeSeries(int iSeries)
                  throws F1Exception

Deprecated. Replaced by FcChart.removeSeries(int).

Removes the specified series.

Parameters:

iSeries - an integer indicating the series.

Throws:

F1Exception - if argument is invalid.

See Also:

addSeries()

setAxisTitle

public void setAxisTitle(short sAxisType,
                         int iAxisIndex,
                         java.lang.String title)
                  throws F1Exception

Deprecated. Replaced by FcChart.setAxisTitle(short, int, String).

Sets the title of the specified axis.

Parameters:

sAxisType - a short indicating the axis type. Either eXAxis.

iAxisIndex - an integer indicating which axis. The X axis is always 0 since there's currently only one. Y-Axes can be any number 0 to (Y axis count -1).

title - the axis title as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

getAxisTitle(short sAxisType, int iAxisIndex)

setAxisTitleLocal

public void setAxisTitleLocal(short sAxisType,
                              int iAxisIndex,
                              java.lang.String title)
                       throws F1Exception

Deprecated. Replaced by FcChart.setAxisTitleLocal(short, int, String).

Sets the title of the specified axis, in the user's language.

Parameters:

sAxisType - a short indicating the axis type. Either eXAxis.

iAxisIndex - an integer indicating which axis. The X axis is always 0 since there's currently only one. Y-Axes can be any number 0 to (Y axis count -1).

title - the axis title as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

getAxisTitleLocal(short sAxisType, int iAxisIndex)

setCategoryFormula

public void setCategoryFormula(java.lang.String formula)
                        throws F1Exception

Deprecated. Replaced by FcChart.setCategoryFormula(String).

Links the chart categories to the specified formula. The formula is in US English.

Parameters:

formula - the formula to link to.

Throws:

F1Exception - if the chart does not use categories or the formula is invalid.

See Also:

getCategoryFormula()

setCategoryFormulaLocal

public void setCategoryFormulaLocal(java.lang.String formula)
                             throws F1Exception

Deprecated. Replaced by FcChart.setCategoryFormulaLocal(String).

Links the chart categories to the specified formula, in the user's language.

Parameters:

formula - the formula to link to.

Throws:

F1Exception - if the chart does not use categories or the formula is invalid.

See Also:

getCategoryFormulaLocal()

setChartType

public void setChartType(short sType)
                  throws F1Exception

Deprecated. Replaced by FcChart.setChartType(short).

Sets the chart type.

Parameters:

sType - the new chart type.

Throws:

F1Exception - if the chart type is invalid.

See Also:

getChartType()

setLinkRange

public void setLinkRange(java.lang.String range,
                         boolean bSeriesInRows)
                  throws F1Exception

Deprecated. Replaced by FcChart.setLinkRange(String, boolean).

Links the chart to the range in the workbook represented by the specified formula. The formula is in US English.

Parameters:

range - string indicating the range to link to.

bSeriesInRows - boolean. Indicates whether to link each series to rows or to columns. true = link to rows.

Throws:

F1Exception - if the formula is invalid.

See Also:

getLinkRange()

setLinkRangeLocal

public void setLinkRangeLocal(java.lang.String range,
                              boolean bSeriesInRows)
                       throws F1Exception

Deprecated. Replaced by FcChart.setLinkRangeLocal(String, boolean).

Links the chart to the range in the workbook represented by the specified formula. The formula is in the user's local language.

Parameters:

range - string indicating the range to link to.

bSeriesInRows - boolean. Indicates whether to link each series to rows or to columns. true = link to rows.

Throws:

F1Exception - if the formula is invalid.

See Also:

getLinkRangeLocal()

setSeriesName

public void setSeriesName(int iSeries,
                          java.lang.String name)
                   throws F1Exception

Deprecated. Replaced by FcChart.setSeriesName(int, String).

Sets the name of the specified series.

Parameters:

iSeries - an integer indicating the series.

name - the series name as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

getSeriesName(int iSeries)

setSeriesNameLocal

public void setSeriesNameLocal(int iSeries,
                               java.lang.String name)
                        throws F1Exception

Deprecated. Replaced by FcChart.setSeriesNameLocal(int, String).

Sets the name of the specified series, in the user's language.

Parameters:

iSeries - an integer indicating the series.

name - the series name as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

getSeriesNameLocal(int iSeries)

setTitle

public void setTitle(java.lang.String title)
              throws F1Exception

Deprecated. Replaced by FcChart.setTitle(String).

Sets the chart title.

Parameters:

title - the chart title as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

getTitle()

setTitleLocal

public void setTitleLocal(java.lang.String title)
                   throws F1Exception

Deprecated. Replaced by FcChart.setTitleLocal(String).

Sets the chart title in the user's language.

Parameters:

title - the chart title as a formula or a text string.

Throws:

F1Exception - if argument is invalid.

See Also:

getTitleLocal()

setSeriesXValueFormula

public void setSeriesXValueFormula(int iSeries,
                                   java.lang.String formula)
                            throws F1Exception

Deprecated. Replaced by FcChart.setSeriesXValueFormula(int, String).

Sets the X axis value formula of the specified series. This method applies to bubble and XY (scatter) charts only.

Parameters:

iSeries - an integer indicating the series.

formula - a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use X values.

See Also:

getSeriesXValueFormula(int iSeries)

setSeriesXValueFormulaLocal

public void setSeriesXValueFormulaLocal(int iSeries,
                                        java.lang.String formula)
                                 throws F1Exception

Deprecated. Replaced by FcChart.setSeriesXValueFormulaLocal(int, String).

Sets the X axis value formula of the specified series, in the user's language. This method applies to bubble and XY (scatter) charts only.

Parameters:

iSeries - an integer indicating the series.

formula - a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use X values.

See Also:

getSeriesXValueFormulaLocal(int iSeries)

setSeriesYValueFormula

public void setSeriesYValueFormula(int iSeries,
                                   java.lang.String formula)
                            throws F1Exception

Deprecated. Replaced by FcChart.setSeriesYValueFormula(int, String).

Sets the Y axis value formula of the specified series.

Parameters:

iSeries - an integer indicating the series.

formula - a formula indicating the values.

Throws:

F1Exception - if argument is invalid.

See Also:

getSeriesYValueFormula(int iSeries)

setSeriesYValueFormulaLocal

public void setSeriesYValueFormulaLocal(int iSeries,
                                        java.lang.String formula)
                                 throws F1Exception

Deprecated. Replaced by FcChart.setSeriesYValueFormulaLocal(int, String).

Sets the Y axis value formula of the specified series, in the user's language.

Parameters:

iSeries - an integer indicating the series.

formula - a formula indicating the values.

Throws:

F1Exception - if argument is invalid.

See Also:

getSeriesYValueFormulaLocal(int iSeries)

setSeriesSizeValueFormula

public void setSeriesSizeValueFormula(int iSeries,
                                      java.lang.String formula)
                               throws F1Exception

Deprecated. Replaced by FcChart.setSeriesSizeValueFormula(int, String).

Sets the size value formula of the specified series. This method applies to bubble charts only.

Parameters:

iSeries - an integer indicating the series.

formula - a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use size values.

See Also:

getSeriesSizeValueFormula(int iSeries)

setSeriesSizeValueFormulaLocal

public void setSeriesSizeValueFormulaLocal(int iSeries,
                                           java.lang.String formula)
                                    throws F1Exception

Deprecated. Replaced by FcChart.setSeriesSizeValueFormulaLocal(int, String).

Sets the size value formula of the specified series, in the user's language. This method applies to bubble charts only.

Parameters:

iSeries - an integer indicating the series.

formula - a formula indicating the values.

Throws:

F1Exception - if argument is invalid or series does not use size values.

See Also:

getSeriesSizeValueFormulaLocal(int iSeries)