ActiveXLS v6.4.0 API Documentation

ActiveXLS.Charts
Class ExcelChart

System.Object
  extended byActiveXLS.Charts.ExcelChart

public class ExcelChart
extends System.Object

This class stores chart information like series, legend, axis, plot area, chart area, data table, title, series gap and overlap, 3D perspective, 3D elevation, 3D rotation and 3D height.


Constructor Summary
ExcelChart()
          Defines an instance of the chart.
ExcelChart(int row, int column)
          Defines an instance of the chart having the specified location
This constructor is applicable only to adding charts to ExcelWorksheet objects
ExcelChart(int row, int column, int width, int height)
          Defines an instance of the chart having the specified location and size
This constructor is applicable only to adding charts to ExcelWorksheet objects
ExcelChart(System.String position)
          Defines an instance of the chart having the specified location
This constructor is applicable only to adding charts to ExcelWorksheet objects
ExcelChart(System.String position, int width, int height)
          Defines an instance of the chart having the specified location and size
This constructor is applicable only to adding charts to ExcelWorksheet objects
 
Method Summary
 ExcelChart Clone()
          Creates and returns a copy of this object.
 void Dispose()
          Disposes the allocated resources.
 void esd_addSeries(ExcelSeries xlsChartSeries)
          Adds a new series to the chart.
 void esd_addSeries(System.String seriesName, System.String seriesValues)
          Adds a new series to the chart.
 int esd_get3DElevation()
          Returns the 3D elevation setting of the chart.
 int esd_get3DHeight()
          Returns the 3D height setting of the chart.
 int esd_get3DPerspective()
          Returns the 3D perspective setting of the chart.
 int esd_get3DRotation()
          Returns the 3D rotation setting of the chart.
 ExcelAxis esd_getCategoryXAxis()
          Returns the chart category X axis.
 System.String esd_getCategoryXAxisLabels()
          Returns the labels of category X axis.
 ExcelChartArea esd_getChartArea()
          Returns the chart area.
 ExcelDataTable esd_getChartDataTable()
          Returns the chart data table.
 int esd_getChartType()
          Returns the type of the chart.
 ExcelChartLegend esd_getLegend()
          Returns the chart legend.
 ExcelPlotArea esd_getPlotArea()
          Returns the chart plot area.
 ExcelSeries esd_getSeriesAt(int index)
          Returns the series from the specified index.
 int esd_getSeriesGap()
          Returns the gap of the chart series.
 int esd_getSeriesOverlap()
          Returns the overlap of the chart series.
 System.String esd_getTitle()
          Returns the chart title.
 ExcelAxis esd_getValueYAxis()
          Returns the chart value Y axis.
 ExcelChartGridlines esd_getXAxisMajorGridlines()
          Returns the style of the major gridlines for the X axis.
 ExcelChartGridlines esd_getXAxisMinorGridlines()
          Returns the style of the minor gridlines for the X axis.
 ExcelChartGridlines esd_getYAxisMajorGridlines()
          Returns the style of the major gridlines for the Y axis.
 ExcelChartGridlines esd_getYAxisMinorGridlines()
          Returns the style of the minor gridlines for the Y axis.
 void esd_removeSeries(int index)
          Removes the series from the specified index.
 void esd_set3DElevation(int n3DElevation)
          Sets the 3D elevation setting of the chart.
 void esd_set3DHeight(int n3DHeight)
          Sets the 3D height of the chart.
 void esd_set3DPerspective(int n3DPerspective)
          Sets the 3D perspective of the chart.
 void esd_set3DRotation(int n3DRotation)
          Sets the 3D rotation of the chart.
 void esd_setCategoryXAxis(ExcelAxis xlsCategoryXAxis)
          Sets the chart category X axis.
 void esd_setCategoryXAxisLabels(System.String formulaCategoryXAxisLabels)
          Sets the labels of category X axis.
 void esd_setChartArea(ExcelChartArea xlsChartArea)
          Sets the chart area.
 void esd_setChartDataTable(ExcelDataTable xlsChartDataTable)
          Sets the chart data table.
 void esd_setChartType(int chartType)
          Sets the type of the chart.
 void esd_setLegend(ExcelChartLegend xlsLegend)
          Sets the chart legend.
 void esd_setPlotArea(ExcelPlotArea xlsPlotArea)
          Sets the chart plot area.
 void esd_setSeriesGap(int gap)
          Sets the gap of the chart series.
 void esd_setSeriesOverlap(int overlap)
          Sets the overlap of the chart series.
 void esd_setTitle(System.String title)
          Sets the chart title.
 void esd_setUse3DPerspective(bool use3DPerspective)
          Sets if the 3D setting of the chart is used.
 void esd_setValueYAxis(ExcelAxis xlsValueYAxis)
          Sets the chart value Y axis.
 void esd_setXAxisMajorGridlines(ExcelChartGridlines xlsGridlines)
          Sets the style of the major gridlines for the X axis.
 void esd_setXAxisMinorGridlines(ExcelChartGridlines xlsGridlines)
          Sets the style of the minor gridlines for the X axis.
 void esd_setYAxisMajorGridlines(ExcelChartGridlines xlsGridlines)
          Sets the style of the major gridlines for the Y axis.
 void esd_setYAxisMinorGridlines(ExcelChartGridlines xlsGridlines)
          Sets the style of the major gridlines for the Y axis.
 bool esd_Use3DPerspective()
          Returns if the 3D perspective of the chart is used
 int getHeight()
          Returns the chart height.
 int getHorizontalOffset()
          Returns the chart horizontal offset This method is applicable only to adding charts to ExcelWorksheet objects
 int getLeftUpperCornerColumn()
          Returns the column number where the left upper corner of the chart is anchored
