ExcelScript.Chart interface

Steht für ein Diagrammobjekt in einer Arbeitsmappe.

Methoden

activate()

Aktiviert das Diagramm auf der Excel-Benutzeroberfläche.

addChartSeries(name, index)

Fügt der Sammlung eine neue Reihe hinzu. Die neue hinzugefügte Datenreihe ist erst sichtbar, wenn Werte, X-Achsenwerte oder Blasengrößen dafür festgelegt sind (je nach Diagrammtyp).

delete()

Löscht das Diagrammobjekt.

getAxes()

Die Achsen des Diagramms.

getCategoryLabelLevel()

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

getChartType()

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

getDataLabels()

Stellt die Datenbeschriftungen im Diagramm dar.

getDisplayBlanksAs()

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

getFormat()

Kapselt die Formateigenschaften für den Diagrammbereich.

getHeight()

Gibt die Höhe des Diagrammobjekts in Punkt an.

getId()

Die eindeutige ID des Diagramms.

getImage(width, height, fittingMode)

Rendert das Diagramm als base64-codiertes Bild durch Skalierung, um es an die angegebenen Maße anzupassen. Das Seitenverhältnis wird als Teil der Größenänderung beibehalten.

getLeft()

Der Abstand von der linken Seite des Diagramms zu dem Ursprung des Arbeitsblatts (in Punkten).

getLegend()

Die Legende für das Diagramm.

getName()

Gibt den Namen eines Diagrammobjekts an.

getPivotOptions()

Verkapselt die Optionen für ein PivotChart.

getPlotArea()

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

getPlotBy()

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

getPlotVisibleOnly()

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

getSeries()

Eine einzelne Datenreihe oder eine Sammlung von Datenreihen im Diagramm.

getSeriesNameLevel()

Gibt eine Enumerationskonstante auf Der Namensebene der Diagrammreihe an, die auf die Ebene der Quelldatenreihennamen verweist.

getShowAllFieldButtons()

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

getShowDataLabelsOverMaximum()

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.

getStyle()

Gibt die Diagrammformatvorlage für das Diagramm an.

getTitle()

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

getTop()

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.

getWidth()

Gibt die Breite des Diagrammobjekts in Punkt an.

getWorksheet()

Das Arbeitsblatt, das das aktuelle Diagramm enthält.

setCategoryLabelLevel(categoryLabelLevel)

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

setChartType(chartType)

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

setData(sourceData, seriesBy)

Setzt die Quelldaten für das Diagramm zurück.

setDisplayBlanksAs(displayBlanksAs)

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

setHeight(height)

Gibt die Höhe des Diagrammobjekts in Punkt an.

setLeft(left)

Der Abstand von der linken Seite des Diagramms zu dem Ursprung des Arbeitsblatts (in Punkten).

setName(name)

Gibt den Namen eines Diagrammobjekts an.

setPlotBy(plotBy)

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

setPlotVisibleOnly(plotVisibleOnly)

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

setPosition(startCell, endCell)

Positioniert das Diagramm im Verhältnis zu den Zellen im Arbeitsblatt.

setSeriesNameLevel(seriesNameLevel)

Gibt eine Enumerationskonstante auf Der Namensebene der Diagrammreihe an, die auf die Ebene der Quelldatenreihennamen verweist.

setShowAllFieldButtons(showAllFieldButtons)

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

