Excel.ChartTrendline class

Paquet:

excel

Cet objet représente les attributs d’un objet de courbe de tendance de graphique.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Propriétés

backwardPeriod	Représente le nombre de points que la courbe de tendance étend en arrière.
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 la mise en forme de courbe de tendance de graphique.
forwardPeriod	Représente le nombre de points que la courbe de tendance étend en avant.
intercept	Représente la valeur intercept de la courbe de tendance. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs automatiques). La valeur renvoyée est toujours un nombre.
label	Représente l’étiquette d’une courbe de tendance de graphique.
movingAveragePeriod	Représente la période d’une courbe de tendance de graphique. Applicable uniquement aux courbes de tendance avec le type MovingAverage.
name	Représente le nom de la courbe de tendance. Peut être défini sur une valeur de chaîne, une valeur représente des null valeurs automatiques. La valeur renvoyée est toujours une chaîne.
polynomialOrder	Représente l’ordre d’une courbe de tendance de graphique. Applicable uniquement aux courbes de tendance avec le type Polynomial.
showEquation	Vrai si l’équation de la courbe de tendance est affichée sur le graphique.
showRSquared	True si la valeur r-carrée de la courbe de tendance est affichée sur le graphique.
type	Représente le type de courbe de tendance de graphique.

Méthodes

delete()	Supprime l’objet courbe de tendance.
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 Excel.ChartTrendline d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ChartTrendlineDataque ) 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é

backwardPeriod

Représente le nombre de points que la courbe de tendance étend en arrière.

backwardPeriod: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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 la mise en forme de courbe de tendance de graphique.

readonly format: Excel.ChartTrendlineFormat;

Valeur de propriété

Excel.ChartTrendlineFormat

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

forwardPeriod

Représente le nombre de points que la courbe de tendance étend en avant.

forwardPeriod: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

intercept

Représente la valeur intercept de la courbe de tendance. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs automatiques). La valeur renvoyée est toujours un nombre.

intercept: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

label

Représente l’étiquette d’une courbe de tendance de graphique.

readonly label: Excel.ChartTrendlineLabel;

Valeur de propriété

Excel.ChartTrendlineLabel

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

movingAveragePeriod

Représente la période d’une courbe de tendance de graphique. Applicable uniquement aux courbes de tendance avec le type MovingAverage.

movingAveragePeriod: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

name

Représente le nom de la courbe de tendance. Peut être défini sur une valeur de chaîne, une valeur représente des null valeurs automatiques. La valeur renvoyée est toujours une chaîne.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

polynomialOrder

Représente l’ordre d’une courbe de tendance de graphique. Applicable uniquement aux courbes de tendance avec le type Polynomial.

polynomialOrder: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

showEquation

Vrai si l’équation de la courbe de tendance est affichée sur le graphique.

showEquation: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

showRSquared

True si la valeur r-carrée de la courbe de tendance est affichée sur le graphique.

showRSquared: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

type

Représente le type de courbe de tendance de graphique.

type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power";

Valeur de propriété

Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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 trendline for series 1 and load its type property.  
    let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);
    trendline.load("type");

    await context.sync();

    console.log("The trendline type is:" + trendline.type);  
});

Détails de la méthode

delete()

Supprime l’objet courbe de tendance.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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.ChartTrendlineLoadOptions): Excel.ChartTrendline;

Paramètres

options

Excel.Interfaces.ChartTrendlineLoadOptions

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

Retours

Excel.ChartTrendline

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

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

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

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

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

Paramètres

properties

Excel.Interfaces.ChartTrendlineUpdateData

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

Paramètres

properties

Excel.ChartTrendline

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 Excel.ChartTrendline d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ChartTrendlineDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartTrendlineData;

Retours

Excel.Interfaces.ChartTrendlineData