This method is applicable only to adding charts to ExcelWorksheet objects
 int getLeftUpperCornerRow()
          Returns the row number where the left upper corner of the chart is anchored
This method is applicable only to adding charts to ExcelWorksheet objects
 int getVerticalOffset()
          Returns the chart vertical offset This method is applicable only to adding charts to ExcelWorksheet objects
 int getWidth()
          Returns the chart width.
 int SeriesCount()
          Returns the number of series in the chart.
 void setLeftUpperCorner(int row, int column)
          Sets the left upper corner of the chart
This method is applicable only to adding charts to ExcelWorksheet objects
 void setLeftUpperCorner(System.String cellReference)
          Sets the left upper corner of the chart
This method is applicable only to adding charts to ExcelWorksheet objects
 void setLeftUpperOffset(int horizontalOffset, int verticalOffset)
          Sets the left upper corner offsets of the chart.
 void setSize(int chartWidth, int chartHeight)
          Sets the chart size.
 

Constructor Detail

ExcelChart

public ExcelChart()
Defines an instance of the chart.


ExcelChart

public ExcelChart(int row,
                  int column)
Defines an instance of the chart having the specified location
This constructor is applicable only to adding charts to ExcelWorksheet objects

Parameters:
row - the row number where the left upper corner of the chart is anchored
column - the column number where the left upper corner of the chart is anchored

ExcelChart

public ExcelChart(int row,
                  int column,
                  int width,
                  int height)
Defines an instance of the chart having the specified location and size
This constructor is applicable only to adding charts to ExcelWorksheet objects

Parameters:
row - the row number where the left upper corner of the chart is anchored
column - the column number where the left upper corner of the chart is anchored
width - the chart width
height - the chart height

ExcelChart

public ExcelChart(System.String position)
Defines an instance of the chart having the specified location
This constructor is applicable only to adding charts to ExcelWorksheet objects

Parameters:
position - the cell reference where the left upper corner of the chart is anchored

ExcelChart

public ExcelChart(System.String position,
                  int width,
                  int height)
Defines an instance of the chart having the specified location and size
This constructor is applicable only to adding charts to ExcelWorksheet objects

Parameters:
position - the cell reference where the left upper corner of the chart is anchored
width - the chart width
height - the chart height
Method Detail

