Excel.ChartTrendline class

Dieses Objekt stellt die Attribute für ein Diagrammtrendlinienobjekt dar.

Extends

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Eigenschaften

backwardPeriod

Die Anzahl der Punkte, über die sich eine Trendlinie zurück erstreckt.

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

format

Stellt die Formatierung der Diagrammtrendlinie dar.

forwardPeriod

Die Anzahl der Punkte, über die sich eine Trendlinie vorwärts erstreckt.

intercept

Stellt den Wert der y-Schnittpunkt der Trendlinie dar. Kann auf einen numerischen Wert oder eine leere Zeichenfolge festgelegt werden (für automatische Werte). Der zurückgegebene Wert ist immer eine Zahl.

label

Die Beschriftung einer Diagrammtrendlinie.

movingAveragePeriod

Stellt den Zeitraum einer Diagrammtrendlinie dar. Gilt nur für Trendlinien mit dem Typ MovingAverage.

name

Gibt den Namen der Trendlinie zurück. Kann auf einen Zeichenfolgenwert festgelegt werden, ein null Wert stellt automatische Werte dar. Der zurückgegebene Wert ist immer eine Zeichenfolge.

polynomialOrder

Stellt die Reihenfolge einer Diagrammtrendlinie dar. Gilt nur für Trendlinien mit dem Typ Polynomial.

showEquation

True, wenn die Formel für die Trendlinie im Diagramm angezeigt wird.

showRSquared

True, wenn der r-Quadratwert für die Trendlinie im Diagramm angezeigt wird.

type

Stellt die Beschriftung einer Diagrammtrendlinie dar.

Methoden

delete()

Löschen des Trendline-Objekts.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.ChartTrendline Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartTrendlineData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

backwardPeriod

Die Anzahl der Punkte, über die sich eine Trendlinie zurück erstreckt.

backwardPeriod: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.8 ]

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

format

Stellt die Formatierung der Diagrammtrendlinie dar.

readonly format: Excel.ChartTrendlineFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

forwardPeriod

Die Anzahl der Punkte, über die sich eine Trendlinie vorwärts erstreckt.

forwardPeriod: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.8 ]

intercept

Stellt den Wert der y-Schnittpunkt der Trendlinie dar. Kann auf einen numerischen Wert oder eine leere Zeichenfolge festgelegt werden (für automatische Werte). Der zurückgegebene Wert ist immer eine Zahl.

intercept: any;

Eigenschaftswert

any

Hinweise

[ API-Satz: ExcelApi 1.7 ]

label

Die Beschriftung einer Diagrammtrendlinie.

readonly label: Excel.ChartTrendlineLabel;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

movingAveragePeriod

Stellt den Zeitraum einer Diagrammtrendlinie dar. Gilt nur für Trendlinien mit dem Typ MovingAverage.

movingAveragePeriod: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.7 ]

name

Gibt den Namen der Trendlinie zurück. Kann auf einen Zeichenfolgenwert festgelegt werden, ein null Wert stellt automatische Werte dar. Der zurückgegebene Wert ist immer eine Zeichenfolge.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

polynomialOrder

Stellt die Reihenfolge einer Diagrammtrendlinie dar. Gilt nur für Trendlinien mit dem Typ Polynomial.

polynomialOrder: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.7 ]

showEquation

True, wenn die Formel für die Trendlinie im Diagramm angezeigt wird.

showEquation: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

showRSquared

True, wenn der r-Quadratwert für die Trendlinie im Diagramm angezeigt wird.

showRSquared: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

type

Stellt die Beschriftung einer Diagrammtrendlinie dar.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Beispiele

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

Details zur Methode

delete()

Löschen des Trendline-Objekts.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.7 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline;

Parameter

options
Excel.Interfaces.ChartTrendlineLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.ChartTrendline;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartTrendline;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

properties
Excel.Interfaces.ChartTrendlineUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.ChartTrendline): void;

Parameter

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.ChartTrendline Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartTrendlineData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.ChartTrendlineData;

Gibt zurück