Excel.ChartCollection class

Eine Sammlung aller Diagrammobjekte in einem Arbeitsblatt.

Extends

Hinweise

[API-Satz: ExcelApi 1.1]

Eigenschaften

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

count

Gibt die Anzahl der Diagramme im Arbeitsblatt zurück.

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(type, sourceData, seriesBy)

Erstellt ein neues Diagramm.

add(type, sourceData, seriesBy)

Erstellt ein neues Diagramm.

getCount()

Gibt die Anzahl der Diagramme im Arbeitsblatt zurück.

getItem(name)

Ruft ein Diagramm über seinen Namen ab. Wenn mehrere Diagramme mit demselben Namen vorhanden sind, wird das erste zurückgegeben.

getItemAt(index)

Ruft ein Diagramm anhand seiner Position in der Sammlung ab.

getItemOrNullObject(name)

Ruft ein Diagramm über seinen Namen ab. Wenn mehrere Diagramme mit demselben Namen vorhanden sind, wird das erste zurückgegeben. Wenn das Diagramm nicht vorhanden ist, gibt diese Methode ein Objekt mit seiner isNullObject Eigenschaft auf truezurück. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.ChartCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

Ereignisse

onActivated

Tritt auf, wenn ein Diagramm aktiviert ist.

onAdded

Tritt auf, wenn dem Arbeitsblatt ein neues Diagramm hinzugefügt wird.

onDeactivated

Tritt auf, wenn ein Diagramm deaktiviert ist.

onDeleted

Tritt auf, wenn ein Diagramm gelöscht wird.

Details zur Eigenschaft

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

count

Gibt die Anzahl der Diagramme im Arbeitsblatt zurück.

readonly count: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.1]

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.Chart[];

Eigenschaftswert

Details zur Methode

add(type, sourceData, seriesBy)

Erstellt ein neues Diagramm.

add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy): Excel.Chart;

Parameter

type
Excel.ChartType

Stellt die Art des Diagramms dar. Weitere Informationen findest du hier Excel.ChartType .

sourceData
Excel.Range

Das Range Objekt, das den Quelldaten entspricht.

seriesBy
Excel.ChartSeriesBy

Optional. Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden. Weitere Informationen findest du hier Excel.ChartSeriesBy .

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

add(type, sourceData, seriesBy)

Erstellt ein neues Diagramm.

add(type: "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel", sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): Excel.Chart;

Parameter

type

"Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"

Stellt die Art des Diagramms dar. Weitere Informationen findest du hier Excel.ChartType .

sourceData
Excel.Range

Das Range Objekt, das den Quelldaten entspricht.

seriesBy

"Auto" | "Columns" | "Rows"

Optional. Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden. Weitere Informationen findest du hier Excel.ChartSeriesBy .

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

getCount()

Gibt die Anzahl der Diagramme im Arbeitsblatt zurück.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.4]

getItem(name)

Ruft ein Diagramm über seinen Namen ab. Wenn mehrere Diagramme mit demselben Namen vorhanden sind, wird das erste zurückgegeben.

getItem(name: string): Excel.Chart;

Parameter

name

string

Der Name des abzurufenden Diagramms.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

getItemAt(index)

Ruft ein Diagramm anhand seiner Position in der Sammlung ab.

getItemAt(index: number): Excel.Chart;

Parameter

index

number

Index-Wert des abzurufenden Objekts. Nullindiziert.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

getItemOrNullObject(name)

Ruft ein Diagramm über seinen Namen ab. Wenn mehrere Diagramme mit demselben Namen vorhanden sind, wird das erste zurückgegeben. Wenn das Diagramm nicht vorhanden ist, gibt diese Methode ein Objekt mit seiner isNullObject Eigenschaft auf truezurück. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(name: string): Excel.Chart;

Parameter

name

string

Der Name des abzurufenden Diagramms.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.4]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection;

Parameter

options

Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.ChartCollection;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartCollection;

Parameter

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.ChartCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): Excel.Interfaces.ChartCollectionData;

Gibt zurück

Details zum Ereignis

onActivated

Tritt auf, wenn ein Diagramm aktiviert ist.

readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.8]

onAdded

Tritt auf, wenn dem Arbeitsblatt ein neues Diagramm hinzugefügt wird.

readonly onAdded: OfficeExtension.EventHandlers<Excel.ChartAddedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.8]

onDeactivated

Tritt auf, wenn ein Diagramm deaktiviert ist.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.8]

onDeleted

Tritt auf, wenn ein Diagramm gelöscht wird.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.ChartDeletedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.8]