Excel.ChartDataLabel class
Stellt die Datenbeschriftung eines Diagrammpunkts dar.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
// This function styles substrings within data label text using font formatting.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem(sheetName);
const chart = sheet.charts.getItemAt(0);
await context.sync();
const series = chart.series.getItemAt(0);
series.load("points");
await context.sync();
series.points.load("items");
await context.sync();
// Style a substring in the first data label.
let searchString = "sports";
let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
await context.sync();
let substringStart = dataLabel.text.indexOf(searchString);
let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.size = 13;
subLabel.font.bold = true;
// Style a substring in the second data label.
searchString = "'Titanic'";
dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
await context.sync();
substringStart = dataLabel.text.indexOf(searchString);
subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.name = "Calibri";
subLabel.font.size = 13;
subLabel.font.italic = true;
subLabel.font.color = "blue";
await context.sync();
});
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| position | Wert, der die Position der Datenbeschriftung darstellt. Weitere Informationen findest du hier |
| separator | Zeichenfolge, die das Trennzeichen für die Datenbeschriftungen in einem Diagramm darstellt. |
| show |
Gibt an, ob die Blasengröße der Datenbeschriftung sichtbar ist. |
| show |
Gibt an, ob der Name der Datenbeschriftungskategorie sichtbar ist. |
| show |
Gibt an, ob der Legendenschlüssel der Datenbeschriftung sichtbar ist. |
| show |
Gibt an, ob der Prozentsatz der Datenbeschriftung sichtbar ist. |
| show |
Gibt an, ob der Name der Datenbeschriftungsserie sichtbar ist. |
| show |
Gibt an, ob der Wert der Datenbeschriftung sichtbar 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 " |
| 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. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
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
separator
Zeichenfolge, die das Trennzeichen für die Datenbeschriftungen in einem Diagramm darstellt.
separator: string;Eigenschaftswert
string
Hinweise
showBubbleSize
Gibt an, ob die Blasengröße der Datenbeschriftung sichtbar ist.
showBubbleSize: boolean;Eigenschaftswert
boolean
Hinweise
showCategoryName
Gibt an, ob der Name der Datenbeschriftungskategorie sichtbar ist.
showCategoryName: boolean;Eigenschaftswert
boolean
Hinweise
showLegendKey
Gibt an, ob der Legendenschlüssel der Datenbeschriftung sichtbar ist.
showLegendKey: boolean;Eigenschaftswert
boolean
Hinweise
showPercentage
Gibt an, ob der Prozentsatz der Datenbeschriftung sichtbar ist.
showPercentage: boolean;Eigenschaftswert
boolean
Hinweise
showSeriesName
Gibt an, ob der Name der Datenbeschriftungsserie sichtbar ist.
showSeriesName: boolean;Eigenschaftswert
boolean
Hinweise
showValue
Gibt an, ob der Wert der Datenbeschriftung sichtbar ist.
showValue: boolean;Eigenschaftswert
boolean
Hinweise
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.ChartDataLabelLoadOptions): Excel.ChartDataLabel;Parameter
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.ChartDataLabel;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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.ChartDataLabel;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.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.ChartDataLabelUpdateData
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.ChartDataLabel): void;Parameter
- properties
- Excel.ChartDataLabel
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.ChartDataLabel Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ChartDataLabelData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.ChartDataLabelData;