Excel.ChartLeaderLines class

Paquet:: excel

Obtient un objet qui représente la mise en forme des lignes d’extrémité du graphique.

Extends: OfficeExtension.ClientObject

Remarques

Utilisateur

Excel.ChartDataLabels : leaderLines

Exemples

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

// The following code changes the format of leader lines. It adjusts color, weight, and line style.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  const dataLabels = series.dataLabels;
  const lineFormat = dataLabels.leaderLines.format;

  // Set leader line formatting properties.
  lineFormat.line.color = "blue";
  lineFormat.line.weight = 2;
  lineFormat.line.lineStyle = Excel.ChartLineStyle.dot;

  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.
format	Représente la mise en forme des lignes de repère des étiquettes de données dans une série.

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 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 `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.ChartLeaderLines` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Excel.Interfaces.ChartLeaderLinesData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

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é

Excel.RequestContext

format

Représente la mise en forme des lignes de repère des étiquettes de données dans une série.

readonly format: Excel.ChartLeaderLinesFormat;

Valeur de propriété

Excel.ChartLeaderLinesFormat

Remarques

Jeu d’API : ExcelApi 1.19

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.ChartLeaderLinesLoadOptions): Excel.ChartLeaderLines;

Paramètres

options: Excel.Interfaces.ChartLeaderLinesLoadOptions

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

Retours

Excel.ChartLeaderLines

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

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

Excel.ChartLeaderLines

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

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

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

Paramètres

properties: Excel.Interfaces.ChartLeaderLinesUpdateData

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.ChartLeaderLines): void;

Paramètres

properties: Excel.ChartLeaderLines

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.ChartLeaderLines est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartLeaderLinesDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartLeaderLinesData;

Retours

Excel.Interfaces.ChartLeaderLinesData

Commentaires

Cette page a-t-elle été utile ?