Excel.ChartSeriesCollection class

Pacote:

excel

Representa uma coleção de série do gráfico.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
count	Retorna o número de série da coleção.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(name, index)	Adiciona uma nova série para o conjunto. A nova série adicionada não fica visível até que valores, valores de eixo x ou tamanhos de bolha para ela sejam definidos (dependendo do tipo de gráfico).
getCount()	Retorna o número de série da coleção.
getItemAt(index)	Recupera uma série com base na respectiva posição na coleção.
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.
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.) Considerando que o objeto original Excel.ChartSeriesCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartSeriesCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Detalhes da propriedade

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

count

Retorna o número de série da coleção.

readonly count: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.ChartSeries[];

Valor da propriedade

Excel.ChartSeries[]

Detalhes do método

add(name, index)

Adiciona uma nova série para o conjunto. A nova série adicionada não fica visível até que valores, valores de eixo x ou tamanhos de bolha para ela sejam definidos (dependendo do tipo de gráfico).

add(name?: string, index?: number): Excel.ChartSeries;

Parâmetros

name

string

Opcional. Nome da série.

index

number

Opcional. Valor de índice da série a ser adicionada. Indexados com zero.

Retornos

Excel.ChartSeries

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

getCount()

Retorna o número de série da coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

getItemAt(index)

Recupera uma série com base na respectiva posição na coleção.

getItemAt(index: number): Excel.ChartSeries;

Parâmetros

index

number

Valor de índice do objeto a ser recuperado. Indexados com zero.

Retornos

Excel.ChartSeries

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

// Get the name of the first series in the series collection.
await Excel.run(async (context) => { 
    const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('items');
    await context.sync();
    
    console.log(seriesCollection.items[0].name);
});

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.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection;

Parâmetros

options

Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retornos

Excel.ChartSeriesCollection

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

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

Exemplos

// Get the number of chart series in the collection.
await Excel.run(async (context) => { 
    const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('count');
    await context.sync();

    console.log("series: Count= " + seriesCollection.count);
});

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

Parâmetros

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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.) Considerando que o objeto original Excel.ChartSeriesCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartSeriesCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.ChartSeriesCollectionData;

Retornos

Excel.Interfaces.ChartSeriesCollectionData