Excel.ChartDataLabels class

Stellt eine Sammlung aller Datenbeschriftungen an einem Diagrammpunkt dar.

Extends

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

autoText

Gibt an, ob Datenbeschriftungen basierend auf dem Kontext automatisch geeigneten Text generieren.

context

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

format

Gibt das Format von Diagrammdatenbeschriftungen an, einschließlich Füll- und Schriftartformatierung.

horizontalAlignment

Gibt die horizontale Ausrichtung für die Diagrammdatenbezeichnung an. Weitere Informationen finden Sie unter Excel.ChartTextHorizontalAlignment . Diese Eigenschaft ist nur gültig, wenn der TextOrientation der Datenbeschriftung 0 ist.

linkNumberFormat

Gibt an, ob das Zahlenformat mit den Zellen verknüpft ist. Gibt truean, dass sich das Zahlenformat in den Bezeichnungen ändert, wenn es sich in den Zellen ändert.

numberFormat

Gibt den Formatcode für Datenbeschriftungen an.

position

Wert, der die Position der Datenbeschriftung darstellt. Weitere Informationen finden Sie unter Excel.ChartDataLabelPosition .

separator

Zeichenfolge, die das Trennzeichen für die Datenbeschriftungen in einem Diagramm darstellt.

showBubbleSize

Gibt an, ob die Größe der Datenbezeichnungsblase sichtbar ist.

showCategoryName

Gibt an, ob der Kategoriename der Datenbezeichnung sichtbar ist.

showLegendKey

Gibt an, ob der Legendenschlüssel der Datenbezeichnung sichtbar ist.

showPercentage

Gibt an, ob der Prozentsatz der Datenbezeichnung sichtbar ist.

showSeriesName

Gibt an, ob der Datenbezeichnungsreihenname sichtbar ist.

showValue

Gibt an, ob der Datenbeschriftungswert sichtbar ist.

textOrientation

Stellt den Winkel dar, an dem der Text für Datenbeschriftungen ausgerichtet ist. Der Wert sollte entweder eine ganze Zahl von -90 bis 90 oder die ganze Zahl 180 für vertikal ausgerichteten Text sein.

verticalAlignment

Stellt die vertikale Ausrichtung der Diagrammdatenbeschriftung dar. Weitere Informationen finden Sie unter Excel.ChartTextVerticalAlignment . Diese Eigenschaft ist nur gültig, wenn TextOrientation die Datenbezeichnung -90, 90 oder 180 ist.

Methoden

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.

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.ChartDataLabels Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartDataLabelsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

autoText

Gibt an, ob Datenbeschriftungen basierend auf dem Kontext automatisch geeigneten Text generieren.

autoText: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

format

Gibt das Format von Diagrammdatenbeschriftungen an, einschließlich Füll- und Schriftartformatierung.

readonly format: Excel.ChartDataLabelFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

horizontalAlignment

Gibt die horizontale Ausrichtung für die Diagrammdatenbezeichnung an. Weitere Informationen finden Sie unter Excel.ChartTextHorizontalAlignment . Diese Eigenschaft ist nur gültig, wenn der TextOrientation der Datenbeschriftung 0 ist.

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Eigenschaftswert

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

Hinweise

[ API-Satz: ExcelApi 1.8 ]

linkNumberFormat

Gibt an, ob das Zahlenformat mit den Zellen verknüpft ist. Gibt truean, dass sich das Zahlenformat in den Bezeichnungen ändert, wenn es sich in den Zellen ändert.

linkNumberFormat: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

numberFormat

Gibt den Formatcode für Datenbeschriftungen an.

numberFormat: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.8 ]

position

Wert, der die Position der Datenbeschriftung darstellt. Weitere Informationen finden Sie unter Excel.ChartDataLabelPosition .

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

Eigenschaftswert

Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"

Hinweise

[ API-Satz: ExcelApi 1.1 ]

separator

Zeichenfolge, die das Trennzeichen für die Datenbeschriftungen in einem Diagramm darstellt.

separator: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.1 ]

showBubbleSize

Gibt an, ob die Größe der Datenbezeichnungsblase sichtbar ist.

showBubbleSize: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

showCategoryName

Gibt an, ob der Kategoriename der Datenbezeichnung sichtbar ist.

showCategoryName: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

showLegendKey

Gibt an, ob der Legendenschlüssel der Datenbezeichnung sichtbar ist.

showLegendKey: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

showPercentage

Gibt an, ob der Prozentsatz der Datenbezeichnung sichtbar ist.

showPercentage: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

showSeriesName

Gibt an, ob der Datenbezeichnungsreihenname sichtbar ist.

showSeriesName: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

showValue

Gibt an, ob der Datenbeschriftungswert sichtbar ist.

showValue: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

textOrientation

Stellt den Winkel dar, an dem der Text für Datenbeschriftungen ausgerichtet ist. Der Wert sollte entweder eine ganze Zahl von -90 bis 90 oder die ganze Zahl 180 für vertikal ausgerichteten Text sein.

textOrientation: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.8 ]

verticalAlignment

Stellt die vertikale Ausrichtung der Diagrammdatenbeschriftung dar. Weitere Informationen finden Sie unter Excel.ChartTextVerticalAlignment . Diese Eigenschaft ist nur gültig, wenn TextOrientation die Datenbezeichnung -90, 90 oder 180 ist.

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Eigenschaftswert

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Details zur Methode

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.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

Parameter

options
Excel.Interfaces.ChartDataLabelsLoadOptions

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.ChartDataLabels;

Parameter

propertyNames

string | string[]

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

Gibt zurück

Beispiele

// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
    chart.dataLabels.showValue = true;
    chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
    chart.dataLabels.showSeriesName = true;
    await context.sync();

    console.log("Data labels shown");
});

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.ChartDataLabels;

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.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties
Excel.Interfaces.ChartDataLabelsUpdateData

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.ChartDataLabels): void;

Parameter

Gibt zurück

void

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.ChartDataLabels Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartDataLabelsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.ChartDataLabelsData;

Gibt zurück