Compartilhar via

Excel.ChartTrendline class

  • Referência
Pacote:
excel

Este objeto representa os atributos de um objeto de linha de tendência do gráfico.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

backwardPeriod

Representa o número de períodos que a linha de tendência se estende para trás.
context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
format

Representa a formatação de uma linha de tendência do gráfico.
forwardPeriod

Representa o número de períodos que a linha de tendência se estende para frente.
intercept

Representa o valor de intercepção da linha de tendência. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
label

Representa o rótulo de linha de tendência um gráfico.
movingAveragePeriod

Representa o período de uma linha de tendência do gráfico. Aplicável somente às linhas de tendência com o tipo MovingAverage.
name

Representa o nome da linha de tendência. Pode ser definido como um valor de cadeia de caracteres, um null valor representa valores automáticos. O valor retornado sempre é uma cadeia de caracteres.
polynomialOrder

Representa a ordem de uma linha de tendência do gráfico. Aplicável somente às linhas de tendência com o tipo Polynomial.
showEquation

Verdadeiro se a equação da linha de tendência for exibida no gráfico.
showRSquared

True se o valor r-squared para a linha de tendência for exibido no gráfico.
type

Representa o tipo da linha de tendência de um gráfico.

Métodos

delete()

Deleta o objeto Trendline.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.ChartTrendline original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartTrendlineData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

backwardPeriod

Representa o número de períodos que a linha de tendência se estende para trás.

backwardPeriod: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

format

Representa a formatação de uma linha de tendência do gráfico.

readonly format: Excel.ChartTrendlineFormat;

Valor da propriedade

Excel.ChartTrendlineFormat

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

forwardPeriod

Representa o número de períodos que a linha de tendência se estende para frente.

forwardPeriod: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

intercept

Representa o valor de intercepção da linha de tendência. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.

intercept: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

label

Representa o rótulo de linha de tendência um gráfico.

readonly label: Excel.ChartTrendlineLabel;

Valor da propriedade

Excel.ChartTrendlineLabel

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

movingAveragePeriod

Representa o período de uma linha de tendência do gráfico. Aplicável somente às linhas de tendência com o tipo MovingAverage.

movingAveragePeriod: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

name

Representa o nome da linha de tendência. Pode ser definido como um valor de cadeia de caracteres, um null valor representa valores automáticos. O valor retornado sempre é uma cadeia de caracteres.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

polynomialOrder

Representa a ordem de uma linha de tendência do gráfico. Aplicável somente às linhas de tendência com o tipo Polynomial.

polynomialOrder: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showEquation

Verdadeiro se a equação da linha de tendência for exibida no gráfico.

showEquation: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

showRSquared

True se o valor r-squared para a linha de tendência for exibido no gráfico.

showRSquared: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

type

Representa o tipo da linha de tendência de um gráfico.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

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

Detalhes do método

delete()

Deleta o objeto Trendline.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options
Excel.Interfaces.ChartTrendlineLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.ChartTrendline

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.ChartTrendline

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.ChartTrendline

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties
Excel.Interfaces.ChartTrendlineUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.ChartTrendline): void;

Parâmetros

properties
Excel.ChartTrendline

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.ChartTrendline original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartTrendlineData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartTrendlineData;

Retornos

Excel.Interfaces.ChartTrendlineData