Excel.Chart class
Steht für ein Diagrammobjekt in einer Arbeitsmappe. Weitere Informationen zum Diagrammobjektmodell finden Sie unter Arbeiten mit Diagrammen mithilfe der Excel-JavaScript-API.
- Extends
Hinweise
Eigenschaften
| axes | Die Achsen des Diagramms. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| data |
Stellt die Datenbeschriftungen im Diagramm dar. |
| format | Kapselt die Formateigenschaften für den Diagrammbereich. |
| height | Gibt die Höhe des Diagrammobjekts in Punkt an. |
| left | Der Abstand von der linken Seite des Diagramms zu dem Ursprung des Arbeitsblatts (in Punkten). |
| legend | Die Legende für das Diagramm. |
| name | Gibt den Namen eines Diagrammobjekts an. |
| series | Eine einzelne Datenreihe oder eine Sammlung von Datenreihen im Diagramm. |
| title | Der Titel des angegebenen Diagramms, einschließlich Text, Sichtbarkeit, Position und Formatierung des Titels. |
| top | Gibt den Abstand zwischen dem oberen Rand des Objekts und dem oberen Rand der Zeile 1 (auf einem Arbeitsblatt) oder dem oberen Rand des Diagrammbereichs (in einem Diagramm) in Punkt an. |
| width | Gibt die Breite des Diagrammobjekts in Punkt an. |
| worksheet | Das Arbeitsblatt, das das aktuelle Diagramm enthält. |
Methoden
| delete() | Löscht das Diagrammobjekt. |
| get |
Rendert das Diagramm als Base64-codiertes Bild, indem das Diagramm entsprechend den angegebenen Dimensionen skaliert wird. Das Seitenverhältnis wird im Rahmen der Größenänderung beibehalten. |
| get |
Rendert das Diagramm als Base64-codiertes Bild, indem das Diagramm entsprechend den angegebenen Dimensionen skaliert wird. Das Seitenverhältnis wird im Rahmen der Größenänderung beibehalten. |
| 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 " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| set |
Setzt die Quelldaten für das Diagramm zurück. |
| set |
Setzt die Quelldaten für das Diagramm zurück. |
| set |
Positioniert das Diagramm im Verhältnis zu den Zellen im Arbeitsblatt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
axes
Die Achsen des Diagramms.
readonly axes: Excel.ChartAxes;Eigenschaftswert
Hinweise
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
dataLabels
Stellt die Datenbeschriftungen im Diagramm dar.
readonly dataLabels: Excel.ChartDataLabels;Eigenschaftswert
Hinweise
format
Kapselt die Formateigenschaften für den Diagrammbereich.
readonly format: Excel.ChartAreaFormat;Eigenschaftswert
Hinweise
height
Gibt die Höhe des Diagrammobjekts in Punkt an.
height: number;Eigenschaftswert
number
Hinweise
left
Der Abstand von der linken Seite des Diagramms zu dem Ursprung des Arbeitsblatts (in Punkten).
left: number;Eigenschaftswert
number
Hinweise
legend
Die Legende für das Diagramm.
readonly legend: Excel.ChartLegend;Eigenschaftswert
Hinweise
Beispiele
// Set to show legend of Chart1 and make it on top of the chart.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.legend.visible = true;
chart.legend.position = "Top";
chart.legend.overlay = false;
await context.sync()
console.log("Legend Shown ");
});
name
Gibt den Namen eines Diagrammobjekts an.
name: string;Eigenschaftswert
string
Hinweise
Beispiele
// Rename the chart to new name, resize the chart to 200 points in both height and weight.
// Move Chart1 to 100 points to the top and left.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.name = "New Name";
chart.top = 100;
chart.left = 100;
chart.height = 200;
chart.width = 200;
await context.sync();
});
series
Eine einzelne Datenreihe oder eine Sammlung von Datenreihen im Diagramm.
readonly series: Excel.ChartSeriesCollection;Eigenschaftswert
Hinweise
title
Der Titel des angegebenen Diagramms, einschließlich Text, Sichtbarkeit, Position und Formatierung des Titels.
readonly title: Excel.ChartTitle;Eigenschaftswert
Hinweise
top
Gibt den Abstand zwischen dem oberen Rand des Objekts und dem oberen Rand der Zeile 1 (auf einem Arbeitsblatt) oder dem oberen Rand des Diagrammbereichs (in einem Diagramm) in Punkt an.
top: number;Eigenschaftswert
number
Hinweise
width
Gibt die Breite des Diagrammobjekts in Punkt an.
width: number;Eigenschaftswert
number
Hinweise
worksheet
Das Arbeitsblatt, das das aktuelle Diagramm enthält.
readonly worksheet: Excel.Worksheet;Eigenschaftswert
Hinweise
Details zur Methode
delete()
Löscht das Diagrammobjekt.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.delete();
await context.sync();
});
getImage(width, height, fittingMode)
Rendert das Diagramm als Base64-codiertes Bild, indem das Diagramm entsprechend den angegebenen Dimensionen skaliert wird. Das Seitenverhältnis wird im Rahmen der Größenänderung beibehalten.
getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;Parameter
- width
-
number
Optional. Die gewünschte Breite des resultierenden Bilds.
- height
-
number
Optional. Die gewünschte Höhe des resultierenden Bilds.
- fittingMode
- Excel.ImageFittingMode
Optional. Die Methode, die verwendet wird, um das Diagramm auf die angegebenen Dimensionen zu skalieren (wenn sowohl Höhe als auch Breite festgelegt sind).
Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const image = chart.getImage();
await context.sync();
});
getImage(width, height, fittingModeString)
Rendert das Diagramm als Base64-codiertes Bild, indem das Diagramm entsprechend den angegebenen Dimensionen skaliert wird. Das Seitenverhältnis wird im Rahmen der Größenänderung beibehalten.
getImage(width?: number, height?: number, fittingModeString?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;Parameter
- width
-
number
Optional. Die gewünschte Breite des resultierenden Bilds.
- height
-
number
Optional. Die gewünschte Höhe des resultierenden Bilds.
- fittingModeString
-
"Fit" | "FitAndCenter" | "Fill"
Optional. Die Methode, die verwendet wird, um das Diagramm auf die angegebenen Dimensionen zu skalieren (wenn sowohl Höhe als auch Breite festgelegt sind).
Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
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.ChartLoadOptions): Excel.Chart;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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.Chart;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 a chart named "Chart1".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.load('name');
await context.sync();
console.log(chart.name);
});
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?: {
select?: string;
expand?: string;
}): Excel.Chart;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.ChartUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.Chart): void;Parameter
- properties
- Excel.Chart
Gibt zurück
void
setData(sourceData, seriesBy)
Setzt die Quelldaten für das Diagramm zurück.
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;Parameter
- sourceData
- Excel.Range
Das Bereichsobjekt, das den Quelldaten entspricht.
- seriesBy
- Excel.ChartSeriesBy
Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden. Dies kann eine der folgenden Werte sein: Auto (Standard), Zeilen und Spalten. Weitere Informationen finden Sie unter Excel.ChartSeriesBy .
Gibt zurück
void
Hinweise
Beispiele
// Set the sourceData to be the range at "A1:B4" and seriesBy to be "Columns".
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
const chart = sheet.charts.getItem("Chart1");
const sourceData = sheet.getRange("A1:B4");
chart.setData(sourceData, "Columns");
await context.sync();
});
setData(sourceData, seriesByString)
Setzt die Quelldaten für das Diagramm zurück.
setData(sourceData: Range, seriesByString?: "Auto" | "Columns" | "Rows"): void;Parameter
- sourceData
- Excel.Range
Das Bereichsobjekt, das den Quelldaten entspricht.
- seriesByString
-
"Auto" | "Columns" | "Rows"
Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden. Dies kann eine der folgenden Werte sein: Auto (Standard), Zeilen und Spalten. Weitere Informationen finden Sie unter Excel.ChartSeriesBy .
Gibt zurück
void
Hinweise
setPosition(startCell, endCell)
Positioniert das Diagramm im Verhältnis zu den Zellen im Arbeitsblatt.
setPosition(startCell: Range | string, endCell?: Range | string): void;Parameter
- startCell
-
Excel.Range | string
Die Startzelle. An diese Position wird das Diagramm verschoben. Die Startzelle ist die obere linke oder die obere rechte Zelle, abhängig davon, ob die eingestellte Textrichtung des Benutzers von links nach rechts oder von rechts nach links ist.
- endCell
-
Excel.Range | string
Optional. Die Endzelle. Wenn angegeben, werden Breite und Höhe des Diagramms so eingestellt, dass diese Zelle/dieser Bereich vollständig bedeckt ist.
Gibt zurück
void
Hinweise
Beispiele
await Excel.run(async (context) => {
const sheetName = "Charts";
const rangeSelection = "A1:B4";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeSelection);
const sourceData = sheetName + "!" + "A1:B4";
const chart = context.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto");
chart.width = 500;
chart.height = 300;
chart.setPosition("C2", null);
await context.sync();
});
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 das Objekt übergeben wird.) Während das ursprüngliche Excel.Chart Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.ChartData;Gibt zurück
Office Add-ins