Partager via

Excel.ChartDataTable class

  • Référence
Paquet:
excel

Représente l’objet de table de données d’un graphique.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Propriétés

context

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

Représente le format d’une table de données de graphique, qui inclut le format de remplissage, de police et de bordure.
showHorizontalBorder

Spécifie s’il faut afficher la bordure horizontale de la table de données.
showLegendKey

Spécifie s’il faut afficher la clé de légende de la table de données.
showOutlineBorder

Spécifie s’il faut afficher la bordure hiérarchique de la table de données.
showVerticalBorder

Spécifie s’il faut afficher la bordure verticale de la table de données.
visible

Spécifie s’il faut afficher la table de données 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 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 passer un objet brut avec les propriétés appropriées ou 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 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.ChartDataTable est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ChartDataTableDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

context

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é

Excel.RequestContext

format

Représente le format d’une table de données de graphique, qui inclut le format de remplissage, de police et de bordure.

readonly format: Excel.ChartDataTableFormat;

Valeur de propriété

Excel.ChartDataTableFormat

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 adjusts the display and format of a chart data table 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 chart data table object and load its properties.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load();

  // Set the display properties of the chart data table.
  chartDataTable.showLegendKey = true;
  chartDataTable.showHorizontalBorder = false;
  chartDataTable.showVerticalBorder = true;
  chartDataTable.showOutlineBorder = true;

  // Retrieve the chart data table format object and set font and border properties. 
  const chartDataTableFormat = chartDataTable.format;
  chartDataTableFormat.font.color = "#B76E79";
  chartDataTableFormat.font.name = "Comic Sans";
  chartDataTableFormat.border.color = "blue";
  await context.sync();
});

showHorizontalBorder

Spécifie s’il faut afficher la bordure horizontale de la table de données.

showHorizontalBorder: boolean;

Valeur de propriété

boolean

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 adjusts the display and format of a chart data table 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 chart data table object and load its properties.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load();

  // Set the display properties of the chart data table.
  chartDataTable.showLegendKey = true;
  chartDataTable.showHorizontalBorder = false;
  chartDataTable.showVerticalBorder = true;
  chartDataTable.showOutlineBorder = true;

  // Retrieve the chart data table format object and set font and border properties. 
  const chartDataTableFormat = chartDataTable.format;
  chartDataTableFormat.font.color = "#B76E79";
  chartDataTableFormat.font.name = "Comic Sans";
  chartDataTableFormat.border.color = "blue";
  await context.sync();
});

showLegendKey

Spécifie s’il faut afficher la clé de légende de la table de données.

showLegendKey: boolean;

Valeur de propriété

boolean

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 adjusts the display and format of a chart data table 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 chart data table object and load its properties.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load();

  // Set the display properties of the chart data table.
  chartDataTable.showLegendKey = true;
  chartDataTable.showHorizontalBorder = false;
  chartDataTable.showVerticalBorder = true;
  chartDataTable.showOutlineBorder = true;

  // Retrieve the chart data table format object and set font and border properties. 
  const chartDataTableFormat = chartDataTable.format;
  chartDataTableFormat.font.color = "#B76E79";
  chartDataTableFormat.font.name = "Comic Sans";
  chartDataTableFormat.border.color = "blue";
  await context.sync();
});

showOutlineBorder

Spécifie s’il faut afficher la bordure hiérarchique de la table de données.

showOutlineBorder: boolean;

Valeur de propriété

boolean

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 adjusts the display and format of a chart data table 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 chart data table object and load its properties.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load();

  // Set the display properties of the chart data table.
  chartDataTable.showLegendKey = true;
  chartDataTable.showHorizontalBorder = false;
  chartDataTable.showVerticalBorder = true;
  chartDataTable.showOutlineBorder = true;

  // Retrieve the chart data table format object and set font and border properties. 
  const chartDataTableFormat = chartDataTable.format;
  chartDataTableFormat.font.color = "#B76E79";
  chartDataTableFormat.font.name = "Comic Sans";
  chartDataTableFormat.border.color = "blue";
  await context.sync();
});

showVerticalBorder

Spécifie s’il faut afficher la bordure verticale de la table de données.

showVerticalBorder: boolean;

Valeur de propriété

boolean

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 adjusts the display and format of a chart data table 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 chart data table object and load its properties.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load();

  // Set the display properties of the chart data table.
  chartDataTable.showLegendKey = true;
  chartDataTable.showHorizontalBorder = false;
  chartDataTable.showVerticalBorder = true;
  chartDataTable.showOutlineBorder = true;

  // Retrieve the chart data table format object and set font and border properties. 
  const chartDataTableFormat = chartDataTable.format;
  chartDataTableFormat.font.color = "#B76E79";
  chartDataTableFormat.font.name = "Comic Sans";
  chartDataTableFormat.border.color = "blue";
  await context.sync();
});

visible

Spécifie s’il faut afficher la table de données du graphique.

visible: boolean;

Valeur de propriété

boolean

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

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.ChartDataTableLoadOptions): Excel.ChartDataTable;

Paramètres

options
Excel.Interfaces.ChartDataTableLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.ChartDataTable

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.ChartDataTable;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.ChartDataTable

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.ChartDataTable;

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

Excel.ChartDataTable

set(properties, options)

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.ChartDataTableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.ChartDataTableUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.ChartDataTable): void;

Paramètres

properties
Excel.ChartDataTable

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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ChartDataTable est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ChartDataTableDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartDataTableData;

Retours

Excel.Interfaces.ChartDataTableData