Excel.Chart class
Représente un objet de graphique dans un classeur. Pour en savoir plus sur le modèle d’objet graphique, voir Utiliser des graphiques à l’aide de l’API JavaScript d’Excel.
- Extends
Remarques
Utilisateur
Propriétés
| axes | Représente les axes du graphique. |
| 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 |
Représente les étiquettes des données sur le graphique. |
| format | Regroupe les propriétés de format de la zone de graphique. |
| height | Spécifie la hauteur, en points, de l’objet graphique. |
| left | La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul. |
| legend | Représente la légende du graphique. |
| name | Spécifie le nom d’un objet graphique. |
| series | Représente une série ou une collection de séries dans le graphique. |
| title | Représente le titre du graphique indiqué et comprend le texte, la visibilité, la position et la mise en forme du titre. |
| top | Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (sur une feuille de calcul) ou le haut de la zone de graphique (sur un graphique). |
| width | Spécifie la largeur, en points, de l’objet graphique. |
| worksheet | Feuille de calcul contenant le graphique actuel. |
Méthodes
| delete() | Supprime l’objet de graphique. |
| get |
Affiche le graphique sous la forme d’une image codée en Base64 en mettant à l’échelle le graphique pour l’adapter aux dimensions spécifiées. Les proportions sont conservées dans le cadre du redimensionnement. |
| get |
Affiche le graphique sous la forme d’une image codée en Base64 en mettant à l’échelle le graphique pour l’adapter aux dimensions spécifiées. Les proportions sont conservées dans le cadre du redimensionnement. |
| 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. |
| set |
Redéfinit les données sources du graphique. |
| set |
Redéfinit les données sources du graphique. |
| set |
Positionne le graphique par rapport aux cellules dans la feuille de calcul. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
axes
Représente les axes du graphique.
readonly axes: Excel.ChartAxes;Valeur de propriété
Remarques
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é
dataLabels
Représente les étiquettes des données sur le graphique.
readonly dataLabels: Excel.ChartDataLabels;Valeur de propriété
Remarques
format
Regroupe les propriétés de format de la zone de graphique.
readonly format: Excel.ChartAreaFormat;Valeur de propriété
Remarques
height
Spécifie la hauteur, en points, de l’objet graphique.
height: number;Valeur de propriété
number
Remarques
left
La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul.
left: number;Valeur de propriété
number
Remarques
legend
Représente la légende du graphique.
readonly legend: Excel.ChartLegend;Valeur de propriété
Remarques
Exemples
// Set to show legend of Chart1 and make it on top of the chart.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.legend.visible = true;
chart.legend.position = "Top";
chart.legend.overlay = false;
await context.sync()
console.log("Legend Shown ");
});
name
Spécifie le nom d’un objet graphique.
name: string;Valeur de propriété
string
Remarques
Exemples
// Rename the chart to new name, resize the chart to 200 points in both height and weight.
// Move Chart1 to 100 points to the top and left.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.name = "New Name";
chart.top = 100;
chart.left = 100;
chart.height = 200;
chart.width = 200;
await context.sync();
});
series
Représente une série ou une collection de séries dans le graphique.
readonly series: Excel.ChartSeriesCollection;Valeur de propriété
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const chart: Excel.Chart = sheet.charts.getItemAt(0);
let rangeSelection = sheet.getRange("C2:C7");
let xRangeSelection = sheet.getRange("A1:A7");
// Add a series.
const newSeries: Excel.ChartSeries = chart.series.add("Qtr2");
newSeries.setValues(rangeSelection);
newSeries.setXAxisValues(xRangeSelection);
await context.sync();
});
title
Représente le titre du graphique indiqué et comprend le texte, la visibilité, la position et la mise en forme du titre.
readonly title: Excel.ChartTitle;Valeur de propriété
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const title = sheet.charts.getItemAt(0).title;
title.textOrientation = -45;
await context.sync();
});
top
Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (sur une feuille de calcul) ou le haut de la zone de graphique (sur un graphique).
top: number;Valeur de propriété
number
Remarques
width
Spécifie la largeur, en points, de l’objet graphique.
width: number;Valeur de propriété
number
Remarques
worksheet
Feuille de calcul contenant le graphique actuel.
readonly worksheet: Excel.Worksheet;Valeur de propriété
Remarques
Détails de la méthode
delete()
Supprime l’objet de graphique.
delete(): void;Retours
void
Remarques
Exemples
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.delete();
await context.sync();
});
getImage(width, height, fittingMode)
Affiche le graphique sous la forme d’une image codée en Base64 en mettant à l’échelle le graphique pour l’adapter aux dimensions spécifiées. Les proportions sont conservées dans le cadre du redimensionnement.
getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;Paramètres
- width
-
number
Facultatif. Largeur souhaitée de l’image produite.
- height
-
number
Facultatif. Hauteur souhaitée de l’image produite.
- fittingMode
- Excel.ImageFittingMode
Facultatif. Méthode utilisée pour mettre à l’échelle le graphique aux dimensions spécifiées (si la hauteur et la largeur sont définies).
Retours
OfficeExtension.ClientResult<string>
Remarques
Exemples
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const image = chart.getImage();
await context.sync();
});
getImage(width, height, fittingMode)
Affiche le graphique sous la forme d’une image codée en Base64 en mettant à l’échelle le graphique pour l’adapter aux dimensions spécifiées. Les proportions sont conservées dans le cadre du redimensionnement.
getImage(width?: number, height?: number, fittingMode?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;Paramètres
- width
-
number
Facultatif. Largeur souhaitée de l’image produite.
- height
-
number
Facultatif. Hauteur souhaitée de l’image produite.
- fittingMode
-
"Fit" | "FitAndCenter" | "Fill"
Facultatif. Méthode utilisée pour mettre à l’échelle le graphique aux dimensions spécifiées (si la hauteur et la largeur sont définies).
Retours
OfficeExtension.ClientResult<string>
Remarques
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.ChartLoadOptions): Excel.Chart;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.Chart;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
Exemples
// Get a chart named "Chart1".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.load('name');
await context.sync();
console.log(chart.name);
});
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.Chart;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.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.ChartUpdateData
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.Chart): void;Paramètres
- properties
- Excel.Chart
Retours
void
setData(sourceData, seriesBy)
Redéfinit les données sources du graphique.
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;Paramètres
- sourceData
- Excel.Range
Objet de plage correspondant aux données sources.
- seriesBy
- Excel.ChartSeriesBy
Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique. Il peut s’agir de l’une des options suivantes : Automatique (par défaut), Lignes et Colonnes. Pour Excel.ChartSeriesBy plus de détails.
Retours
void
Remarques
Exemples
// Set the sourceData to be the range at "A1:B4" and seriesBy to be "Columns".
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
const chart = sheet.charts.getItem("Chart1");
const sourceData = sheet.getRange("A1:B4");
chart.setData(sourceData, "Columns");
await context.sync();
});
setData(sourceData, seriesBy)
Redéfinit les données sources du graphique.
setData(sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): void;Paramètres
- sourceData
- Excel.Range
Objet de plage correspondant aux données sources.
- seriesBy
-
"Auto" | "Columns" | "Rows"
Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique. Il peut s’agir de l’une des options suivantes : Automatique (par défaut), Lignes et Colonnes. Pour Excel.ChartSeriesBy plus de détails.
Retours
void
Remarques
setPosition(startCell, endCell)
Positionne le graphique par rapport aux cellules dans la feuille de calcul.
setPosition(startCell: Range | string, endCell?: Range | string): void;Paramètres
- startCell
-
Excel.Range | string
Cellule de début. Il s’agit de l’emplacement où le graphique sera déplacé. La cellule de début est la cellule supérieure gauche ou supérieure droite, selon les paramètres d’affichage droite-gauche définis par l’utilisateur.
- endCell
-
Excel.Range | string
Facultatif. Cellule de fin. Si une valeur est indiquée, la largeur et la hauteur du graphique seront définies de manière à couvrir entièrement cette cellule/plage.
Retours
void
Remarques
Exemples
await Excel.run(async (context) => {
const sheetName = "Charts";
const rangeSelection = "A1:B4";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeSelection);
const sourceData = sheetName + "!" + "A1:B4";
const chart = context.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto");
chart.width = 500;
chart.height = 300;
chart.setPosition("C2", null);
await context.sync();
});
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.Chart est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.ChartData;