Excel.PivotTable class
Representa una tabla dinámica de Excel. Para obtener más información sobre el modelo de objetos de tabla dinámica, lea Trabajo con tablas dinámicas mediante la API de JavaScript de Excel.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.3 ]
Propiedades
| allow |
Especifica si la tabla dinámica permite la aplicación de varios pivotfilters en un campo dinámico determinado de la tabla. |
| column |
Las jerarquías dinámicas de columna de la tabla dinámica. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| data |
Las jerarquías dinámicas de datos de la tabla dinámica. |
| enable |
Especifica si la tabla dinámica permite que el usuario edite los valores del cuerpo de datos. |
| filter |
Las jerarquías dinámicas de filtro de la tabla dinámica. |
| hierarchies | Las jerarquías dinámicas de la tabla dinámica. |
| id | Identificador de la tabla dinámica. |
| layout | El PivotLayout que describe el diseño y la estructura visual de la tabla dinámica. |
| name | Nombre la tabla dinámica. |
| refresh |
Especifica si la tabla dinámica se actualiza cuando se abre el libro. Corresponde a la configuración "Actualizar al cargar" en la interfaz de usuario. |
| row |
Las jerarquías dinámicas de fila de la tabla dinámica. |
| use |
Especifica si la tabla dinámica usa listas personalizadas al ordenar. |
| worksheet | La hoja de cálculo que contiene la tabla dinámica actual. |
Métodos
| delete() | Elimina la tabla dinámica. |
| 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 la tabla dinámica. |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
allowMultipleFiltersPerField
Especifica si la tabla dinámica permite la aplicación de varios pivotfilters en un campo dinámico determinado de la tabla.
allowMultipleFiltersPerField: boolean;Valor de propiedad
boolean
Comentarios
columnHierarchies
Las jerarquías dinámicas de columna de la tabla dinámica.
readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;Valor de propiedad
Comentarios
[ Conjunto de API: ExcelApi 1.8 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
// Check if the PivotTable already has a column.
const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
column.load("id");
await context.sync();
if (column.isNullObject) {
// Adding the farm column to the column hierarchy automatically removes it from the row hierarchy.
pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
} else {
pivotTable.columnHierarchies.remove(column);
}
await context.sync();
});
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
dataHierarchies
Las jerarquías dinámicas de datos de la tabla dinámica.
readonly dataHierarchies: Excel.DataPivotHierarchyCollection;Valor de propiedad
Comentarios
[ Conjunto de API: ExcelApi 1.8 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));
await context.sync();
});
enableDataValueEditing
Especifica si la tabla dinámica permite que el usuario edite los valores del cuerpo de datos.
enableDataValueEditing: boolean;Valor de propiedad
boolean
Comentarios
filterHierarchies
Las jerarquías dinámicas de filtro de la tabla dinámica.
readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;Valor de propiedad
Comentarios
[ Conjunto de API: ExcelApi 1.8 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml
async function filter(functionType: Excel.AggregationFunction) {
await Excel.run(async (context) => {
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
const filters = pivotTable.filterHierarchies;
const filter = filters.getItemOrNullObject("Classification");
filter.load();
await context.sync();
// Add the Classification hierarchy to the filter, if it's not already there.
if (filter.isNullObject) {
filters.add(pivotTable.hierarchies.getItem("Classification"));
await context.sync();
}
});
}
hierarchies
Las jerarquías dinámicas de la tabla dinámica.
readonly hierarchies: Excel.PivotHierarchyCollection;Valor de propiedad
Comentarios
id
Identificador de la tabla dinámica.
readonly id: string;Valor de propiedad
string
Comentarios
layout
El PivotLayout que describe el diseño y la estructura visual de la tabla dinámica.
readonly layout: Excel.PivotLayout;Valor de propiedad
Comentarios
[ Conjunto de API: ExcelApi 1.8 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
pivotTable.layout.load("layoutType");
await context.sync();
// Cycle between the three layout types.
if (pivotTable.layout.layoutType === "Compact") {
pivotTable.layout.layoutType = "Outline";
} else if (pivotTable.layout.layoutType === "Outline") {
pivotTable.layout.layoutType = "Tabular";
} else {
pivotTable.layout.layoutType = "Compact";
}
await context.sync();
console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});
name
Nombre la tabla dinámica.
name: string;Valor de propiedad
string
Comentarios
refreshOnOpen
Especifica si la tabla dinámica se actualiza cuando se abre el libro. Corresponde a la configuración "Actualizar al cargar" en la interfaz de usuario.
refreshOnOpen: boolean;Valor de propiedad
boolean
Comentarios
rowHierarchies
Las jerarquías dinámicas de fila de la tabla dinámica.
readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;Valor de propiedad
Comentarios
useCustomSortLists
Especifica si la tabla dinámica usa listas personalizadas al ordenar.
useCustomSortLists: boolean;Valor de propiedad
boolean
Comentarios
worksheet
La hoja de cálculo que contiene la tabla dinámica actual.
readonly worksheet: Excel.Worksheet;Valor de propiedad
Comentarios
Detalles del método
delete()
Elimina la tabla dinámica.
delete(): void;Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.8 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();
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.PivotTableLoadOptions): Excel.PivotTable;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.PivotTable;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?: {
select?: string;
expand?: string;
}): Excel.PivotTable;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
refresh()
Actualiza la tabla dinámica.
refresh(): void;Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.3 ]
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();
});
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.PivotTableUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: Excel.PivotTable): void;Parámetros
- properties
- Excel.PivotTable
Devoluciones
void
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.PivotTable es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.PivotTableData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.PivotTableData;