Excel.Chart class

Représente les axes du graphique.

readonly axes: Excel.ChartAxes;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie le type du graphique. Pour plus d’informations, consultez Excel.ChartType .

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é

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

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

readonly dataLabels: Excel.ChartDataLabels;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie la façon dont les cellules vides sont tracées sur un graphique.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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

readonly format: Excel.ChartAreaFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

height: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

L’ID unique du graphique.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Représente la légende du graphique.

readonly legend: Excel.ChartLegend;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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 ");
});

Spécifie le nom d’un objet graphique.

name: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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(); 
});

Encapsule les options pour le graphique croisé dynamique.

readonly pivotOptions: Excel.ChartPivotOptions;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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

readonly plotArea: Excel.ChartPlotArea;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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

readonly series: Excel.ChartSeriesCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

seriesNameLevel: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie s’il faut afficher tous les boutons de champ sur un graphique croisé dynamique.

showAllFieldButtons: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie s’il faut afficher les étiquettes de donné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 s’il faut afficher les étiquettes de données. Cette propriété s'applique uniquement aux graphiques 2D.

showDataLabelsOverMaximum: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie le style de graphique pour le graphique.

style: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (dans une feuille de calcul) ou le haut de la zone de graphique (sur un graphique).

top: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

width: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Feuille de calcul contenant le graphique actuel.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Active le graphique dans l’interface utilisateur Excel.

activate(): void;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Supprime l’objet de graphique.

delete(): void;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.delete();
    await context.sync(); 
});

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

[ Ensemble d’API : ExcelApi 1.14 ]

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

getDataTableOrNullObject(): Excel.ChartDataTable;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml

// This function adds a data table to a chart that already exists on the worksheet. 
await Excel.run(async (context) => {
  // Retrieve the chart named "SalesChart" from the "Sample" worksheet.
  const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart");

  // Get the data table object for the chart and set it to visible.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load("visible");
  chartDataTable.visible = true;
  await context.sync();
});

Restitue le graphique sous la forme d’une image encodée en Base64 en le mettant à l’échelle pour qu’il s’adapte 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

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Exemples

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const image = chart.getImage();
    await context.sync(); 
});

Restitue le graphique sous la forme d’une image encodée en Base64 en le mettant à l’échelle pour qu’il s’adapte aux dimensions spécifiées. Les proportions sont conservées dans le cadre du redimensionnement.

getImage(width?: number, height?: number, fittingModeString?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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

Retours

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

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);
});

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

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

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

Retours

Redéfinit les données sources du graphique.

setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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();
});

Redéfinit les données sources du graphique.

setData(sourceData: Range, seriesByString?: "Auto" | "Columns" | "Rows"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

setPosition(startCell: Range | string, endCell?: Range | string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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(); 
});

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.ChartDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartData;

Retours

Se produit lorsque le graphique est activé.

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

Type d'événement

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartActivated(event) {
    await Excel.run(async (context) => {
        // Retrieve the worksheet.
        const sheet = context.workbook.worksheets.getActiveWorksheet();

        // Retrieve the activated chart by ID and load the name of the chart. 
        const activatedChart = sheet.charts.getItem(event.chartId);
        activatedChart.load(["name"]);
        await context.sync();

        // Print out the activated chart's data.
        console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`);
    });
}

Se produit lorsque le graphique est désactivé.

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

Type d'événement

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartDeactivated(event) {
    await Excel.run(async (context) => {
        // Callback function for when the chart is deactivated.
        console.log("The pie chart is NOT active.");
    });
}