com.jxcell
Class GRChart

java.lang.Object
  extended byObj
      extended bycom.jxcell.GRObject
          extended bycom.jxcell.GRChart

public class GRChart
extends GRObject

See Also:
Serialized Form

Field Summary
static short eChartArea
           
static short eChartBar
           
static short eChartBubble
           
static short eChartColumn
           
static short eChartCombination
           
static short eChartDoughnut
           
static short eChartLine
           
static short eChartPie
           
static short eChartScatter
           
static short eChartStep
           
static short eXAxis
           
static short eYAxis
           
 
Fields inherited from class com.jxcell.GRObject
eArc, eArrowFilled, eArrowHollow, eArrowLarge, eArrowMedium, eArrowNone, eArrowSmall, eButton, eCellNone, eCellText, eCellValue, eChart, eCheckBox, eDropDown, eGroup, eLine, eListBox, eOval, ePicture, ePolygon, eRadioButton, eRectangle, eText
 
Constructor Summary
GRChart(FcChartImpl fcchartimpl)
           
 
Method Summary
 void addSeries()
          Adds a series to the chart.
 ChartFormat getAxisFormat(short sAxisType, int iAxisIndex)
          Returns AxisImpl formatting information.
 java.lang.String getAxisTitle(short sAxisType, int iAxisIndex)
          Returns the AxisImpl title
 java.lang.String getCategoryFormula()
          Returns a formula that the categories are linked to, in U.S.
 java.lang.String getCategoryFormulaLocal()
          Returns a formula that the categories are linked to, in the user's language
 java.lang.String getCategoryName(int index)
          Returns the name of the specified Category
 ChartFormat getChartFormat()
          Returns chart formatting information.
 ChartModelImpl getChartModel()
           
 short getChartType()
          Returns the current chart type
 FcChartImpl getChartX()
           
 ChartFormat getDataLabelFormat(int iSeries)
          Returns the data label formatting information of the specified series
 ChartFormat getDataLabelFormat(int iSeries, int iPointIndex)
          Returns the data label formatting information for the specified point of the specified series
 int getDataPointCount(int index)
           
 FcChartImpl.API getFcChart()
           
 FcChartImpl getFcChartImpl()
           
