Excel. Chart class

Eigenschaften

axes	Die Achsen des Diagramms.
categoryLabelLevel	Gibt eine Enumerationskonstante auf Diagrammkategoriebeschriftungsebene an, die auf die Ebene der Quellkategoriebezeichnungen verweist.
chartType	Gibt den Typ des Diagramms an. Weitere Informationen finden Sie unter `Excel.ChartType` .
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
dataLabels	Stellt die Datenbeschriftungen im Diagramm dar.
displayBlanksAs	Gibt an, wie leere Zellen in einem Diagramm gezeichnet werden.
format	Kapselt die Formateigenschaften für den Diagrammbereich.
height	Gibt die Höhe des Diagrammobjekts in Punkt an.
id	Die eindeutige ID des Diagramms.
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.
pivotOptions	Verkapselt die Optionen für ein PivotChart.
plotArea	Stellt die Zeichnungsfläche für das Diagramm dar.
plotBy	Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden.
plotVisibleOnly	„True“, wenn nur sichtbare Zellen dargestellt werden. „False“, wenn sowohl sichtbare als auch ausgeblendete Zellen dargestellt werden.
series	Eine einzelne Datenreihe oder eine Sammlung von Datenreihen im Diagramm.
seriesNameLevel	Gibt eine Enumerationskonstante der Diagrammreihe auf Namesebene an, die auf die Ebene der Quellreihennamen verweist.
showAllFieldButtons	Gibt an, ob alle Feldschaltflächen in einem PivotChart angezeigt werden sollen.
showDataLabelsOverMaximum	Gibt an, ob die Datenbeschriftungen angezeigt werden sollen, wenn der Wert größer als der Maximalwert auf der Größenachse ist. Wenn die Größenachse kleiner als die Größe der Datenpunkte wird, können Sie mit dieser Eigenschaft festlegen, ob die Datenbeschriftungen angezeigt werden sollen. Diese Eigenschaft kann nur auf 2D-Diagramme angewendet werden.
style	Gibt die Diagrammart für das Diagramm an.
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

activate()	Aktiviert das Diagramm auf der Excel-Benutzeroberfläche.
delete()	Löscht das Diagrammobjekt.
getDataRange()	Ruft die Datenquelle des gesamten Diagramms ab. Wenn der Datenbereich leer ist, gibt diese Methode den `EmptyChartSeries` Fehler zurück.
getDataRangeOrNullObject()	Ruft die Datenquelle des gesamten Diagramms ab. Wenn der Datenbereich leer ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getDataTable()	Ruft die Datentabelle im Diagramm ab. Wenn das Diagramm keine Datentabelle zulässt, wird eine Ausnahme ausgelöst.
getDataTableOrNullObject()	Ruft die Datentabelle im Diagramm ab. Wenn das Diagramm keine Datentabelle zulässt, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
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, 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.
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.
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.
setData(sourceData, seriesBy)	Setzt die Quelldaten für das Diagramm zurück.
setData(sourceData, seriesByString)	Setzt die Quelldaten für das Diagramm zurück.
setPosition(startCell, endCell)	Positioniert das Diagramm im Verhältnis zu den Zellen im Arbeitsblatt.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft 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.

Ereignisse

onActivated	Tritt auf, wenn das Diagramm aktiviert wird.
onDeactivated	Tritt auf, wenn das Diagramm deaktiviert wird.

Details zur Eigenschaft

axes

Die Achsen des Diagramms.

readonly axes: Excel.ChartAxes;

Eigenschaftswert

Excel.ChartAxes

Hinweise

categoryLabelLevel

Gibt eine Enumerationskonstante auf Diagrammkategoriebeschriftungsebene an, die auf die Ebene der Quellkategoriebezeichnungen verweist.

categoryLabelLevel: number;

Eigenschaftswert

number

Hinweise

chartType

Gibt den Typ des Diagramms an. Weitere Informationen finden Sie unter Excel.ChartType .

chartType: Excel.ChartType | "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";

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

Excel.RequestContext

dataLabels

Stellt die Datenbeschriftungen im Diagramm dar.

readonly dataLabels: Excel.ChartDataLabels;

Eigenschaftswert

Excel.ChartDataLabels

Hinweise

displayBlanksAs

Gibt an, wie leere Zellen in einem Diagramm gezeichnet werden.

displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";

Eigenschaftswert

Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

Hinweise

format

Kapselt die Formateigenschaften für den Diagrammbereich.

readonly format: Excel.ChartAreaFormat;

Eigenschaftswert

Excel.ChartAreaFormat

Hinweise

height

Gibt die Höhe des Diagrammobjekts in Punkt an.

height: number;

Eigenschaftswert

number

Hinweise

id

Die eindeutige ID des Diagramms.

readonly id: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

Excel.ChartLegend

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(); 
});

pivotOptions

Verkapselt die Optionen für ein PivotChart.

