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

[Jeu d’API : ExcelApi 1.1]

Propriétés

axes

Représente les axes du graphique.

categoryLabelLevel

Spécifie une constante d’énumération de niveau d’étiquette de catégorie de graphique, faisant référence au niveau des étiquettes de catégorie source.

chartType

Spécifie le type du graphique. Pour Excel.ChartType plus de détails.

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

dataLabels

Représente les étiquettes des données sur le graphique.

displayBlanksAs

Spécifie la manière dont les cellules vides sont tracées sur un 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.

id

L’ID unique du 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.

pivotOptions

Encapsule les options pour le graphique croisé dynamique.

plotArea

Représente la zone de traçage du graphique.

plotBy

Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique.

plotVisibleOnly

Vrai si seules les cellules visibles sont tracées. Faux si les deux cellules visibles et masquées sont tracées.

series

Représente une série ou une collection de séries dans le graphique.

seriesNameLevel

Spécifie une constante d’énumération de niveau de nom de série de graphiques, faisant référence au niveau des noms de série source.

showAllFieldButtons

Indique si tous les boutons de champ doivent être affichés dans un graphique croisé dynamique.

showDataLabelsOverMaximum

Indique si les étiquettes de données doivent être affichées lorsque la valeur est supérieure à la valeur maximale sur l’axe des valeurs. Si l’axe des valeurs devient plus petit que la taille des points de données, vous pouvez utiliser cette propriété pour définir si les étiquettes de données doivent être affichées. Cette propriété s'applique uniquement aux graphiques 2D.

style

Spécifie le style de graphique du 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

activate()

Active le graphique dans l’interface utilisateur Excel.

delete()

Supprime l’objet de graphique.

getDataTable()

Obtient la table de données sur le graphique. Si le graphique n’autorise pas une table de données, il lève une exception.

getDataTableOrNullObject()

Obtient la table de données sur le graphique. Si le graphique n’autorise pas une table de données, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

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, 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.

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(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(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.

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.

setData(sourceData, seriesBy)

Redéfinit les données sources du graphique.

setData(sourceData, seriesBy)

Redéfinit les données sources du graphique.

setPosition(startCell, endCell)

Positionne le graphique par rapport aux cellules dans la feuille de calcul.

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.

Événements

onActivated

Se produit lorsque le graphique est activé.

onDeactivated

Se produit lorsque le graphique est désactivé.

Détails de la propriété

axes

Représente les axes du graphique.

readonly axes: Excel.ChartAxes;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1]

categoryLabelLevel

Spécifie une constante d’énumération de niveau d’étiquette de catégorie de graphique, faisant référence au niveau des étiquettes de catégorie source.

categoryLabelLevel: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.8]

chartType

Spécifie le type du graphique. Pour Excel.ChartType plus de détails.

chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";

Valeur de propriété

Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"

Remarques

[Jeu d’API : ExcelApi 1.7]

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

[Jeu d’API : ExcelApi 1.1]

displayBlanksAs

Spécifie la manière dont les cellules vides sont tracées sur un graphique.

displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";

Valeur de propriété

Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

Remarques

[Jeu d’API : ExcelApi 1.8]

format

Regroupe les propriétés de format de la zone de graphique.

readonly format: Excel.ChartAreaFormat;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1]

height

Spécifie la hauteur, en points, de l’objet graphique.

height: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.1]

id

L’ID unique du graphique.

readonly id: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.7]

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

[Jeu d’API : ExcelApi 1.1]

legend

Représente la légende du graphique.

readonly legend: Excel.ChartLegend;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1]

name

Spécifie le nom d’un objet graphique.

name: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.1]

pivotOptions

Encapsule les options pour le graphique croisé dynamique.

readonly pivotOptions: Excel.ChartPivotOptions;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.9]

plotArea

Représente la zone de traçage du graphique.

readonly plotArea: Excel.ChartPlotArea;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.8]

plotBy

Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique.

plotBy: Excel.ChartPlotBy | "Rows" | "Columns";

Valeur de propriété

Excel.ChartPlotBy | "Rows" | "Columns"

Remarques

[Jeu d’API : ExcelApi 1.8]

plotVisibleOnly

Vrai si seules les cellules visibles sont tracées. Faux si les deux cellules visibles et masquées sont tracées.

plotVisibleOnly: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.8]

series

Représente une série ou une collection de séries dans le graphique.

readonly series: Excel.ChartSeriesCollection;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1]

seriesNameLevel

Spécifie une constante d’énumération de niveau de nom de série de graphiques, faisant référence au niveau des noms de série source.

seriesNameLevel: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.8]

showAllFieldButtons

Indique si tous les boutons de champ doivent être affichés dans un graphique croisé dynamique.

showAllFieldButtons: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.7]

showDataLabelsOverMaximum

Indique si les étiquettes de données doivent être affichées lorsque la valeur est supérieure à la valeur maximale sur l’axe des valeurs. Si l’axe des valeurs devient plus petit que la taille des points de données, vous pouvez utiliser cette propriété pour définir si les étiquettes de données doivent être affichées. Cette propriété s'applique uniquement aux graphiques 2D.

showDataLabelsOverMaximum: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.8]

style

Spécifie le style de graphique du graphique.

style: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.8]

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

[Jeu d’API : ExcelApi 1.1]

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

[Jeu d’API : ExcelApi 1.1]

width

Spécifie la largeur, en points, de l’objet graphique.

width: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.1]

worksheet

Feuille de calcul contenant le graphique actuel.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.2]

Détails de la méthode

activate()

Active le graphique dans l’interface utilisateur Excel.

activate(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

delete()

Supprime l’objet de graphique.

delete(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.1]

getDataTable()

Obtient la table de données sur le graphique. Si le graphique n’autorise pas une table de données, il lève une exception.

getDataTable(): Excel.ChartDataTable;

Retours

Remarques

[Jeu d’API : ExcelApi 1.14]

getDataTableOrNullObject()

Obtient la table de données sur le graphique. Si le graphique n’autorise pas une table de données, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getDataTableOrNullObject(): Excel.ChartDataTable;

Retours

Remarques

[Jeu d’API : ExcelApi 1.14]

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

Remarques

[Jeu d’API : ExcelApi 1.2]

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

Remarques

[Jeu d’API : ExcelApi 1.2]

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

options
Excel.Interfaces.ChartLoadOptions

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

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

[Jeu d’API : ExcelApi 1.1]

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

[Jeu d’API : ExcelApi 1.1]

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

[Jeu d’API : ExcelApi 1.1]

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;

Retours

Détails de l’événement

onActivated

Se produit lorsque le graphique est activé.

readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;

Type d’événement

Remarques

[Jeu d’API : ExcelApi 1.8]

onDeactivated

Se produit lorsque le graphique est désactivé.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;

Type d’événement

Remarques

[Jeu d’API : ExcelApi 1.8]