esd_setChartType

public void esd_setChartType(int chartType)
Sets the type of the chart. Possible values are available in Chart class.

Parameters:
chartType - the type of the chart
See Also:
esd_getChartType()

esd_getChartType

public int esd_getChartType()
Returns the type of the chart. Possible values are available in Chart class.

Returns:
the type of the chart
See Also:
esd_setChartType(int)

esd_addSeries

public void esd_addSeries(ExcelSeries xlsChartSeries)
Adds a new series to the chart.

Parameters:
xlsChartSeries - - the chart series
See Also:
esd_removeSeries(int), esd_getSeriesAt(int), SeriesCount()

esd_addSeries

public void esd_addSeries(System.String seriesName,
                          System.String seriesValues)
Adds a new series to the chart.

Parameters:
seriesName - - the series name.
seriesValues - - the series values.
See Also:
esd_removeSeries(int), esd_getSeriesAt(int), SeriesCount()

esd_removeSeries

public void esd_removeSeries(int index)
Removes the series from the specified index.

Parameters:
index - the series index
See Also:
esd_addSeries(ActiveXLS.Charts.ExcelSeries), esd_getSeriesAt(int), SeriesCount()

esd_getSeriesAt

public ExcelSeries esd_getSeriesAt(int index)
Returns the series from the specified index.

Parameters:
index - the series index
Returns:
the series with the specified index
See Also:
esd_addSeries(ActiveXLS.Charts.ExcelSeries), esd_removeSeries(int), SeriesCount()

SeriesCount

public int SeriesCount()
Returns the number of series in the chart.

Returns:
the number of series in the chart
See Also:
esd_addSeries(ActiveXLS.Charts.ExcelSeries), esd_removeSeries(int), esd_getSeriesAt(int)

esd_setCategoryXAxisLabels

public void esd_setCategoryXAxisLabels(System.String formulaCategoryXAxisLabels)
Sets the labels of category X axis. It must be a formula.

Parameters:
formulaCategoryXAxisLabels - the labels of category X axis
See Also:
esd_getCategoryXAxisLabels()

esd_getCategoryXAxisLabels

public System.String esd_getCategoryXAxisLabels()
Returns the labels of category X axis.

Returns:
the labels of category X axis
See Also:
esd_setCategoryXAxisLabels(System.String)

esd_setTitle

public void esd_setTitle(System.String title)
Sets the chart title.

Parameters:
title - the chart title
See Also:
esd_getTitle()

esd_getTitle

public System.String esd_getTitle()
Returns the chart title.

Returns:
the chart title
See Also:
esd_setTitle(System.String)

esd_getChartArea

public ExcelChartArea esd_getChartArea()
Returns the chart area.

Returns:
the chart area
See Also:
esd_setChartArea(ActiveXLS.Charts.ExcelChartArea)

esd_setChartArea

public void esd_setChartArea(ExcelChartArea xlsChartArea)
Sets the chart area.

Parameters:
xlsChartArea - the chart area.
See Also:
esd_getChartArea()

esd_getPlotArea

public ExcelPlotArea esd_getPlotArea()
Returns the chart plot area.

Returns:
the chart plot area
See Also:
esd_setPlotArea(ActiveXLS.Charts.ExcelPlotArea)

esd_setPlotArea

public void esd_setPlotArea(ExcelPlotArea xlsPlotArea)
Sets the chart plot area.

Parameters:
xlsPlotArea - the chart plot area
See Also:
esd_getPlotArea()

esd_getLegend

public ExcelChartLegend esd_getLegend()
Returns the chart legend.

Returns:
the chart legend
See Also:
esd_setLegend(ActiveXLS.Charts.ExcelChartLegend)

esd_setLegend

public void esd_setLegend(ExcelChartLegend xlsLegend)
Sets the chart legend.

Parameters:
xlsLegend - the chart legend
See Also:
esd_getLegend()

esd_getCategoryXAxis

public ExcelAxis esd_getCategoryXAxis()
Returns the chart category X axis.