setShowDataLabelsOverMaximum(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.

setStyle(style)

Gibt die Diagrammformatvorlage für das Diagramm an.

setTop(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.

setWidth(width)

Gibt die Breite des Diagrammobjekts in Punkt an.

Details zur Methode

activate()

Aktiviert das Diagramm auf der Excel-Benutzeroberfläche.

activate(): void;

Gibt zurück

void

addChartSeries(name, index)

Fügt der Sammlung eine neue Reihe hinzu. Die neue hinzugefügte Datenreihe ist erst sichtbar, wenn Werte, X-Achsenwerte oder Blasengrößen dafür festgelegt sind (je nach Diagrammtyp).

addChartSeries(name?: string, index?: number): ChartSeries;

Parameter

name

string

Optional. Name der Datenreihe.

index

number

Optional. Indexwert der hinzuzufügenden Datenreihe. Nullindiziert.

Gibt zurück

delete()

Löscht das Diagrammobjekt.

delete(): void;

Gibt zurück

void

getAxes()

Die Achsen des Diagramms.

getAxes(): ChartAxes;

Gibt zurück

getCategoryLabelLevel()

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

getCategoryLabelLevel(): number;

Gibt zurück

number

getChartType()

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

getChartType(): ChartType;

Gibt zurück

getDataLabels()

Stellt die Datenbeschriftungen im Diagramm dar.

getDataLabels(): ChartDataLabels;

Gibt zurück

getDisplayBlanksAs()

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

getDisplayBlanksAs(): ChartDisplayBlanksAs;

Gibt zurück

getFormat()

Kapselt die Formateigenschaften für den Diagrammbereich.

getFormat(): ChartAreaFormat;

Gibt zurück

getHeight()

Gibt die Höhe des Diagrammobjekts in Punkt an.

getHeight(): number;

Gibt zurück

number

getId()

Die eindeutige ID des Diagramms.

getId(): string;

Gibt zurück

string

getImage(width, height, fittingMode)

Rendert das Diagramm als base64-codiertes Bild durch Skalierung, um es an die angegebenen Maße anzupassen. Das Seitenverhältnis wird als Teil der Größenänderung beibehalten.

getImage(
            width?: number,
            height?: number,
            fittingMode?: ImageFittingMode
        ): string;

Parameter

width

number

Optional. Die gewünschte Breite des resultierenden Bilds.

height

number

Optional. Die gewünschte Höhe des resultierenden Bilds.

fittingMode
ExcelScript.ImageFittingMode

Optional. Die Methode, mit der das Diagramm auf die angegebenen Abmessungen skaliert wird (wenn Höhe und Breite festgelegt sind).

Gibt zurück

string

getLeft()

Der Abstand von der linken Seite des Diagramms zu dem Ursprung des Arbeitsblatts (in Punkten).

getLeft(): number;

Gibt zurück

number

getLegend()

Die Legende für das Diagramm.

getLegend(): ChartLegend;

Gibt zurück

getName()

Gibt den Namen eines Diagrammobjekts an.

getName(): string;

Gibt zurück

string

getPivotOptions()

Verkapselt die Optionen für ein PivotChart.

getPivotOptions(): ChartPivotOptions;

Gibt zurück

getPlotArea()

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

getPlotArea(): ChartPlotArea;

Gibt zurück

getPlotBy()

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

getPlotBy(): ChartPlotBy;

Gibt zurück

Beispiele

/**
 * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
  
  // Switch the row and column for the chart's data source.
  if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
    // If the chart is grouped by columns, switch it to rows.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
  } else {
    // If the chart is grouped by rows, switch it to columns.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
  }
}

getPlotVisibleOnly()

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

getPlotVisibleOnly(): boolean;

Gibt zurück

boolean

getSeries()

Eine einzelne Datenreihe oder eine Sammlung von Datenreihen im Diagramm.

getSeries(): ChartSeries[];

Gibt zurück

Beispiele

/**
 * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let chart = selectedSheet.getChart("ColumnClusteredChart");

  // Set the overlap of every column of each series within a category.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
    series.setOverlap(25);
  });
}

getSeriesNameLevel()

Gibt eine Enumerationskonstante auf Der Namensebene der Diagrammreihe an, die auf die Ebene der Quelldatenreihennamen verweist.

getSeriesNameLevel(): number;

Gibt zurück

number

getShowAllFieldButtons()

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

getShowAllFieldButtons(): boolean;

Gibt zurück

boolean

getShowDataLabelsOverMaximum()

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.

getShowDataLabelsOverMaximum(): boolean;

Gibt zurück

boolean

getStyle()

Gibt die Diagrammformatvorlage für das Diagramm an.

getStyle(): number;

Gibt zurück

number

getTitle()

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

getTitle(): ChartTitle;

Gibt zurück

getTop()

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.

getTop(): number;

Gibt zurück

number

getWidth()

Gibt die Breite des Diagrammobjekts in Punkt an.

getWidth(): number;

Gibt zurück

number

getWorksheet()

Das Arbeitsblatt, das das aktuelle Diagramm enthält.

getWorksheet(): Worksheet;

Gibt zurück

setCategoryLabelLevel(categoryLabelLevel)

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

setCategoryLabelLevel(categoryLabelLevel: number): void;

Parameter

categoryLabelLevel

number

Gibt zurück

void

setChartType(chartType)

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

setChartType(chartType: ChartType): void;

Parameter

Gibt zurück

void

setData(sourceData, seriesBy)

Setzt die Quelldaten für das Diagramm zurück.

setData(sourceData: Range, seriesBy?: ChartSeriesBy): void;

Parameter

sourceData
ExcelScript.Range

Das Bereichsobjekt, das den Quelldaten entspricht.

seriesBy
ExcelScript.ChartSeriesBy

Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden. Dies kann eine der folgenden Optionen sein: Auto (Standard), Zeilen und Spalten. Weitere Informationen finden Sie ExcelScript.ChartSeriesBy unter.

Gibt zurück

void

setDisplayBlanksAs(displayBlanksAs)

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

setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;

Parameter

Gibt zurück

void

setHeight(height)

Gibt die Höhe des Diagrammobjekts in Punkt an.

setHeight(height: number): void;

Parameter

height

number

Gibt zurück

void

setLeft(left)

Der Abstand von der linken Seite des Diagramms zu dem Ursprung des Arbeitsblatts (in Punkten).

setLeft(left: number): void;

Parameter

left

number

Gibt zurück

void

setName(name)

Gibt den Namen eines Diagrammobjekts an.

setName(name: string): void;

Parameter

name

string

Gibt zurück

void

Beispiele

/**
 * This sample creates a column-clustered chart based on the current worksheet's data.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the data range.
  let range = selectedSheet.getUsedRange();

  // Insert a chart using the data on the current worksheet.
  let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

  // Name the chart for easy access in other scripts.
  chart.setName("ColumnChart");
}

setPlotBy(plotBy)

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

setPlotBy(plotBy: ChartPlotBy): void;

Parameter

Gibt zurück

void

Beispiele

/**
 * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
  
  // Switch the row and column for the chart's data source.
  if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
    // If the chart is grouped by columns, switch it to rows.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
  } else {
    // If the chart is grouped by rows, switch it to columns.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
  }
}

setPlotVisibleOnly(plotVisibleOnly)

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

setPlotVisibleOnly(plotVisibleOnly: boolean): void;

Parameter

plotVisibleOnly

boolean

Gibt zurück

void

setPosition(startCell, endCell)

Positioniert das Diagramm im Verhältnis zu den Zellen im Arbeitsblatt.

setPosition(startCell: Range | string, endCell?: Range | string): void;

Parameter

startCell

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

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

Beispiele

/**
 * This sample moves an existing chart to a specific place on the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();
  
  // Get an existing chart named "ColumnChart".
  let chart = selectedSheet.getChart("ColumnChart");

  // Place the chart over the range "F1:L13".
  chart.setPosition("F1", "L13");
}

setSeriesNameLevel(seriesNameLevel)

Gibt eine Enumerationskonstante auf Der Namensebene der Diagrammreihe an, die auf die Ebene der Quelldatenreihennamen verweist.

setSeriesNameLevel(seriesNameLevel: number): void;

Parameter

seriesNameLevel

number

Gibt zurück

void

setShowAllFieldButtons(showAllFieldButtons)

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

setShowAllFieldButtons(showAllFieldButtons: boolean): void;

Parameter

showAllFieldButtons

boolean

Gibt zurück

void

setShowDataLabelsOverMaximum(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.

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;

Parameter

showDataLabelsOverMaximum

boolean

Gibt zurück

void

setStyle(style)

Gibt die Diagrammformatvorlage für das Diagramm an.

setStyle(style: number): void;

Parameter

style

number

Gibt zurück

void

setTop(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.

setTop(top: number): void;

Parameter

top

number

Gibt zurück

void

setWidth(width)

Gibt die Breite des Diagrammobjekts in Punkt an.

setWidth(width: number): void;

Parameter

width

number

Gibt zurück

void