Excel.ChartPoint class
Représente un point d’une série dans un graphique.
- Extends
Remarques
Utilisateur
Exemples
// 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();
});
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| data |
Renvoie l’étiquette de données d’un point du graphique. |
| format | Regroupe les propriétés de format d’un point d’un graphique. |
| has |
Indique si un point de données possède une étiquette de données. Non applicable pour les graphiques en surface. |
| marker |
Code de couleur HTML de la couleur d’arrière-plan du marqueur d’un point de données (par exemple, #FF0000 représente le rouge). |
| marker |
Représentation par code couleur HTML de la couleur de premier plan du marqueur d’un point de données (par exemple, #FF0000 représente le rouge). |
| marker |
Représente la taille de marqueur d’un point de données. La plage de tailles prise en charge est de 2 à 72. Cette méthode renvoie une erreur InvalidArgument si elle est définie avec une taille en dehors de la plage prise en charge. |
| marker |
Représente le style du marqueur du point de données de graphique. Pour |
| value | Renvoie la valeur d’un point du graphique. |
Méthodes
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
dataLabel
Renvoie l’étiquette de données d’un point du graphique.
readonly dataLabel: Excel.ChartDataLabel;Valeur de propriété
Remarques
format
Regroupe les propriétés de format d’un point d’un graphique.
readonly format: Excel.ChartPointFormat;Valeur de propriété
Remarques
hasDataLabel
Indique si un point de données possède une étiquette de données. Non applicable pour les graphiques en surface.
hasDataLabel: boolean;Valeur de propriété
boolean
Remarques
markerBackgroundColor
Code de couleur HTML de la couleur d’arrière-plan du marqueur d’un point de données (par exemple, #FF0000 représente le rouge).
markerBackgroundColor: string;Valeur de propriété
string
Remarques
markerForegroundColor
Représentation par code couleur HTML de la couleur de premier plan du marqueur d’un point de données (par exemple, #FF0000 représente le rouge).
markerForegroundColor: string;Valeur de propriété
string
Remarques
markerSize
Représente la taille de marqueur d’un point de données. La plage de tailles prise en charge est de 2 à 72. Cette méthode renvoie une erreur InvalidArgument si elle est définie avec une taille en dehors de la plage prise en charge.
markerSize: number;Valeur de propriété
number
Remarques
markerStyle
Représente le style du marqueur du point de données de graphique. Pour Excel.ChartMarkerStyle plus de détails.
markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";Valeur de propriété
Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"
Remarques
value
Renvoie la valeur d’un point du graphique.
readonly value: any;Valeur de propriété
any
Remarques
Détails de la méthode
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.ChartPoint;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartPoint;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.ChartPointUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.ChartPointUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Excel.ChartPoint): void;Paramètres
- properties
- Excel.ChartPoint
Retours
void
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ChartPoint est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartPointDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.ChartPointData;