static GRChart getGRChart(FcChartImpl.API fcchart)
           
 JChart getJChart()
           
 ChartFormat getLegendFormat()
          Returns legend formatting information.
 int getLegendPos()
          Returns current legend placement constant.
 java.lang.String getLinkRange()
          Returns a formula indicating the range that the chart is linked to.
 java.lang.String getLinkRangeLocal()
          Returns a formula indicating the range that the chart is linked to, in the user's language.
 ChartFormat getMajorGridFormat(short sAxisType, int iAxisIndex)
          Returns grid line formatting information for the major grid of the specified axis.
 int getPieExplosion(int iPointIndex)
          Returns explosion percentage for the specified data point.
 ChartFormat getPlotFormat()
          Returns plot formatting information.
 int getSeriesCount()
           
 ChartFormat getSeriesFormat(int iSeries)
          Returns the formatting information of the specified series
 java.lang.String getSeriesFormula(int iSeries)
          Returns the name of the specified series
 java.lang.String getSeriesFormulaLocal(int iSeries)
          Returns the name of the specified series, in the user's language
 java.lang.String getSeriesName(int iSeries)
          Returns the name of the specified series
 java.lang.String getSeriesSizeValueFormula(int iSeries)
          Returns the size value formula of the specified series.
 java.lang.String getSeriesSizeValueFormulaLocal(int iSeries)
          Returns the size value formula of the specified series, in the user's language.
 short getSeriesType(int seriesIndex)
          Returns the series type value for the specified series.
 java.lang.String getSeriesXValueFormula(int iSeries)
          Returns the X axis value formula of the specified series.
 java.lang.String getSeriesXValueFormulaLocal(int iSeries)
          Returns the X axis value formula of the specified series, in the user's language.
 java.lang.String getSeriesYValueFormula(int iSeries)
          Returns the Y axis value formula of the specified series
 java.lang.String getSeriesYValueFormulaLocal(int iSeries)
          Returns the Y axis value formula of the specified series, in the user's language
 java.lang.String getTitle()
          Returns the current chart title
 ChartFormat getTitleFormat()
          Returns chart Title formatting information.
 void initData(RangeRef rangeData1, boolean seriesinrow)
          initial chart from range

 boolean isLegendVisible()
          Indicates whether the legend is visible.
 boolean isLogScale()
          Indicates whether the axis is logarithmic.
 boolean isSeriesInRows()
          Indicates whether series data is in rows
 void recalc()
           
 void removeSeries(int iSeries)
          Removes the specified series
 void setAutoMaximumScale(short sAxisType, int iAxisIndex, boolean flag)
           
 void setAutoMinimumScale(short sAxisType, int iAxisIndex, boolean flag)
           
 void setAxisFormat(short sAxisType, int iAxisIndex, ChartFormat format)
          Sets AxisImpl formatting.
 void setAxisTitle(short sAxisType, int iAxisIndex, java.lang.String title)
          Sets the AxisImpl title
 void setBarGapRatio(int ratio)
          Sets the bar gap ratio on a bar or column chart.
 void setCategoryFormula(java.lang.String formula)
          Links the chart categories to the specified formula.
 void setCategoryFormulaLocal(java.lang.String formula)
          Links the chart categories to the specified formula, in the user's language
 void setChart3DType(short sType)
           
 void setChartFormat(ChartFormat format)
          Sets chart formatting.
 void setChartType(short sType)
          Sets the chart type
 void setDataLabelFormat(int iSeries, ChartFormat format)
          Sets the data label formatting information of the specified series
 void setDataLabelFormat(int iSeries, int iPointIndex, ChartFormat format)
          Sets the data label formatting information for the specified point of the specified series
 void setDataLableType(int type)
          Sets the type of data label to use
 void setErrorBars(int seriesIndex, boolean xy, int type, boolean visible, int source, int value)
          set the errorbar informations
 void setErrorBars(int seriesIndex, boolean xy, int type, boolean visible, java.lang.String range)
          set the errorbar informations
 void setLegendFormat(ChartFormat format)
          Sets legend formatting.
 void setLegendPos(int pos)
          Sets legend placement.
 void setLegendVisible(boolean visible)
          Sets whether legend is visible.
 void setLinkRange(java.lang.String range, boolean bSeriesInRows)
          Links the chart to the range in the workbook represented by the specified formula.
 void setLinkRangeLocal(java.lang.String range, boolean bSeriesInRows)
          Links the chart to the range in the workbook represented by the specified formula.
 void setLogScale(boolean log)
          Sets the axis to logarithmic base.
 void setMajorGridFormat(short sAxisType, int iAxisIndex, ChartFormat format)
          Sets AxisImpl grid line formatting.
 void setPercent(boolean percent)
          Sets boolean indicating whether the values in the chart are plotted as percentages of the category.
 void setPieExplosion(int iPointIndex, int percent)
          Sets the explosion percentage of the specified data point.
 void setPlotFormat(ChartFormat format)
          Sets plot formatting.
 void setScaleValueRange(short sAxisType, int iAxisIndex, double dMin, double dMax)
           
 void setSeriesFormat(int iSeries, ChartFormat format)
          Sets the specified series formatting
 void setSeriesName(int iSeries, java.lang.String name)
          Sets the name of the specified series
 void setSeriesNameLocal(int iSeries, java.lang.String name)
          Sets the name of the specified series, in the user's language
 void setSeriesSizeValueFormula(int iSeries, java.lang.String formula)
          Sets the size value formula of the specified series.
 void setSeriesSizeValueFormulaLocal(int iSeries, java.lang.String formula)
          Sets the size value formula of the specified series, in the user's language.
 void setSeriesSmoothedLine(int i)
           
 void setSeriesType(int seriesIndex, int type)
          Sets the series type of the specified series.
 void setSeriesXValueFormula(int iSeries, java.lang.String formula)
          Sets the X axis value formula of the specified series.
 void setSeriesXValueFormulaLocal(int iSeries, java.lang.String formula)
          Sets the X axis value formula of the specified series, in the user's language.
 void setSeriesYAxisIndex(int i, int j)
           
 void setSeriesYValueFormula(int iSeries, java.lang.String formula)
          Sets the Y axis value formula of the specified series
 void setSeriesYValueFormulaLocal(int iSeries, java.lang.String formula)
          Sets the Y axis value formula of the specified series, in the user's language
 void setStack(boolean stack)
          Sets the plot to display stacked series.
 void setTitle(java.lang.String title)
          Sets the chart title
 void setTitleFormat(ChartFormat format)
          Sets chart Title formatting.
 void setVaryColors(boolean varyColors)
          Sets a boolean indicating whether the series in the chart use varied colors.
 void setYAxisCount(int i)
           
 boolean usesXValues()
           
 boolean usesZValues()
           
 
Methods inherited from class com.jxcell.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, getFormat, getGRObject, getHorizontalAlignment, getID, getImage, getImageFileName, getImageURL, getItem, getItemCount, getItems, getLineColor, getLineStyle, getLineWeight, getName, getNextObject, getPattern, getPatternBG, getPatternFG, getPatternURL, getPos, getSelectionCount, getSelections, getSelections, getShape, getShapeImpl, 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, setFormat, setHorizontalAlignment, setImage, setImage, setImageFileName, setImageURL, setItem, setItems, setLineAuto, setLineColor, setLineStyle, setLineWeight, setMultipleSelections, setName, setPattern, setPatternBG, setPatternFG, setPatternURL, setPoints, setPos, setSelections, setText, setValidationItems, setValue, setVerticalAlignment, setVisible
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

eChartColumn

public static final short eChartColumn
See Also:
Constant Field Values

eChartLine

public static final short eChartLine
See Also:
Constant Field Values

eChartArea

public static final short eChartArea
See Also:
Constant Field Values

eChartStep

public static final short eChartStep
See Also:
Constant Field Values

eChartBar

public static final short eChartBar
See Also:
Constant Field Values

eChartCombination

public static final short eChartCombination
See Also:
Constant Field Values

eChartPie

public static final short eChartPie
See Also:
Constant Field Values

eChartDoughnut

public static final short eChartDoughnut
See Also:
Constant Field Values

eChartScatter

public static final short eChartScatter
See Also:
Constant Field Values

eChartBubble

public static final short eChartBubble
See Also:
Constant Field Values

eXAxis

public static final short eXAxis
See Also:
Constant Field Values

eYAxis

public static final short eYAxis
See Also:
Constant Field Values
Constructor Detail

GRChart

public GRChart(FcChartImpl fcchartimpl)
Method Detail

getChartModel

public ChartModelImpl getChartModel()

getFcChart

public FcChartImpl.API getFcChart()

getJChart

public JChart getJChart()

getGRChart

public static GRChart getGRChart(FcChartImpl.API fcchart)

getFcChartImpl

public FcChartImpl getFcChartImpl()

getChartX

public FcChartImpl getChartX()

addSeries

public void addSeries()
Adds a series to the chart. Note that series do not appear on a chart until attached to data.


getCategoryFormula

public java.lang.String getCategoryFormula()
Returns a formula that the categories are linked to, in U.S. English

Returns:
if the chart does not use categories

getCategoryFormulaLocal

public java.lang.String getCategoryFormulaLocal()
Returns a formula that the categories are linked to, in the user's language

Returns:
the formula that the categories are linked to

getChartType

