Excel.ChartDataLabels class

Stellt eine Sammlung aller Datenbeschriftungen an einem Diagrammpunkt dar.

Extends

Eigenschaften

autoText

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

context

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

format

Gibt das Format von Diagrammdatenbeschriftungen an, das Füll- und Schriftartformatierung umfasst.

geometricShapeType

Gibt den geometrischen Formtyp der Datenbeschriftungen an. Weitere Details finden Sie unter Excel.GeometricShapeType. Wert ist null angegeben, wenn die Datenbeschriftungen keine geometrischen Formen sind.

horizontalAlignment

Gibt die horizontale Ausrichtung für die Diagrammdatenbeschriftung an. Weitere Informationen findest du hier Excel.ChartTextHorizontalAlignment . Diese Eigenschaft ist nur gültig, wenn die OF-Datenbeschriftung TextOrientation 0 ist.

leaderLines

Ruft ein Objekt ab, das die Führungslinien der Datenbeschriftungen darstellt.

linkNumberFormat

Gibt an, ob das Zahlenformat mit den Zellen verknüpft ist. If true, ändert sich das Zahlenformat in den Beschriftungen, 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 findest du hier Excel.ChartDataLabelPosition .

separator

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

showAsStickyCallout

Gibt an, ob die Datenbeschriftungen als Legende mit dem am Datenpunkt angefügten Endanker angezeigt werden. Wenn true, ist die Legende einer der folgenden Werte: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" oder "WedgeEllipseCallout". Weitere Informationen finden Sie unter GeometricShapeType .

showBubbleSize

Gibt an, ob die Blasengröße der Datenbeschriftung sichtbar ist.

showCategoryName

Gibt an, ob der Name der Datenbeschriftungskategorie sichtbar ist.

showLeaderLines

Gibt an, ob Führungslinien für die Datenbeschriftungen angezeigt werden. true wenn Führungslinien angezeigt werden; falseandernfalls .

showLegendKey

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

showPercentage

Gibt an, ob der Prozentsatz der Datenbeschriftung sichtbar ist.

showSeriesName

Gibt an, ob der Name der Datenbeschriftungsserie sichtbar ist.

showValue

Gibt an, ob der Wert der Datenbeschriftung sichtbar ist.

textOrientation

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

verticalAlignment

Stellt die vertikale Ausrichtung der Diagrammdatenbeschriftung dar. Weitere Informationen findest du hier Excel.ChartTextVerticalAlignment . Diese Eigenschaft ist nur gültig, wenn TextOrientation die Datenbeschriftung -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 sie übergeben wird.) Während das ursprüngliche Excel.ChartDataLabels Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ChartDataLabelsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

autoText

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

autoText: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.8

context

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

context: RequestContext;

Eigenschaftswert

format

Gibt das Format von Diagrammdatenbeschriftungen an, das Füll- und Schriftartformatierung umfasst.

readonly format: Excel.ChartDataLabelFormat;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

geometricShapeType

Gibt den geometrischen Formtyp der Datenbeschriftungen an. Weitere Details finden Sie unter Excel.GeometricShapeType. Wert ist null angegeben, wenn die Datenbeschriftungen keine geometrischen Formen sind.

geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

Eigenschaftswert

Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

Hinweise

API-Satz: ExcelApi 1.19

horizontalAlignment

Gibt die horizontale Ausrichtung für die Diagrammdatenbeschriftung an. Weitere Informationen findest du hier Excel.ChartTextHorizontalAlignment . Diese Eigenschaft ist nur gültig, wenn die OF-Datenbeschriftung TextOrientation 0 ist.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.8

leaderLines

Ruft ein Objekt ab, das die Führungslinien der Datenbeschriftungen darstellt.

readonly leaderLines: Excel.ChartLeaderLines;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.19

linkNumberFormat

Gibt an, ob das Zahlenformat mit den Zellen verknüpft ist. If true, ändert sich das Zahlenformat in den Beschriftungen, 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 findest du hier 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

showAsStickyCallout

Gibt an, ob die Datenbeschriftungen als Legende mit dem am Datenpunkt angefügten Endanker angezeigt werden. Wenn true, ist die Legende einer der folgenden Werte: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" oder "WedgeEllipseCallout". Weitere Informationen finden Sie unter GeometricShapeType .

readonly showAsStickyCallout: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.19

showBubbleSize

Gibt an, ob die Blasengröße der Datenbeschriftung sichtbar ist.

showBubbleSize: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

showCategoryName

Gibt an, ob der Name der Datenbeschriftungskategorie sichtbar ist.

showCategoryName: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

showLeaderLines

Gibt an, ob Führungslinien für die Datenbeschriftungen angezeigt werden. true wenn Führungslinien angezeigt werden; falseandernfalls .

showLeaderLines: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.19

showLegendKey

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

showLegendKey: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

showPercentage

Gibt an, ob der Prozentsatz der Datenbeschriftung sichtbar ist.

showPercentage: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

showSeriesName

Gibt an, ob der Name der Datenbeschriftungsserie sichtbar ist.

showSeriesName: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

showValue

Gibt an, ob der Wert der Datenbeschriftung sichtbar ist.

showValue: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

textOrientation

Stellt den Winkel dar, in dem der Text für Datenbeschriftungen ausgerichtet ist. Der Wert sollte entweder eine ganze Zahl zwischen -90 und 90 oder eine 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 findest du hier Excel.ChartTextVerticalAlignment . Diese Eigenschaft ist nur gültig, wenn TextOrientation die Datenbeschriftung -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 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.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 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

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

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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 sie übergeben wird.) Während das ursprüngliche Excel.ChartDataLabels Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ChartDataLabelsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.ChartDataLabelsData;

Gibt zurück