Excel.ChartTrendlineCollection class
Representa uma coleção de linhas de tendência de gráficos.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(type) | Adiciona uma nova linha de tendência ao conjunto de linha de tendência. |
| add(type |
Adiciona uma nova linha de tendência ao conjunto de linha de tendência. |
| get |
Retorna o número de linha de tendência na coleção. |
| get |
Obtém um objeto de linha de tendência por índice, que é a ordem de inserção na matriz de itens. |
| 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 |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.ChartTrendline[];Valor da propriedade
Detalhes do método
add(type)
Adiciona uma nova linha de tendência ao conjunto de linha de tendência.
add(type?: Excel.ChartTrendlineType): Excel.ChartTrendline;Parâmetros
Especifica o tipo de linha de tendência. O valor predefinido é "Linear". Veja Excel.ChartTrendline para obter detalhes.
Retornos
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;
// Add a trendline.
seriesCollection.getItemAt(0).trendlines.add("Linear");
await context.sync();
});
add(typeString)
Adiciona uma nova linha de tendência ao conjunto de linha de tendência.
add(typeString?: "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"): Excel.ChartTrendline;Parâmetros
- typeString
-
"Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"
Especifica o tipo de linha de tendência. O valor predefinido é "Linear". Veja Excel.ChartTrendline para obter detalhes.
Retornos
Comentários
getCount()
Retorna o número de linha de tendência na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(index)
Obtém um objeto de linha de tendência por índice, que é a ordem de inserção na matriz de itens.
getItem(index: number): Excel.ChartTrendline;Parâmetros
- index
-
number
Representa a ordem de inserção na matriz de itens.
Retornos
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.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection;Parâmetros
- options
-
Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.ChartTrendlineCollection;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?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.ChartTrendlineCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartTrendlineCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.ChartTrendlineCollectionData;