Returns:
the chart category X axis
See Also:
esd_setCategoryXAxis(ActiveXLS.Charts.ExcelAxis)

esd_setCategoryXAxis

public void esd_setCategoryXAxis(ExcelAxis xlsCategoryXAxis)
Sets the chart category X axis.

Parameters:
xlsCategoryXAxis - the chart category X axis
See Also:
esd_getCategoryXAxis()

esd_setValueYAxis

public void esd_setValueYAxis(ExcelAxis xlsValueYAxis)
Sets the chart value Y axis.

Parameters:
xlsValueYAxis - the chart value Y axis
See Also:
esd_getValueYAxis()

esd_getValueYAxis

public ExcelAxis esd_getValueYAxis()
Returns the chart value Y axis.

Returns:
the chart value Y axis
See Also:
esd_setValueYAxis(ActiveXLS.Charts.ExcelAxis)

esd_setXAxisMajorGridlines

public void esd_setXAxisMajorGridlines(ExcelChartGridlines xlsGridlines)
Sets the style of the major gridlines for the X axis.

Parameters:
xlsGridlines - the style of the major gridlines for the X axis
See Also:
esd_getXAxisMajorGridlines(), esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMajorGridlines(), esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMinorGridlines(), esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMinorGridlines()

esd_getXAxisMajorGridlines

public ExcelChartGridlines esd_getXAxisMajorGridlines()
Returns the style of the major gridlines for the X axis.

Returns:
the style of the major gridlines for the X axis
See Also:
esd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMajorGridlines(), esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMinorGridlines(), esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMinorGridlines()

esd_setYAxisMajorGridlines

public void esd_setYAxisMajorGridlines(ExcelChartGridlines xlsGridlines)
Sets the style of the major gridlines for the Y axis.

Parameters:
xlsGridlines - the style of the major gridlines for the Y axis
See Also:
esd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMajorGridlines(), esd_getYAxisMajorGridlines(), esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMinorGridlines(), esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMinorGridlines()

esd_getYAxisMajorGridlines

public ExcelChartGridlines esd_getYAxisMajorGridlines()
Returns the style of the major gridlines for the Y axis.

Returns:
the style of the major gridlines for the Y axis
See Also:
esd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMajorGridlines(), esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMinorGridlines(), esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMinorGridlines()

esd_setXAxisMinorGridlines

public void esd_setXAxisMinorGridlines(ExcelChartGridlines xlsGridlines)
Sets the style of the minor gridlines for the X axis.

Parameters:
xlsGridlines - the style of the minor gridlines for the X axis
See Also:
esd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMajorGridlines(), esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMajorGridlines(), esd_getXAxisMinorGridlines(), esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMinorGridlines()

esd_getXAxisMinorGridlines

public ExcelChartGridlines esd_getXAxisMinorGridlines()
Returns the style of the minor gridlines for the X axis.

Returns:
the style of the minor gridlines for the X axis
See Also:
esd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMajorGridlines(), esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMajorGridlines(), esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMinorGridlines()

esd_setYAxisMinorGridlines

public void esd_setYAxisMinorGridlines(ExcelChartGridlines xlsGridlines)
Sets the style of the major gridlines for the Y axis.

Parameters:
xlsGridlines - the style of the major gridlines for the Y axis
See Also:
esd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMajorGridlines(), esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMajorGridlines(), esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMinorGridlines(), esd_getYAxisMinorGridlines()

esd_getYAxisMinorGridlines

public ExcelChartGridlines esd_getYAxisMinorGridlines()
Returns the style of the minor gridlines for the Y axis.

Returns:
the style of the minor gridlines for the Y axis
See Also:
esd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMajorGridlines(), esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getYAxisMajorGridlines(), esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines), esd_getXAxisMinorGridlines(), esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines)

esd_setChartDataTable

public void esd_setChartDataTable(ExcelDataTable xlsChartDataTable)
Sets the chart data table.

Parameters:
xlsChartDataTable - the chart data table
See Also:
esd_getChartDataTable()

