Excel.ChartSeriesCollection class

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Devuelve el número de series incluidas en la colección.

readonly count: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.ChartSeries[];

Valor de propiedad

Agrega una nueva serie a la colección. La nueva serie agregada no es visible hasta que se establecen valores, valores del eje X o tamaños de burbuja para ella (según el tipo de gráfico).

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Devuelve el número de series incluidas en la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Recupera una serie basada en su posición en la colección.

getItemAt(index: number): Excel.ChartSeries;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ChartSeriesCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartSeriesCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.ChartSeriesCollectionData;

Devoluciones