Excel.ChartTrendline class
Este objeto representa os atributos de um objeto de linha de tendência de gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Propriedades
| backward |
Representa o número de períodos que a linha de tendência se estende para trás. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| format | Representa a formatação de uma linha de tendência do gráfico. |
| forward |
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. |
| moving |
Representa o período de uma linha de tendência do gráfico. Aplicável apenas às linhas de tendência com o tipo |
| name | Representa o nome da linha de tendência. Pode ser definido como um valor de cadeia, um |
| polynomial |
Representa a ordem de uma linha de tendência do gráfico. Aplicável apenas às linhas de tendência com o tipo |
| show |
Verdadeiro se a equação da linha de tendência for exibida no gráfico. |
| show |
Verdadeiro se o valor r-quadrado da linha de tendência for apresentado 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 |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
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
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
format
Representa a formatação de uma linha de tendência do gráfico.
readonly format: Excel.ChartTrendlineFormat;Valor da propriedade
Comentários
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
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
label
Representa o rótulo de linha de tendência um gráfico.
readonly label: Excel.ChartTrendlineLabel;Valor da propriedade
Comentários
movingAveragePeriod
Representa o período de uma linha de tendência do gráfico. Aplicável apenas às linhas de tendência com o tipo MovingAverage.
movingAveragePeriod: number;Valor da propriedade
number
Comentários
name
Representa o nome da linha de tendência. Pode ser definido como um valor de cadeia, um null valor representa valores automáticos. O valor retornado sempre é uma cadeia de caracteres.
name: string;Valor da propriedade
string
Comentários
polynomialOrder
Representa a ordem de uma linha de tendência do gráfico. Aplicável apenas às linhas de tendência com o tipo Polynomial.
polynomialOrder: number;Valor da propriedade
number
Comentários
showEquation
Verdadeiro se a equação da linha de tendência for exibida no gráfico.
showEquation: boolean;Valor da propriedade
boolean
Comentários
showRSquared
Verdadeiro se o valor r-quadrado da linha de tendência for apresentado no gráfico.
showRSquared: boolean;Valor da propriedade
boolean
Comentários
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
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
Fornece opções para as propriedades do objeto a carregar.
Retornos
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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.ChartTrendline é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartTrendlineData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartTrendlineData;