|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectObj
com.jxcell.GRObject
com.jxcell.GRChart
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 java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final short eChartColumn
public static final short eChartLine
public static final short eChartArea
public static final short eChartStep
public static final short eChartBar
public static final short eChartCombination
public static final short eChartPie
public static final short eChartDoughnut
public static final short eChartScatter
public static final short eChartBubble
public static final short eXAxis
public static final short eYAxis
Constructor Detail |
public GRChart(FcChartImpl fcchartimpl)
Method Detail |
public ChartModelImpl getChartModel()
public FcChartImpl.API getFcChart()
public JChart getJChart()
public static GRChart getGRChart(FcChartImpl.API fcchart)
public FcChartImpl getFcChartImpl()
public FcChartImpl getChartX()
public void addSeries()
public java.lang.String getCategoryFormula()
public java.lang.String getCategoryFormulaLocal()
public short getChartType()
public int getDataPointCount(int index)
public java.lang.String getLinkRange()
public java.lang.String getLinkRangeLocal()
public int getSeriesCount()
public java.lang.String getSeriesXValueFormula(int iSeries)
iSeries
- An integer indicating the series
public java.lang.String getSeriesXValueFormulaLocal(int iSeries)
iSeries
- An integer indicating the series
public java.lang.String getSeriesYValueFormula(int iSeries)
iSeries
- An integer indicating the series
public java.lang.String getSeriesYValueFormulaLocal(int iSeries)
iSeries
- An integer indicating the series
public java.lang.String getSeriesSizeValueFormula(int iSeries)
iSeries
- An integer indicating the series
public java.lang.String getSeriesSizeValueFormulaLocal(int iSeries)
iSeries
- An integer indicating the series
public boolean isSeriesInRows()
public void removeSeries(int iSeries)
iSeries
- An integer indicating the seriespublic void setCategoryFormula(java.lang.String formula) throws CellException
formula
- The formula to link to
CellException
- if the chart does not use categories or the formula is invalidpublic void setCategoryFormulaLocal(java.lang.String formula) throws CellException
formula
- The formula to link to
CellException
- if the chart does not use categories or the formula is invalidpublic void setChartType(short sType) throws CellException
sType
- The new chart type
CellException
- if the chart type is invalidpublic void setChart3DType(short sType) throws CellException
CellException
public void setLinkRange(java.lang.String range, boolean bSeriesInRows) throws CellException
range
- String indicating the range to link to.bSeriesInRows
- boolean indicating whether to link each series to rows or to columns.
CellException
- if the formula is invalidpublic void setLinkRangeLocal(java.lang.String range, boolean bSeriesInRows) throws CellException
range
- String indicating the range to link tobSeriesInRows
- boolean indicating whether to link each series to rows or to columns.
CellException
- if the formula is invalidpublic java.lang.String getTitle()
public void setTitle(java.lang.String title) throws CellException
title
- The chart title as a formula or a text string
CellException
public void setSeriesXValueFormula(int iSeries, java.lang.String formula) throws CellException
iSeries
- An integer indicating the seriesformula
- A formula indicating the values
CellException
- if argument is invalid or series does not use X valuespublic void setSeriesXValueFormulaLocal(int iSeries, java.lang.String formula) throws CellException
iSeries
- An integer indicating the seriesformula
- A formula indicating the values
CellException
- if argument is invalid or series does not use X valuespublic void setSeriesYValueFormula(int iSeries, java.lang.String formula) throws CellException
iSeries
- An integer indicating the seriesformula
- A formula indicating the values
CellException
- if argument is invalidpublic void setSeriesYValueFormulaLocal(int iSeries, java.lang.String formula) throws CellException
iSeries
- An integer indicating the seriesformula
- A formula indicating the values
CellException
- if argument is invalidpublic void setSeriesSizeValueFormula(int iSeries, java.lang.String formula) throws CellException
iSeries
- An integer indicating the seriesformula
- A formula indicating the values
CellException
- if argument is invalid or series does not use size valuespublic void setSeriesSizeValueFormulaLocal(int iSeries, java.lang.String formula) throws CellException
iSeries
- An integer indicating the seriesformula
- A formula indicating the values
CellException
- if argument is invalid or series does not use size valuespublic boolean usesXValues()
public boolean usesZValues()
public void initData(RangeRef rangeData1, boolean seriesinrow)
rangeData1
- - identifies the initial data rangeseriesinrow
- - identifies the series direction in data rangepublic java.lang.String getSeriesFormula(int iSeries) throws CellException
iSeries
- An integer indicating which series
CellException
- cellexceptionpublic java.lang.String getSeriesFormulaLocal(int iSeries) throws CellException
iSeries
- An integer indicating the series
CellException
- cellexceptionpublic java.lang.String getSeriesName(int iSeries) throws CellException
iSeries
- An integer indicating the series
CellException
- cellexceptionpublic void setSeriesName(int iSeries, java.lang.String name) throws CellException
iSeries
- An integer indicating the seriesname
- The series name as a formula or a text string
CellException
- cellexceptionpublic void setSeriesNameLocal(int iSeries, java.lang.String name) throws CellException
iSeries
- An integer indicating the seriesname
- The series name as a formula or a text string
CellException
- cellexceptionpublic java.lang.String getCategoryName(int index)
index
- An integer indicating the Category
public void setStack(boolean stack)
stack
- true or falsepublic void setPercent(boolean percent)
percent
- true or falsepublic void setVaryColors(boolean varyColors)
varyColors
- true or falsepublic void setBarGapRatio(int ratio)
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.public void setDataLableType(int type)
type
- A constant designating a data label type.
Data Label Type Constants ChartFormat
DataLabelCategory DataLabelCategoryAndPercent DataLabelBubbleSize
DataLabelNone DataLabelValue DataLabelPercent
CellException
public ChartFormat getChartFormat()
public void setChartFormat(ChartFormat format)
format
- a format object used to set and retrieve formatting information for objects in a chart.public ChartFormat getTitleFormat()
public void setTitleFormat(ChartFormat format)
format
- a format object used to set and retrieve formatting information for objects in a chart.public ChartFormat getPlotFormat()
public void setPlotFormat(ChartFormat format)
format
- a format object used to set and retrieve formatting information for objects in a chart.public ChartFormat getLegendFormat()
public void setLegendFormat(ChartFormat format)
format
- a format object used to set and retrieve formatting information for objects in a chart.public boolean isLegendVisible()
public void setLegendVisible(boolean visible)
visible
- true or falsepublic int getLegendPos()
public void setLegendPos(int pos)
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.public java.lang.String getAxisTitle(short sAxisType, int iAxisIndex)
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).
public void setAxisTitle(short sAxisType, int iAxisIndex, java.lang.String title)
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 stringpublic ChartFormat getAxisFormat(short sAxisType, int iAxisIndex)
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).
public void setAxisFormat(short sAxisType, int iAxisIndex, ChartFormat format)
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.public ChartFormat getSeriesFormat(int iSeries)
iSeries
- An integer indicating the series
public void setSeriesFormat(int iSeries, ChartFormat format)
iSeries
- An integer indicating the seriesformat
- a format object used to set and retrieve formatting information for objects in a chart.public ChartFormat getMajorGridFormat(short sAxisType, int iAxisIndex)
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).
public void setMajorGridFormat(short sAxisType, int iAxisIndex, ChartFormat format)
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.public short getSeriesType(int seriesIndex) throws CellException
seriesIndex
- An integer indicating the series. Zero-based index.
CellException
public void setSeriesType(int seriesIndex, int type) throws CellException
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.
CellException
public void setYAxisCount(int i) throws CellException
CellException
public void setSeriesYAxisIndex(int i, int j) throws CellException
CellException
public void setSeriesSmoothedLine(int i) throws CellException
CellException
public void setAutoMaximumScale(short sAxisType, int iAxisIndex, boolean flag) throws CellException
CellException
public void setAutoMinimumScale(short sAxisType, int iAxisIndex, boolean flag) throws CellException
CellException
public void setScaleValueRange(short sAxisType, int iAxisIndex, double dMin, double dMax) throws CellException
CellException
public ChartFormat getDataLabelFormat(int iSeries)
iSeries
- An integer indicating the series
public void setDataLabelFormat(int iSeries, ChartFormat format)
iSeries
- An integer indicating the seriesformat
- a format object used to set and retrieve formatting information for objects in a chart.public ChartFormat getDataLabelFormat(int iSeries, int iPointIndex)
iSeries
- An integer indicating the seriesiPointIndex
- An integer indicating the data point
public void setDataLabelFormat(int iSeries, int iPointIndex, ChartFormat format)
iSeries
- An integer indicating the seriesiPointIndex
- An integer indicating the data pointformat
- a format object used to set and retrieve formatting information for objects in a chart.public int getPieExplosion(int iPointIndex)
iPointIndex
- An integer indicating the data point
public void setPieExplosion(int iPointIndex, int percent)
iPointIndex
- An integer indicating the data pointpercent
- An integer indicating the explosion percentagepublic boolean isLogScale()
public void setLogScale(boolean log)
log
- true or falsepublic void setErrorBars(int seriesIndex, boolean xy, int type, boolean visible, java.lang.String range) throws java.lang.Exception
seriesIndex
- An integer indicating the seriesxy
- false-X true-Ytype
- one or more of the values:1-Plus 2-Minus 3-Bothvisible
- true to display the errorbar,false not shown.range
- Minus or Plus link range
java.lang.Exception
public void setErrorBars(int seriesIndex, boolean xy, int type, boolean visible, int source, int value)
seriesIndex
- An integer indicating the seriesxy
- false-X true-Ytype
- one or more of the values:1-Plus 2-Minus 3-Bothvisible
- true to display the errorbar,false not shown.source
- 1-percentage 2-fixed valuevalue
- the value numberpublic void recalc()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |