ActiveXLS
Class ExcelChartSheet

System.Object
  ActiveXLS.BIFF_Records.SheetStream
      ActiveXLS.ExcelSheet
          ActiveXLS.ExcelChartSheet

public class ExcelChartSheet

extends ExcelSheet

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

ExcelChartSheet()
Defines an instance of a sheet that contains a chart.

ExcelChartSheet(System.String chartName)
Defines an instance of a sheet that has the sheet name defined and contains a chart.

Method Summary

ExcelSheet	Clone() Creates and returns a copy of this object.
void	Dispose() Disposes the allocated resources.
void	esd_addImage(ExcelImage xlsImage) Adds the specified image to chart sheet.
void	esd_addImage(System.String path) Adds an image that has the specified path to chart sheet.
void	esd_addImage(System.String path, int horizontalOffset, int verticalOffset) Adds an image that has the specified path and location to chart sheet.
void	esd_addImage(System.String path, int horizontalOffset, int verticalOffset, int width, int height) Adds an image that has the specified path, location and size to chart sheet.
ExcelChart	esd_getExcelChart() Returns the chart of the sheet.
ExcelImage	esd_getImage(System.String path) Returns the image that has the specified path.
ExcelImage	esd_getImageAt(int index) Returns the image from the specified index.
void	esd_removeImage(int index) Removes the image from the specified index.
void	esd_removeImage(System.String path) Removes the image that has the specified path from the chart sheet.
void	esd_setExcelChart(ExcelChart xlsChart) Sets the chart of the sheet.
int	ImageCount() Returns the number of images in the chart sheet.

Constructor Detail

ExcelChartSheet

public ExcelChartSheet()

Defines an instance of a sheet that contains a chart.

ExcelChartSheet

public ExcelChartSheet(System.String chartName)

Defines an instance of a sheet that has the sheet name defined and contains a chart.

Parameters:

chartName - the chart sheet name.

Method Detail

esd_setExcelChart

public void esd_setExcelChart(ExcelChart xlsChart)

Sets the chart of the sheet.

Parameters:

xlsChart - the chart of the sheet

See Also:

esd_getExcelChart()

esd_getExcelChart

public ExcelChart esd_getExcelChart()

Returns the chart of the sheet.

Returns:

chart of the sheet

See Also:

esd_setExcelChart(ActiveXLS.Charts.ExcelChart)

esd_addImage

public void esd_addImage(ExcelImage xlsImage)

Adds the specified image to chart sheet.

Parameters:

xlsImage - the image to be added

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path)

Adds an image that has the specified path to chart sheet.

Parameters:

path - the file path to image file

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path,
                         int horizontalOffset,
                         int verticalOffset)

Adds an image that has the specified path and location to chart sheet.

Parameters:

path - the file path to image file

horizontalOffset - the distance from the left margin of the chart to the left border of the image

verticalOffset - the distance from the left margin of the chart to the top border of the image

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path,
                         int horizontalOffset,
                         int verticalOffset,
                         int width,
                         int height)

Adds an image that has the specified path, location and size to chart sheet.

Parameters:

path - the file path to image file

horizontalOffset - the distance from the left margin of the chart to the left border of the image

verticalOffset - the distance from the left margin of the chart to the top border of the image

width - the image width

height - the image height

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_removeImage

public void esd_removeImage(int index)

Removes the image from the specified index.

Parameters:

index - the index of the image to remove

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_getImageAt(int), ImageCount(), esd_removeImage(String)

esd_removeImage

public void esd_removeImage(System.String path)

Removes the image that has the specified path from the chart sheet.

Parameters:

path - the file path to image file

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_getImageAt(int), ImageCount(), esd_removeImage(int)

esd_getImageAt

public ExcelImage esd_getImageAt(int index)

Returns the image from the specified index.

Parameters:

index - the index of the image to return

Returns:

the image from the specified index

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_removeImage(int), ImageCount(), esd_getImage(String)

esd_getImage

public ExcelImage esd_getImage(System.String path)

Returns the image that has the specified path.

Parameters:

path - the file path to image file

Returns:

the image that has the specified path

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_removeImage(int), ImageCount(), esd_getImageAt(int)

ImageCount

public int ImageCount()

Returns the number of images in the chart sheet.

Returns:

the number of images in the chart sheet

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_removeImage(int), esd_getImageAt(int)

Dispose

public void Dispose()

Disposes the allocated resources.

Overrides:

Dispose in class ExcelSheet

Clone

public ExcelSheet Clone()

Creates and returns a copy of this object.

Specified by:

Clone in class ExcelSheet

Returns:

a clone of this instance.