Excel.ChartSeriesCollection class
Stellt eine Sammlung von Diagrammdatenreihen dar.
- Extends
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 Datenreihen in der Sammlung zurück. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(name, index) | Fügt der Sammlung eine neue Reihe hinzu. Die neu hinzugefügte Reihe ist erst sichtbar, wenn Werte, x-Achsenwerte oder Blasengrößen für sie festgelegt sind (je nach Diagrammtyp). |
| get |
Gibt die Anzahl der Datenreihen in der Sammlung zurück. |
| get |
Ruft eine Datenreihe anhand ihrer Position in der Sammlung ab. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
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 Datenreihen in der Sammlung zurück.
readonly count: number;Eigenschaftswert
number
Hinweise
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.ChartSeries[];Eigenschaftswert
Details zur Methode
add(name, index)
Fügt der Sammlung eine neue Reihe hinzu. Die neu hinzugefügte Reihe ist erst sichtbar, wenn Werte, x-Achsenwerte oder Blasengrößen für sie festgelegt sind (je nach Diagrammtyp).
add(name?: string, index?: number): Excel.ChartSeries;Parameter
- name
-
string
Optional. Name der Serie.
- index
-
number
Optional. Indexwert der hinzuzufügenden Reihe. Nullindiziert.
Gibt zurück
Hinweise
getCount()
Gibt die Anzahl der Datenreihen in der Sammlung zurück.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItemAt(index)
Ruft eine Datenreihe anhand ihrer Position in der Sammlung ab.
getItemAt(index: number): Excel.ChartSeries;Parameter
- index
-
number
Index-Wert des abzurufenden Objekts. Nullindiziert.
Gibt zurück
Hinweise
Beispiele
// Get the name of the first series in the series collection.
await Excel.run(async (context) => {
const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
seriesCollection.load('items');
await context.sync();
console.log(seriesCollection.items[0].name);
});
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.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection;Parameter
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.ChartSeriesCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
// Get the number of chart series in the collection.
await Excel.run(async (context) => {
const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
seriesCollection.load('count');
await context.sync();
console.log("series: Count= " + seriesCollection.count);
});
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.ChartSeriesCollection;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.ChartSeriesCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartSeriesCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): Excel.Interfaces.ChartSeriesCollectionData;