esd_getChartDataTable

public ExcelDataTable esd_getChartDataTable()
Returns the chart data table.

Returns:
the chart data table
See Also:
esd_setChartDataTable(ActiveXLS.Charts.ExcelDataTable)

esd_setSeriesOverlap

public void esd_setSeriesOverlap(int overlap)
Sets the overlap of the chart series.

Parameters:
overlap - the overlap of the chart series
See Also:
esd_getSeriesOverlap(), esd_setSeriesGap(int), esd_getSeriesGap()

esd_getSeriesOverlap

public int esd_getSeriesOverlap()
Returns the overlap of the chart series.

Returns:
the overlap of the chart series
See Also:
esd_setSeriesOverlap(int), esd_setSeriesGap(int), esd_getSeriesGap()

esd_setSeriesGap

public void esd_setSeriesGap(int gap)
Sets the gap of the chart series.

Parameters:
gap - the gap of the chart series
See Also:
esd_getSeriesGap(), esd_setSeriesOverlap(int), esd_getSeriesOverlap()

esd_getSeriesGap

public int esd_getSeriesGap()
Returns the gap of the chart series.

Returns:
the gap of the chart series
See Also:
esd_setSeriesGap(int), esd_setSeriesOverlap(int), esd_getSeriesOverlap()

esd_set3DRotation

public void esd_set3DRotation(int n3DRotation)
Sets the 3D rotation of the chart.

