|
ActiveXLS v6.4.0 API Documentation | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | CONST | CONSTR | METHOD | DETAIL: CONST | CONSTR | METHOD |
System.ObjectActiveXLS.Charts.ExcelChart
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 |
public ExcelChart()
public ExcelChart(int row, int column)
This constructor is applicable only to adding charts to ExcelWorksheet objects
row
- the row number where the left upper corner of the chart is anchoredcolumn
- the column number where the left upper corner of the chart is anchoredpublic ExcelChart(int row, int column, int width, int height)
This constructor is applicable only to adding charts to ExcelWorksheet objects
row
- the row number where the left upper corner of the chart is anchoredcolumn
- the column number where the left upper corner of the chart is anchoredwidth
- the chart widthheight
- the chart heightpublic ExcelChart(System.String position)
This constructor is applicable only to adding charts to ExcelWorksheet objects
position
- the cell reference where the left upper corner of the chart is anchoredpublic ExcelChart(System.String position, int width, int height)
This constructor is applicable only to adding charts to ExcelWorksheet objects
position
- the cell reference where the left upper corner of the chart is anchoredwidth
- the chart widthheight
- the chart heightMethod Detail |
public void esd_setChartType(int chartType)
Chart
class.
chartType
- the type of the chartesd_getChartType()
public int esd_getChartType()
Chart
class.
esd_setChartType(int)
public void esd_addSeries(ExcelSeries xlsChartSeries)
xlsChartSeries
- - the chart seriesesd_removeSeries(int)
,
esd_getSeriesAt(int)
,
SeriesCount()
public void esd_addSeries(System.String seriesName, System.String seriesValues)
seriesName
- - the series name.seriesValues
- - the series values.esd_removeSeries(int)
,
esd_getSeriesAt(int)
,
SeriesCount()
public void esd_removeSeries(int index)
index
- the series indexesd_addSeries(ActiveXLS.Charts.ExcelSeries)
,
esd_getSeriesAt(int)
,
SeriesCount()
public ExcelSeries esd_getSeriesAt(int index)
index
- the series index
esd_addSeries(ActiveXLS.Charts.ExcelSeries)
,
esd_removeSeries(int)
,
SeriesCount()
public int SeriesCount()
esd_addSeries(ActiveXLS.Charts.ExcelSeries)
,
esd_removeSeries(int)
,
esd_getSeriesAt(int)
public void esd_setCategoryXAxisLabels(System.String formulaCategoryXAxisLabels)
formulaCategoryXAxisLabels
- the labels of category X axisesd_getCategoryXAxisLabels()
public System.String esd_getCategoryXAxisLabels()
esd_setCategoryXAxisLabels(System.String)
public void esd_setTitle(System.String title)
title
- the chart titleesd_getTitle()
public System.String esd_getTitle()
esd_setTitle(System.String)
public ExcelChartArea esd_getChartArea()
esd_setChartArea(ActiveXLS.Charts.ExcelChartArea)
public void esd_setChartArea(ExcelChartArea xlsChartArea)
xlsChartArea
- the chart area.esd_getChartArea()
public ExcelPlotArea esd_getPlotArea()
esd_setPlotArea(ActiveXLS.Charts.ExcelPlotArea)
public void esd_setPlotArea(ExcelPlotArea xlsPlotArea)
xlsPlotArea
- the chart plot areaesd_getPlotArea()
public ExcelChartLegend esd_getLegend()
esd_setLegend(ActiveXLS.Charts.ExcelChartLegend)
public void esd_setLegend(ExcelChartLegend xlsLegend)
xlsLegend
- the chart legendesd_getLegend()
public ExcelAxis esd_getCategoryXAxis()
esd_setCategoryXAxis(ActiveXLS.Charts.ExcelAxis)
public void esd_setCategoryXAxis(ExcelAxis xlsCategoryXAxis)
xlsCategoryXAxis
- the chart category X axisesd_getCategoryXAxis()
public void esd_setValueYAxis(ExcelAxis xlsValueYAxis)
xlsValueYAxis
- the chart value Y axisesd_getValueYAxis()
public ExcelAxis esd_getValueYAxis()
esd_setValueYAxis(ActiveXLS.Charts.ExcelAxis)
public void esd_setXAxisMajorGridlines(ExcelChartGridlines xlsGridlines)
xlsGridlines
- the style of the major gridlines for the X axisesd_getXAxisMajorGridlines()
,
esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getYAxisMajorGridlines()
,
esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getXAxisMinorGridlines()
,
esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getYAxisMinorGridlines()
public ExcelChartGridlines esd_getXAxisMajorGridlines()
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()
public void esd_setYAxisMajorGridlines(ExcelChartGridlines xlsGridlines)
xlsGridlines
- the style of the major gridlines for the Y axisesd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getXAxisMajorGridlines()
,
esd_getYAxisMajorGridlines()
,
esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getXAxisMinorGridlines()
,
esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getYAxisMinorGridlines()
public ExcelChartGridlines esd_getYAxisMajorGridlines()
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()
public void esd_setXAxisMinorGridlines(ExcelChartGridlines xlsGridlines)
xlsGridlines
- the style of the minor gridlines for the X axisesd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getXAxisMajorGridlines()
,
esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getYAxisMajorGridlines()
,
esd_getXAxisMinorGridlines()
,
esd_setYAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getYAxisMinorGridlines()
public ExcelChartGridlines esd_getXAxisMinorGridlines()
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()
public void esd_setYAxisMinorGridlines(ExcelChartGridlines xlsGridlines)
xlsGridlines
- the style of the major gridlines for the Y axisesd_setXAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getXAxisMajorGridlines()
,
esd_setYAxisMajorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getYAxisMajorGridlines()
,
esd_setXAxisMinorGridlines(ActiveXLS.Charts.ExcelChartGridlines)
,
esd_getXAxisMinorGridlines()
,
esd_getYAxisMinorGridlines()
public ExcelChartGridlines esd_getYAxisMinorGridlines()
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)
public void esd_setChartDataTable(ExcelDataTable xlsChartDataTable)
xlsChartDataTable
- the chart data tableesd_getChartDataTable()
public ExcelDataTable esd_getChartDataTable()
esd_setChartDataTable(ActiveXLS.Charts.ExcelDataTable)
public void esd_setSeriesOverlap(int overlap)
overlap
- the overlap of the chart seriesesd_getSeriesOverlap()
,
esd_setSeriesGap(int)
,
esd_getSeriesGap()
public int esd_getSeriesOverlap()
esd_setSeriesOverlap(int)
,
esd_setSeriesGap(int)
,
esd_getSeriesGap()
public void esd_setSeriesGap(int gap)
gap
- the gap of the chart seriesesd_getSeriesGap()
,
esd_setSeriesOverlap(int)
,
esd_getSeriesOverlap()
public int esd_getSeriesGap()
esd_setSeriesGap(int)
,
esd_setSeriesOverlap(int)
,
esd_getSeriesOverlap()
public void esd_set3DRotation(int n3DRotation)
n3DRotation
- the 3D rotation of the chartesd_get3DRotation()
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public int esd_get3DRotation()
esd_set3DRotation(int)
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public void esd_set3DElevation(int n3DElevation)
n3DElevation
- the 3D elevation setting of the chartesd_get3DElevation()
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public int esd_get3DElevation()
esd_set3DElevation(int)
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public void esd_set3DHeight(int n3DHeight)
n3DHeight
- the 3D height of the chartesd_get3DHeight()
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public int esd_get3DHeight()
esd_set3DHeight(int)
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public void esd_set3DPerspective(int n3DPerspective)
n3DPerspective
- the 3D perspective of the chartesd_get3DPerspective()
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public int esd_get3DPerspective()
esd_set3DPerspective(int)
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_setUse3DPerspective(bool)
,
esd_Use3DPerspective()
public void esd_setUse3DPerspective(bool use3DPerspective)
use3DPerspective
- true if the 3D setting is used, false otherwiseesd_Use3DPerspective()
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
public bool esd_Use3DPerspective()
esd_setUse3DPerspective(bool)
,
esd_set3DRotation(int)
,
esd_get3DRotation()
,
esd_set3DElevation(int)
,
esd_get3DElevation()
,
esd_set3DHeight(int)
,
esd_get3DHeight()
,
esd_set3DPerspective(int)
,
esd_get3DPerspective()
public void setLeftUpperCorner(int row, int column)
This method is applicable only to adding charts to ExcelWorksheet objects
row
- the row number where the left upper corner of the chart is anchoredcolumn
- the column number where the left upper corner of the chart is anchoredsetLeftUpperCorner(String)
,
setLeftUpperOffset(int, int)
,
setSize(int, int)
,
getLeftUpperCornerRow()
,
getLeftUpperCornerColumn()
public void setLeftUpperCorner(System.String cellReference)
This method is applicable only to adding charts to ExcelWorksheet objects
cellReference
- the cell reference where the left upper corner of the chart is anchoredsetLeftUpperCorner(int,int)
,
setLeftUpperOffset(int, int)
,
setSize(int, int)
,
getLeftUpperCornerRow()
,
getLeftUpperCornerColumn()
public int getLeftUpperCornerRow()
This method is applicable only to adding charts to ExcelWorksheet objects
setLeftUpperOffset(int, int)
,
setSize(int, int)
,
getLeftUpperCornerColumn()
public int getLeftUpperCornerColumn()
This method is applicable only to adding charts to ExcelWorksheet objects
setLeftUpperOffset(int, int)
,
setSize(int, int)
,
getLeftUpperCornerRow()
public void setLeftUpperOffset(int horizontalOffset, int verticalOffset)
This method is applicable only to adding charts to ExcelWorksheet objects
horizontalOffset
- represents the distance from the left border of the cell to the left border of the chartverticalOffset
- represents the distance from the top border of the cell to the top border of the chartsetLeftUpperCorner(String)
,
setLeftUpperCorner(int,int)
,
setSize(int, int)
public void setSize(int chartWidth, int chartHeight)
This method is applicable only to adding charts to ExcelWorksheet objects
chartWidth
- the chart widthchartHeight
- the chart heightsetLeftUpperCorner(String)
,
setLeftUpperCorner(int,int)
,
setLeftUpperOffset(int, int)
public int getHeight()
This method is applicable only to adding charts to ExcelWorksheet objects
setSize(int, int)
,
setLeftUpperCorner(String)
,
setLeftUpperCorner(int,int)
,
getWidth()
public int getWidth()
This method is applicable only to adding charts to ExcelWorksheet objects
setSize(int, int)
,
setLeftUpperCorner(String)
,
setLeftUpperCorner(int,int)
,
getHeight()
public int getHorizontalOffset()
This method is applicable only to adding charts to ExcelWorksheet objects
setLeftUpperOffset(int, int)
,
setSize(int, int)
,
getVerticalOffset()
public int getVerticalOffset()
This method is applicable only to adding charts to ExcelWorksheet objects
setLeftUpperOffset(int, int)
,
setSize(int, int)
,
getHorizontalOffset()
public void Dispose()
public ExcelChart Clone()
|
Copyright 2009 On Time Computing Solutions | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | CONST | CONSTR | METHOD | DETAIL: CONST | CONSTR | METHOD |