Excel.ChartPoint class
Stellt einen Punkt einer Datenreihe in einem Diagramm 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 adds data labels to specific chart points
// and sets their text and position.
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.points.load("dataLabel");
await context.sync();
// Define properties for data label positioning and shape.
const labelProperties = [
{
top: 70,
geometricShapeType: Excel.GeometricShapeType.rectangle
},
{
top: 200,
geometricShapeType: Excel.GeometricShapeType.rectangle
}
];
// Add data labels to specific chart points and set their text and properties.
for (let i = 0; i < dataLabelInfo.length; i++) {
const point = series.points.getItemAt(dataLabelInfo[i].index);
point.hasDataLabel = true;
const dataLabel = point.dataLabel;
dataLabel.text = dataLabelInfo[i].news;
dataLabel.set(labelProperties[i]);
}
await context.sync();
});
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| data |
Gibt die Datenbeschriftung eines Diagrammpunkts zurück. |
| format | Kapselt die Formateigenschaften eines Diagrammpunkts. |
| has |
Gibt an, ob ein Datenpunkt über eine Datenbeschriftung verfügt. Gilt nicht für Oberflächendiagramme. |
| marker |
HTML-Farbcodedarstellung der Marker-Hintergrundfarbe eines Datenpunktes (z. B. #FF0000 steht für Rot). |
| marker |
HTML-Farbcodedarstellung der Marker-Vordergrundfarbe eines Datenpunktes (z. B. #FF0000 steht für Rot). |
| marker |
Stellt die Markergröße eines Datenpunktes dar. Der unterstützte Größenbereich liegt zwischen 2 und 72. Diese Methode gibt einen InvalidArgument-Fehler zurück, wenn sie mit einer Größe außerhalb des unterstützten Bereichs festgelegt ist. |
| marker |
Stellt den Markerstil eines Diagrammdatenpunkts dar. Weitere Informationen findest du hier |
| value | Gibt den Wert eines Diagrammpunkts zurück. |
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
dataLabel
Gibt die Datenbeschriftung eines Diagrammpunkts zurück.
readonly dataLabel: Excel.ChartDataLabel;Eigenschaftswert
Hinweise
format
Kapselt die Formateigenschaften eines Diagrammpunkts.
readonly format: Excel.ChartPointFormat;Eigenschaftswert
Hinweise
hasDataLabel
Gibt an, ob ein Datenpunkt über eine Datenbeschriftung verfügt. Gilt nicht für Oberflächendiagramme.
hasDataLabel: boolean;Eigenschaftswert
boolean
Hinweise
markerBackgroundColor
HTML-Farbcodedarstellung der Marker-Hintergrundfarbe eines Datenpunktes (z. B. #FF0000 steht für Rot).
markerBackgroundColor: string;Eigenschaftswert
string
Hinweise
markerForegroundColor
HTML-Farbcodedarstellung der Marker-Vordergrundfarbe eines Datenpunktes (z. B. #FF0000 steht für Rot).
markerForegroundColor: string;Eigenschaftswert
string
Hinweise
markerSize
Stellt die Markergröße eines Datenpunktes dar. Der unterstützte Größenbereich liegt zwischen 2 und 72. Diese Methode gibt einen InvalidArgument-Fehler zurück, wenn sie mit einer Größe außerhalb des unterstützten Bereichs festgelegt ist.
markerSize: number;Eigenschaftswert
number
Hinweise
markerStyle
Stellt den Markerstil eines Diagrammdatenpunkts dar. Weitere Informationen findest du hier Excel.ChartMarkerStyle .
markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";Eigenschaftswert
Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"
Hinweise
value
Gibt den Wert eines Diagrammpunkts zurück.
readonly value: any;Eigenschaftswert
any
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.ChartPointLoadOptions): Excel.ChartPoint;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.ChartPoint;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.ChartPoint;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.ChartPointUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.ChartPointUpdateData
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.ChartPoint): void;Parameter
- properties
- Excel.ChartPoint
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.ChartPoint Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ChartPointData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.ChartPointData;