 |
| IXlsChart |
|
COM interface ( getting help with interfaces )
interface IXlsChart : IDispatch
{
[id(1),propget] HRESULT DataSource([out, retval]IXlsChartDataSource** datasource);
[id(2),propget] HRESULT Legend([out, retval]IXlsChartLegend** legend);
[id(3),propget] HRESULT MainTitle([out, retval]IXlsChartTitle**);
[id(4),propget] HRESULT PlotArea([out, retval]IXlsChartPlotArea** plotarea);
[id(5),propget] HRESULT SurfaceArea([out, retval]IXlsChartSurfaceArea** surfacearea);
[id(6),propget] HRESULT SeriesByIndex([in]int i, [out, retval]IXlsChartSeries** series);
[id(7),propget] HRESULT SeriesByName([in]BSTR seriesname, [out, retval]IXlsChartSeries** series);
[id(8),propget] HRESULT XAxis([in]enumChartAxisType axistype, [out, retval]IXlsChartAxis** axis);
[id(9),propget] HRESULT YAxis([in]enumChartAxisType axistype, [out, retval]IXlsChartAxis** axis);
[id(10),propget] HRESULT ZAxis([out, retval]IXlsChartAxis** axis);
[id(11),propget] HRESULT ThreeDeePanel([out, retval]IXlsChart3DPanel** threedeepanel);
[id(12),propget] HRESULT MainDataLabels([out, retval]IXlsChartDataLabels** datalabels);
[id(13),propget] HRESULT CustomProperties([out, retval]IXlsChartCustomProperties** customproperties);
[id(14),propget] HRESULT DataTableLegend([out, retval]IXlsChartDataTable** datatable);
[id(15),propget] HRESULT PageSetup([out, retval] IXlsPageSetup** pagesetup);
[id(16),propget] HRESULT DynamicDataSource([out, retval]IXlsChartDynamicDataSource** dynamicdatasource);
[id(17) ] HRESULT AddTextBox([out, retval]IXlsChartTextBox** textbox);
[id(18),propget] HRESULT Type([out, retval]enumChartType* type);
[id(18),propput] HRESULT Type([in]enumChartType type);
[id(19),propget] HRESULT Embedded([out, retval]BOOL* embedded);
[id(20),propget] HRESULT ChartPositionTop([out, retval]int* row);
[id(21),propget] HRESULT ChartPositionLeft([out, retval]int* column);
[id(22),propget] HRESULT ChartPositionBottom([out, retval]int* row);
[id(23),propget] HRESULT ChartPositionRight([out, retval]int* column);
[id(24),propget] HRESULT Shapes([out, retval]IXlsChartShapes** shapes);
[id(25) ] HRESULT ExtractToFile([out, retval]BSTR* filename);
[id(26) ] HRESULT ExtractToMemory([in]IUnknown* lockbytes);
[id(27) ] HRESULT CommitChanges();
[id(28),propget] HRESULT AlternativeText([out, retval]BSTR* text);
[id(28),propput] HRESULT AlternativeText([in]BSTR text);
[id(29) ] HRESULT TurnToStandalone([in]BSTR chartname, [out, retval]IXlsChart** chart);
[id(30) ] HRESULT TurnToEmbedded([in]IXlsWorksheet* wksht, [in]int row1, [in]int col1, [in]int row2, [in]int col2, [out, retval] IXlsChart** chart);
[id(31) ] HRESULT CopyTo([in]IXlsWorksheet* wksht, [out, retval] IXlsChart** chart);
[id(32) ] HRESULT CopyToLocation([in]IXlsWorksheet* wksht, [in]int row1, [in]int col1, [in]int row2, [in]int col2, [out, retval] IXlsChart** chart);
[id(33),propget] HRESULT WorksheetHost([out, retval]IXlsWorksheet** wksht);
[id(34) ] HRESULT Delete();
[id(35) ] HRESULT AddVectorShape([in]enumVectorShape shapeType, [out, retval]IXlsVectorShape** shape);
[id(36) ] HRESULT SwitchRowsAndColumns();
[id(37),propget] HRESULT Theme([out, retval]IXlsChartTheme** theme);
[id(38),propput] HRESULT VBAMacro([in]BSTR macro);
[id(38),propget] HRESULT VBAMacro([out, retval]BSTR* macro);
[id(39),propput] HRESULT PivotTableDataSource([in]IXlsPivotTable* pivot);
[id(40),propget] HRESULT Name([out, retval] BSTR* name);
[id(40),propput] HRESULT Name([in] BSTR name);
}
HRESULT DataSource([out, retval]IXlsChartDataSource** datasource);
returns the chart data source object. The (static) data source is an alternative to the dynamic data source.
HRESULT Legend([out, retval]IXlsChartLegend** legend);
returns the chart legend object.
HRESULT MainTitle([out, retval]IXlsChartTitle**);
returns the chart title object.
HRESULT PlotArea([out, retval]IXlsChartPlotArea** plotarea);
returns the chart plot area object.
HRESULT SurfaceArea([out, retval]IXlsChartSurfaceArea** surfacearea);
returns the chart surfacearea object.
HRESULT SeriesByIndex([in]int i, [out, retval]IXlsChartSeries** series);
returns a series by index. Index starts at 1.
HRESULT SeriesByName([in]BSTR seriesname, [out, retval]IXlsChartSeries** series);
returns a series by name. Names are case insensitive. Not available if you are using a dynamic data source (IXlsDynamicDataSource).
HRESULT XAxis([in]enumChartAxisType axistype, [out, retval]IXlsChartAxis** axis);
returns the (X) axis, used to display data labels.
HRESULT YAxis([in]enumChartAxisType axistype, [out, retval]IXlsChartAxis** axis);
returns the (Y) axis, used to display serie values.
HRESULT ZAxis([out, retval]IXlsChartAxis** axis);
returns the (Z) axis, used to display serie values in 3D charts.
HRESULT ThreeDeePanel([out, retval]IXlsChart3DPanel** threedeepanel);
returns the 3D panel object.
HRESULT MainDataLabels([out, retval]IXlsChartDataLabels** datalabels);
returns the data labels object.
HRESULT CustomProperties([out, retval]IXlsChartCustomProperties** customproperties);
returns the custom properties object.
HRESULT DataTableLegend([out, retval]IXlsChartDataTable** datatable);
returns the associated data table object. Does not apply to 3D charts and pie/doughnut/radar/surface/contour/bubble charts.
HRESULT PageSetup([out, retval] IXlsPageSetup** pagesetup);
retrieves the page setup information for this chart.
HRESULT DynamicDataSource([out, retval]IXlsChartDynamicDataSource** dynamicdatasource);
returns the chart dynamic data source object. The dynamic data source is an alternative to the regular (static) data source.
HRESULT AddTextBox([out, retval]IXlsChartTextBox** textbox);
adds a custom text box to the chart.
HRESULT Type([out, retval]enumChartType* type);
returns the chart type.
HRESULT Type([in]enumChartType type);
sets the chart type.
HRESULT Embedded([out, retval]BOOL* embedded);
returns whether the chart is part of the worksheet (i.e. embedded) or fills the entire surface of a worksheet.
HRESULT ChartPositionTop([out, retval]int* row);
returns the chart top row where it's located in the worksheet. Only applies to embedded charts.
HRESULT ChartPositionLeft([out, retval]int* column);
returns the chart left column where it's located in the worksheet. Only applies to embedded charts.
HRESULT ChartPositionBottom([out, retval]int* row);
returns the chart bottom row where it's located in the worksheet. Only applies to embedded charts.
HRESULT ChartPositionRight([out, retval]int* column);
returns the chart right column where it's located in the worksheet. Only applies to embedded charts.
HRESULT Shapes([out, retval]IXlsChartShapes** shapes);
gets the shapes collection in the chart.
HRESULT ExtractToFile([out, retval]BSTR* filename);
creates a snapshot of the chart as a picture in a file (PNG file format) and returns the filename.
HRESULT ExtractToMemory([in]IUnknown* lockbytes);
creates a snapshot of the chart as a picture in memory. The passed parameter is a pointer to a ILockBytes interface pointer. PNG buffer.
HRESULT CommitChanges();
ensures that changes made to the chart are saved back into the file.
HRESULT AlternativeText([out, retval]BSTR* text);
returns the alternative text. Optional.
HRESULT AlternativeText([in]BSTR text);
sets the alternative text. Optional.
HRESULT TurnToStandalone([in]BSTR chartname, [out, retval]IXlsChart** chart);
turns the chart to a standalone chart (chart sheet). The passed parameter is the name of the sheet holding the chart.
HRESULT TurnToEmbedded([in]IXlsWorksheet* wksht, [in]int row1, [in]int col1, [in]int row2, [in]int col2, [out, retval] IXlsChart** chart);
turns the chart to an embedded chart.
HRESULT CopyTo([in]IXlsWorksheet* wksht, [out, retval] IXlsChart** chart);
copies the chart to the passed worksheet.
HRESULT CopyToLocation([in]IXlsWorksheet* wksht, [in]int row1, [in]int col1, [in]int row2, [in]int col2, [out, retval] IXlsChart** chart);
copies the chart to the passed worksheet at the given location.
HRESULT WorksheetHost([out, retval]IXlsWorksheet** wksht);
returns the worksheet associated to the chart.
HRESULT Delete();
deletes the chart.
HRESULT AddVectorShape([in]enumVectorShape shapeType, [out, retval]IXlsVectorShape** shape);
adds a custom vector shape to the chart.
HRESULT SwitchRowsAndColumns();
switches rows and columns of the data source. Rows become columns and vice versa.
HRESULT Theme([out, retval]IXlsChartTheme** theme);
returns the chart theme object.
HRESULT VBAMacro([in]BSTR macro);
sets the vba macro name for the chart.
HRESULT VBAMacro([out, retval]BSTR* macro);
returns the vba macro name for the chart.
HRESULT PivotTableDataSource([in]IXlsPivotTable* pivot);
sets the chart dynamic data source object from an existing pivot table.
HRESULT Name([out, retval] BSTR* name);
retrieves the name of the chart.
HRESULT Name([in] BSTR name);
sets the name of the chart.