Excel.PivotTableCollection class
Representa una colección de todas las tablas dinámicas que forman parte del libro o de la hoja de cálculo.
- Extends
Comentarios
Usada por
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| get |
Obtiene una tabla dinámica por nombre. |
| 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 |
| refresh |
Actualiza todas las tablas dinámicas de la colección. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.PivotTable[];Valor de propiedad
Detalles del método
getItem(name)
Obtiene una tabla dinámica por nombre.
getItem(name: string): Excel.PivotTable;Parámetros
- name
-
string
Nombre de la tabla dinámica que se va a recuperar.
Devoluciones
Comentarios
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml
// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
pivotTable.refresh();
await context.sync();
});
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.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection;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.PivotTableCollection;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
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.PivotTableCollection;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
refreshAll()
Actualiza todas las tablas dinámicas de la colección.
refreshAll(): void;Devoluciones
void
Comentarios
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PivotTableCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PivotTableCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Excel.Interfaces.PivotTableCollectionData;