public short getChartType()
Returns the current chart type

Returns:
a short indicating the current chart type

getDataPointCount

public int getDataPointCount(int index)

getLinkRange

public java.lang.String 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

getLinkRangeLocal

public java.lang.String 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

getSeriesCount

public int getSeriesCount()

getSeriesXValueFormula

public java.lang.String getSeriesXValueFormula(int iSeries)
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

getSeriesXValueFormulaLocal

public java.lang.String getSeriesXValueFormulaLocal(int iSeries)
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

getSeriesYValueFormula

public java.lang.String getSeriesYValueFormula(int iSeries)
Returns the Y axis value formula of the specified series

Parameters:
iSeries - An integer indicating the series
Returns:
a formula indicating the values

getSeriesYValueFormulaLocal

public java.lang.String getSeriesYValueFormulaLocal(int iSeries)
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

getSeriesSizeValueFormula

public java.lang.String getSeriesSizeValueFormula(int iSeries)
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

getSeriesSizeValueFormulaLocal

public java.lang.String getSeriesSizeValueFormulaLocal(int iSeries)
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

isSeriesInRows

public boolean isSeriesInRows()
Indicates whether series data is in rows

Returns:
true if data is in rows

removeSeries

public void removeSeries(int iSeries)
Removes the specified series

Parameters:
iSeries - An integer indicating the series

setCategoryFormula

public void setCategoryFormula(java.lang.String formula)
                        throws CellException
Links the chart categories to the specified formula. The formula is in US English

Parameters:
formula - The formula to link to
Throws:
CellException - if the chart does not use categories or the formula is invalid

setCategoryFormulaLocal

public void setCategoryFormulaLocal(java.lang.String formula)
                             throws CellException
Links the chart categories to the specified formula, in the user's language

Parameters:
formula - The formula to link to
Throws:
CellException - if the chart does not use categories or the formula is invalid

setChartType

public void setChartType(short sType)
                  throws CellException
Sets the chart type

Parameters:
sType - The new chart type
Throws:
CellException - if the chart type is invalid

setChart3DType

public void setChart3DType(short sType)
                    throws CellException
Throws:
CellException

setLinkRange

public void setLinkRange(java.lang.String range,
                         boolean bSeriesInRows)
                  throws CellException
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 indicating whether to link each series to rows or to columns.
Throws:
CellException - if the formula is invalid

setLinkRangeLocal

public void setLinkRangeLocal(java.lang.String range,
                              boolean bSeriesInRows)
                       throws CellException
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 indicating whether to link each series to rows or to columns.
Throws:
CellException - if the formula is invalid

getTitle

public java.lang.String getTitle()
Returns the current chart title

Returns:
the chart title as a formula or a text string

setTitle

public void setTitle(java.lang.String title)
              throws CellException
Sets the chart title

Parameters:
title - The chart title as a formula or a text string
Throws:
CellException

setSeriesXValueFormula

public void setSeriesXValueFormula(int iSeries,
                                   java.lang.String formula)
                            throws CellException
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:
CellException - if argument is invalid or series does not use X values

setSeriesXValueFormulaLocal

public void setSeriesXValueFormulaLocal(int iSeries,
                                        java.lang.String formula)
                                 throws CellException
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:
CellException - if argument is invalid or series does not use X values

setSeriesYValueFormula

public void setSeriesYValueFormula(int iSeries,
                                   java.lang.String formula)
                            throws CellException
Sets the Y axis value formula of the specified series

Parameters:
iSeries - An integer indicating the series
formula - A formula indicating the values
Throws:
CellException - if argument is invalid

setSeriesYValueFormulaLocal

public void setSeriesYValueFormulaLocal(int iSeries,
                                        java.lang.String formula)
                                 throws CellException
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:
CellException - if argument is invalid

setSeriesSizeValueFormula

public void setSeriesSizeValueFormula(int iSeries,
                                      java.lang.String formula)
                               throws CellException
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:
CellException - if argument is invalid or series does not use size values

