Excel.ChartTrendlineFormat class

Représente les propriétés de format de la courbe de tendance du graphique.

[Ensemble d’API : ExcelApi 1.7]

Extends

Propriétés

context

Contexte de demande associé à l’objet. Cela connecte le processus du add-in au processus de l’application hôte Office.

line

Représente le format des lignes du graphique.

[Ensemble d’API : ExcelApi 1.7]

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 un objet simple avec les propriétés appropriées ou un autre objet API du même type.

set(properties)

Définit plusieurs propriétés de l’objet en même temps, en fonction d’un objet chargé existant.

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que l’objet Excel.ChartTrendlineFormat d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.ChartTrendlineFormatData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de demande associé à l’objet. Cela connecte le processus du add-in au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

line

Représente le format des lignes du graphique.

[Ensemble d’API : ExcelApi 1.7]

readonly line: Excel.ChartLineFormat;

Valeur de propriété

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let seriesCollection = sheet.charts.getItemAt(0).series; 

    // Get the color of the chart trendline. 
    let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);
    let line = trendline.format.line;
    line.load("color");

    await context.sync();

    console.log("The trendline color is:" + line.color);
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let seriesCollection = sheet.charts.getItemAt(0).series; 
    let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);

    // Set format of the trendline to a solid, red line.
    let line = trendline.format.line;
    line.color = '#FF0000';

    await context.sync();

    console.log("The trendline color has been set to:" + line.color);
});

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.ChartTrendlineFormatLoadOptions): Excel.ChartTrendlineFormat;

Paramètres

options
Excel.Interfaces.ChartTrendlineFormatLoadOptions

Fournit des options pour lesquelles 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.ChartTrendlineFormat;

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

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 est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

set(properties, options)

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

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

Paramètres

properties
Excel.Interfaces.ChartTrendlineFormatUpdateData

Objet JavaScript avec des propriétés structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option pour supprimer les erreurs si l’objet propriétés tente de définir des propriétés en lecture seule.

Retours

void

Remarques

Cette méthode possède la signature supplémentaire suivante :

set(properties: Excel.ChartTrendlineFormat): void

set(properties)

Définit plusieurs propriétés de l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.ChartTrendlineFormat): void;

Paramètres

Retours

void

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que l’objet Excel.ChartTrendlineFormat d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.ChartTrendlineFormatData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartTrendlineFormatData;

Retours