readonly pivotOptions: Excel.ChartPivotOptions;

Eigenschaftswert

Excel.ChartPivotOptions

Hinweise

[ API-Satz: ExcelApi 1.9 ]

plotArea

Stellt die Zeichnungsfläche für das Diagramm dar.

readonly plotArea: Excel.ChartPlotArea;

Eigenschaftswert

Excel.ChartPlotArea

Hinweise

plotBy

Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden.

plotBy: Excel.ChartPlotBy | "Rows" | "Columns";

Eigenschaftswert

Excel.ChartPlotBy | "Rows" | "Columns"

Hinweise

plotVisibleOnly

„True“, wenn nur sichtbare Zellen dargestellt werden. „False“, wenn sowohl sichtbare als auch ausgeblendete Zellen dargestellt werden.

plotVisibleOnly: boolean;

Eigenschaftswert

boolean

Hinweise

series

Eine einzelne Datenreihe oder eine Sammlung von Datenreihen im Diagramm.

readonly series: Excel.ChartSeriesCollection;

Eigenschaftswert

Excel.ChartSeriesCollection

Hinweise

seriesNameLevel

Gibt eine Enumerationskonstante der Diagrammreihe auf Namesebene an, die auf die Ebene der Quellreihennamen verweist.

seriesNameLevel: number;

Eigenschaftswert

number

Hinweise

showAllFieldButtons

Gibt an, ob alle Feldschaltflächen in einem PivotChart angezeigt werden sollen.

showAllFieldButtons: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

showDataLabelsOverMaximum

Gibt an, ob die Datenbeschriftungen angezeigt werden sollen, wenn der Wert größer als der Maximalwert auf der Größenachse ist. Wenn die Größenachse kleiner als die Größe der Datenpunkte wird, können Sie mit dieser Eigenschaft festlegen, ob die Datenbeschriftungen angezeigt werden sollen. Diese Eigenschaft kann nur auf 2D-Diagramme angewendet werden.

showDataLabelsOverMaximum: boolean;

Eigenschaftswert

boolean

Hinweise

style

Gibt die Diagrammart für das Diagramm an.

style: number;

Eigenschaftswert

number

Hinweise

title

Der Titel des angegebenen Diagramms, einschließlich Text, Sichtbarkeit, Position und Formatierung des Titels.

readonly title: Excel.ChartTitle;

Eigenschaftswert

Excel.ChartTitle

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

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Details zur Methode

activate()

Aktiviert das Diagramm auf der Excel-Benutzeroberfläche.

activate(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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(); 
});

getDataRange()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Datenquelle des gesamten Diagramms ab. Wenn der Datenbereich leer ist, gibt diese Methode den EmptyChartSeries Fehler zurück.

getDataRange(): OfficeExtension.ClientResult<string>;

Gibt zurück

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

Hinweise

getDataRangeOrNullObject()

Hinweis

Ruft die Datenquelle des gesamten Diagramms ab. Wenn der Datenbereich leer ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getDataRangeOrNullObject(): OfficeExtension.ClientResult<string>;

Gibt zurück

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

Hinweise

getDataTable()

Ruft die Datentabelle im Diagramm ab. Wenn das Diagramm keine Datentabelle zulässt, wird eine Ausnahme ausgelöst.

getDataTable(): Excel.ChartDataTable;

Gibt zurück

Excel.ChartDataTable

Hinweise

[ API-Satz: ExcelApi 1.14 ]

getDataTableOrNullObject()

Ruft die Datentabelle im Diagramm ab. Wenn das Diagramm keine Datentabelle zulässt, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getDataTableOrNullObject(): Excel.ChartDataTable;

Gibt zurück

Excel.ChartDataTable

Hinweise

[ API-Satz: ExcelApi 1.14 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml

// This function adds a data table to a chart that already exists on the worksheet. 
await Excel.run(async (context) => {
  // Retrieve the chart named "SalesChart" from the "Sample" worksheet.
  const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart");

  // Get the data table object for the chart and set it to visible.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load("visible");
  chartDataTable.visible = true;
  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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

options: Excel.Interfaces.ChartLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.Chart

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

Excel.Chart

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

Excel.Chart

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 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

OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>

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

Excel.Interfaces.ChartData

Details zum Ereignis

onActivated

Tritt auf, wenn das Diagramm aktiviert wird.

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

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartActivated(event) {
    await Excel.run(async (context) => {
        // Retrieve the worksheet.
        const sheet = context.workbook.worksheets.getActiveWorksheet();

        // Retrieve the activated chart by ID and load the name of the chart. 
        const activatedChart = sheet.charts.getItem(event.chartId);
        activatedChart.load(["name"]);
        await context.sync();

        // Print out the activated chart's data.
        console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`);
    });
}

onDeactivated

Tritt auf, wenn das Diagramm deaktiviert wird.

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

Ereignistyp

Hinweise