setSeriesSizeValueFormulaLocal

public void setSeriesSizeValueFormulaLocal(int iSeries,
                                           java.lang.String formula)
                                    throws CellException
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:
CellException - if argument is invalid or series does not use size values

usesXValues

public boolean usesXValues()

usesZValues

public boolean usesZValues()

initData

public void initData(RangeRef rangeData1,
                     boolean seriesinrow)
initial chart from range

Parameters:
rangeData1 - - identifies the initial data range
seriesinrow - - identifies the series direction in data range

getSeriesFormula

public java.lang.String getSeriesFormula(int iSeries)
                                  throws CellException
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:
CellException - cellexception

getSeriesFormulaLocal

public java.lang.String getSeriesFormulaLocal(int iSeries)
                                       throws CellException
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:
CellException - cellexception

getSeriesName

public java.lang.String getSeriesName(int iSeries)
                               throws CellException
Returns the name of the specified series

Parameters:
iSeries - An integer indicating the series
Returns:
the series name
Throws:
CellException - cellexception

setSeriesName

public void setSeriesName(int iSeries,
                          java.lang.String name)
                   throws CellException
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:
CellException - cellexception

setSeriesNameLocal

public void setSeriesNameLocal(int iSeries,
                               java.lang.String name)
                        throws CellException
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:
CellException - cellexception

getCategoryName

public java.lang.String getCategoryName(int index)
Returns the name of the specified Category

Parameters:
index - An integer indicating the Category
Returns:
the Category name

setStack

public void setStack(boolean stack)
Sets the plot to display stacked series.

Parameters:
stack - true or false

setPercent

public void setPercent(boolean percent)
Sets boolean indicating whether the values in the chart are plotted as percentages of the category.

Parameters:
percent - true or false

setVaryColors

public void setVaryColors(boolean varyColors)
Sets a boolean indicating whether the series in the chart use varied colors. By default, each series is set to a single color. Charts with only one series can be set to automatically vary colors to help emphasize the difference between data points.

Parameters:
varyColors - true or false

setBarGapRatio

public void setBarGapRatio(int ratio)
Sets the bar gap ratio on a bar or column chart.

Parameters:
ratio - An integer between -100 and 100. The integer (default = 100) describes the space between bars in a category. Positive integers indicate the space between bars or categories; negative integers indicate the overlap between bars. 100 = spaces are the same size as bars. 0 = no space. -100 = complete overlap.

setDataLableType

public void setDataLableType(int type)
Sets the type of data label to use

Parameters:
type - A constant designating a data label type. Data Label Type Constants ChartFormat DataLabelCategory DataLabelCategoryAndPercent DataLabelBubbleSize DataLabelNone DataLabelValue DataLabelPercent
Throws:
CellException

getChartFormat

public ChartFormat getChartFormat()
Returns chart formatting information.

Returns:
a format object. After setting formats in a format object, calling the corresponding set method applies new formatting.

setChartFormat

public void setChartFormat(ChartFormat format)
Sets chart formatting.

Parameters:
format - a format object used to set and retrieve formatting information for objects in a chart.

getTitleFormat

public ChartFormat getTitleFormat()
Returns chart Title formatting information.

Returns:
a format object. After setting formats in a format object, calling the corresponding set method applies new formatting.

setTitleFormat

public void setTitleFormat(ChartFormat format)
Sets chart Title formatting.

Parameters:
format - a format object used to set and retrieve formatting information for objects in a chart.

getPlotFormat

public ChartFormat getPlotFormat()
Returns plot formatting information.

Returns:
a format object. After setting formats in a format object, calling the corresponding set method applies new formatting.

setPlotFormat

public void setPlotFormat(ChartFormat format)
Sets plot formatting.

Parameters:
format - a format object used to set and retrieve formatting information for objects in a chart.

getLegendFormat

