Excel.ChartSeriesCollection class
Representa una colección de series del gráfico.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| count | Devuelve el número de series incluidas en la colección. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(name, index) | 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). |
| get |
Devuelve el número de series incluidas en la colección. |
| get |
Recupera una serie basada en su posición en la colección. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
context
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
count
Devuelve el número de series incluidas en la colección.
readonly count: number;Valor de propiedad
number
Comentarios
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.ChartSeries[];Valor de propiedad
Detalles del método
add(name, index)
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
- name
-
string
Opcional. Nombre de la serie.
- index
-
number
Opcional. Valor de índice de la serie que se va a agregar. Indizado con cero.
Devoluciones
Comentarios
getCount()
Devuelve el número de series incluidas en la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItemAt(index)
Recupera una serie basada en su posición en la colección.
getItemAt(index: number): Excel.ChartSeries;Parámetros
- index
-
number
Valor de índice del objeto que se va a recuperar. Indizado con cero.
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);
});
load(options)
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
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
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
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
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);
});
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
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;