Parameters:
n3DRotation - the 3D rotation of the chart
See Also:
esd_get3DRotation(), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DHeight(int), esd_get3DHeight(), esd_set3DPerspective(int), esd_get3DPerspective(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_get3DRotation

public int esd_get3DRotation()
Returns the 3D rotation setting of the chart.

Returns:
the 3D rotation of the chart
See Also:
esd_set3DRotation(int), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DHeight(int), esd_get3DHeight(), esd_set3DPerspective(int), esd_get3DPerspective(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_set3DElevation

public void esd_set3DElevation(int n3DElevation)
Sets the 3D elevation setting of the chart.

Parameters:
n3DElevation - the 3D elevation setting of the chart
See Also:
esd_get3DElevation(), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DHeight(int), esd_get3DHeight(), esd_set3DPerspective(int), esd_get3DPerspective(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_get3DElevation

public int esd_get3DElevation()
Returns the 3D elevation setting of the chart.

Returns:
the 3D elevation setting of the chart
See Also:
esd_set3DElevation(int), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DHeight(int), esd_get3DHeight(), esd_set3DPerspective(int), esd_get3DPerspective(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_set3DHeight

public void esd_set3DHeight(int n3DHeight)
Sets the 3D height of the chart.

Parameters:
n3DHeight - the 3D height of the chart
See Also:
esd_get3DHeight(), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DPerspective(int), esd_get3DPerspective(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_get3DHeight

public int esd_get3DHeight()
Returns the 3D height setting of the chart.

Returns:
the 3D height of the chart
See Also:
esd_set3DHeight(int), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DPerspective(int), esd_get3DPerspective(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_set3DPerspective

public void esd_set3DPerspective(int n3DPerspective)
Sets the 3D perspective of the chart.

Parameters:
n3DPerspective - the 3D perspective of the chart
See Also:
esd_get3DPerspective(), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DHeight(int), esd_get3DHeight(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_get3DPerspective

public int esd_get3DPerspective()
Returns the 3D perspective setting of the chart.

Returns:
the 3D perspective of the chart
See Also:
esd_set3DPerspective(int), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DHeight(int), esd_get3DHeight(), esd_setUse3DPerspective(bool), esd_Use3DPerspective()

esd_setUse3DPerspective

public void esd_setUse3DPerspective(bool use3DPerspective)
Sets if the 3D setting of the chart is used.

Parameters:
use3DPerspective - true if the 3D setting is used, false otherwise
See Also:
esd_Use3DPerspective(), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DHeight(int), esd_get3DHeight(), esd_set3DPerspective(int), esd_get3DPerspective()

esd_Use3DPerspective

public bool esd_Use3DPerspective()
Returns if the 3D perspective of the chart is used

Returns:
true if the 3D perspective of the chart is used, false otherwise
See Also:
esd_setUse3DPerspective(bool), esd_set3DRotation(int), esd_get3DRotation(), esd_set3DElevation(int), esd_get3DElevation(), esd_set3DHeight(int), esd_get3DHeight(), esd_set3DPerspective(int), esd_get3DPerspective()

setLeftUpperCorner

public void setLeftUpperCorner(int row,
                               int column)
Sets the left upper corner of the chart
This method is applicable only to adding charts to ExcelWorksheet objects

Parameters:
row - the row number where the left upper corner of the chart is anchored
column - the column number where the left upper corner of the chart is anchored
See Also:
setLeftUpperCorner(String), setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerRow(), getLeftUpperCornerColumn()

setLeftUpperCorner

public void setLeftUpperCorner(System.String cellReference)
Sets the left upper corner of the chart
This method is applicable only to adding charts to ExcelWorksheet objects

Parameters:
cellReference - the cell reference where the left upper corner of the chart is anchored
See Also:
setLeftUpperCorner(int,int), setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerRow(), getLeftUpperCornerColumn()

getLeftUpperCornerRow

public int getLeftUpperCornerRow()
Returns the row number where the left upper corner of the chart is anchored
This method is applicable only to adding charts to ExcelWorksheet objects

Returns:
the row number where the left upper corner of the chart is anchored
See Also:
setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerColumn()

getLeftUpperCornerColumn

public int getLeftUpperCornerColumn()
Returns the column number where the left upper corner of the chart is anchored
This method is applicable only to adding charts to ExcelWorksheet objects

Returns:
the column number where the left upper corner of the chart is anchored
See Also:
setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerRow()

setLeftUpperOffset

public void setLeftUpperOffset(int horizontalOffset,
                               int verticalOffset)
Sets the left upper corner offsets of the chart. This method is applicable only to adding charts to ExcelWorksheet objects

Parameters:
horizontalOffset - represents the distance from the left border of the cell to the left border of the chart
verticalOffset - represents the distance from the top border of the cell to the top border of the chart
See Also:
setLeftUpperCorner(String), setLeftUpperCorner(int,int), setSize(int, int)

setSize

public void setSize(int chartWidth,
                    int chartHeight)
Sets the chart size. This method is applicable only to adding charts to ExcelWorksheet objects

Parameters:
chartWidth - the chart width
chartHeight - the chart height
See Also:
setLeftUpperCorner(String), setLeftUpperCorner(int,int), setLeftUpperOffset(int, int)

getHeight

public int getHeight()
Returns the chart height. This method is applicable only to adding charts to ExcelWorksheet objects

Returns:
the chart height.
See Also:
setSize(int, int), setLeftUpperCorner(String), setLeftUpperCorner(int,int), getWidth()

getWidth

public int getWidth()
Returns the chart width. This method is applicable only to adding charts to ExcelWorksheet objects

Returns:
the chart width.
See Also:
setSize(int, int), setLeftUpperCorner(String), setLeftUpperCorner(int,int), getHeight()

getHorizontalOffset

public int getHorizontalOffset()
Returns the chart horizontal offset This method is applicable only to adding charts to ExcelWorksheet objects

Returns:
the distance from the left border of the cell to the left border of the chart
See Also:
setLeftUpperOffset(int, int), setSize(int, int), getVerticalOffset()

getVerticalOffset

public int getVerticalOffset()
Returns the chart vertical offset This method is applicable only to adding charts to ExcelWorksheet objects

Returns:
the distance from the top border of the cell to the top border of the chart
See Also:
setLeftUpperOffset(int, int), setSize(int, int), getHorizontalOffset()

Dispose

public void Dispose()
Disposes the allocated resources.


Clone

public ExcelChart Clone()
Creates and returns a copy of this object.

Returns:
a clone of this instance.

Copyright 2009 On Time Computing Solutions