public ChartFormat getLegendFormat()
Returns legend formatting information.

Returns:
a format object. After setting formats in a format object, calling the corresponding set method applies new formatting.

setLegendFormat

public void setLegendFormat(ChartFormat format)
Sets legend formatting.

Parameters:
format - a format object used to set and retrieve formatting information for objects in a chart.

isLegendVisible

public boolean isLegendVisible()
Indicates whether the legend is visible.

Returns:
true or false.

setLegendVisible

public void setLegendVisible(boolean visible)
Sets whether legend is visible.

Parameters:
visible - true or false

getLegendPos

public int getLegendPos()
Returns current legend placement constant.

Returns:
a short indicating placement. eLegendPlacementBottom - Legend is centered at the bottom. eLegendPlacementCorner - Legend is positioned in the upper right corner. eLegendPlacementLeft - Legend is centered to the left. eLegendPlacementRight - Legend is centered to the right. eLegendPlacementTop - Legend is centered at the top.

setLegendPos

public void setLegendPos(int pos)
Sets legend placement.

Parameters:
pos - A constant indicating position of the legend on the chart. eLegendPlacementBottom - Legend is centered at the bottom. eLegendPlacementCorner - Legend is positioned in the upper right corner. eLegendPlacementLeft - Legend is centered to the left. eLegendPlacementRight - Legend is centered to the right. eLegendPlacementTop - Legend is centered at the top.

getAxisTitle

public java.lang.String getAxisTitle(short sAxisType,
                                     int iAxisIndex)
Returns the AxisImpl title

Parameters:
sAxisType - 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 AxisImpl title as a formula or a text string

setAxisTitle

public void setAxisTitle(short sAxisType,
                         int iAxisIndex,
                         java.lang.String title)
Sets the AxisImpl title

Parameters:
sAxisType - 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).
title - The AxisImpl title as a formula or a text string

getAxisFormat

public ChartFormat getAxisFormat(short sAxisType,
                                 int iAxisIndex)
Returns AxisImpl formatting information.

Parameters:
sAxisType - 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:
a format object. After setting formats in a format object, calling the corresponding set method applies new formatting.

setAxisFormat

public void setAxisFormat(short sAxisType,
                          int iAxisIndex,
                          ChartFormat format)
Sets AxisImpl formatting.

Parameters:
sAxisType - 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).
format - a format object used to set and retrieve formatting information for objects in a chart.

getSeriesFormat

public ChartFormat getSeriesFormat(int iSeries)
Returns the formatting information of the specified series

Parameters:
iSeries - An integer indicating the series
Returns:
format object.

setSeriesFormat

public void setSeriesFormat(int iSeries,
                            ChartFormat format)
Sets the specified series formatting

Parameters:
iSeries - An integer indicating the series
format - a format object used to set and retrieve formatting information for objects in a chart.

getMajorGridFormat

public ChartFormat getMajorGridFormat(short sAxisType,
                                      int iAxisIndex)
Returns grid line formatting information for the major grid of the specified axis.

Parameters:
sAxisType - 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:
a format object. After setting formats in a format object, calling the corresponding set method applies new formatting.

setMajorGridFormat

public void setMajorGridFormat(short sAxisType,
                               int iAxisIndex,
                               ChartFormat format)
Sets AxisImpl grid line formatting.

Parameters:
sAxisType - 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).
format - a format object used to set and retrieve formatting information for objects in a chart.

getSeriesType

public short getSeriesType(int seriesIndex)
                    throws CellException
Returns the series type value for the specified series.

Parameters:
seriesIndex - An integer indicating the series. Zero-based index.
Returns:
a short indicating series type. Series Type Constants eChartArea eChartBar eChartBubble eChartColumn eChartCombination eChartDoughnut eChartLine eChartPie eChartScatter eChartStep
Throws:
CellException

setSeriesType

public void setSeriesType(int seriesIndex,
                          int type)
                   throws CellException
Sets the series type of the specified series.

Parameters:
seriesIndex - An integer indicating the series. Zero-based index.
type - A constant designating a series type. eChartStep eChartArea eChartColumn eChartLine The chart must be a combination chart and one of the above constants must be used or this method throws an exception.
Throws:
CellException

setYAxisCount

public void setYAxisCount(int i)
                   throws CellException
Throws:
CellException

setSeriesYAxisIndex

public void setSeriesYAxisIndex(int i,
                                int j)
                         throws CellException
Throws:
CellException

setSeriesSmoothedLine

public void setSeriesSmoothedLine(int i)
                           throws CellException
Throws:
CellException

setAutoMaximumScale

public void setAutoMaximumScale(short sAxisType,
                                int iAxisIndex,
                                boolean flag)
                         throws CellException
Throws:
CellException

setAutoMinimumScale

public void setAutoMinimumScale(short sAxisType,
                                int iAxisIndex,
                                boolean flag)
                         throws CellException
Throws:
CellException

setScaleValueRange

public void setScaleValueRange(short sAxisType,
                               int iAxisIndex,
                               double dMin,
                               double dMax)
                        throws CellException
Throws:
CellException

getDataLabelFormat

public ChartFormat getDataLabelFormat(int iSeries)
Returns the data label formatting information of the specified series

Parameters:
iSeries - An integer indicating the series
Returns:
format object.

setDataLabelFormat

public void setDataLabelFormat(int iSeries,
                               ChartFormat format)
Sets the data label formatting information of the specified series

Parameters:
iSeries - An integer indicating the series
format - a format object used to set and retrieve formatting information for objects in a chart.

getDataLabelFormat

public ChartFormat getDataLabelFormat(int iSeries,
                                      int iPointIndex)
Returns the data label formatting information for the specified point of the specified series

Parameters:
iSeries - An integer indicating the series
iPointIndex - An integer indicating the data point
Returns:
format object.

setDataLabelFormat

public void setDataLabelFormat(int iSeries,
                               int iPointIndex,
                               ChartFormat format)
Sets the data label formatting information for the specified point of the specified series

Parameters:
iSeries - An integer indicating the series
iPointIndex - An integer indicating the data point
format - a format object used to set and retrieve formatting information for objects in a chart.

getPieExplosion

public int getPieExplosion(int iPointIndex)
Returns explosion percentage for the specified data point.

Parameters:
iPointIndex - An integer indicating the data point
Returns:
an integer indicating explosion percentage of the specified data point

setPieExplosion

public void setPieExplosion(int iPointIndex,
                            int percent)
Sets the explosion percentage of the specified data point.

Parameters:
iPointIndex - An integer indicating the data point
percent - An integer indicating the explosion percentage

isLogScale

public boolean isLogScale()
Indicates whether the axis is logarithmic.

Returns:
true or false

setLogScale

public void setLogScale(boolean log)
Sets the axis to logarithmic base.

Parameters:
log - true or false

setErrorBars

public void setErrorBars(int seriesIndex,
                         boolean xy,
                         int type,
                         boolean visible,
                         java.lang.String range)
                  throws java.lang.Exception
set the errorbar informations

Parameters:
seriesIndex - An integer indicating the series
xy - false-X true-Y
type - one or more of the values:1-Plus 2-Minus 3-Both
visible - true to display the errorbar,false not shown.
range - Minus or Plus link range
Throws:
java.lang.Exception

setErrorBars

public void setErrorBars(int seriesIndex,
                         boolean xy,
                         int type,
                         boolean visible,
                         int source,
                         int value)
set the errorbar informations

Parameters:
seriesIndex - An integer indicating the series
xy - false-X true-Y
type - one or more of the values:1-Plus 2-Minus 3-Both
visible - true to display the errorbar,false not shown.
source - 1-percentage 2-fixed value
value - the value number

recalc

public void recalc()