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 Trabajar 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 filtros dinámicos en un campo dinámico determinado de la tabla. |
| column |
Las jerarquías dinámicas de columna de la tabla dinámica. |
| 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. |
| 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. |
| get |
Devuelve la representación de cadena del origen de datos para la tabla dinámica. Actualmente, este método admite representaciones de cadena para objetos de tabla y rango. De lo contrario, devuelve una cadena vacía. |
| get |
Obtiene el tipo de origen de datos de 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 API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
allowMultipleFiltersPerField
Especifica si la tabla dinámica permite la aplicación de varios filtros dinámicos en un campo dinámico determinado de la tabla.
allowMultipleFiltersPerField: boolean;Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.12]
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]
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
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]
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
[Conjunto de API: ExcelApi 1.9]
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]
hierarchies
Las jerarquías dinámicas de la tabla dinámica.
readonly hierarchies: Excel.PivotHierarchyCollection;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.8]
id
Identificador de la tabla dinámica.
readonly id: string;Valor de propiedad
string
Comentarios
[Conjunto de API: ExcelApi 1.5]
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]
name
Nombre la tabla dinámica.
name: string;Valor de propiedad
string
Comentarios
[Conjunto de API: ExcelApi 1.3]
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
[Conjunto de API: ExcelApi 1.13]
rowHierarchies
Las jerarquías dinámicas de fila de la tabla dinámica.
readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.8]
useCustomSortLists
Especifica si la tabla dinámica usa listas personalizadas al ordenar.
useCustomSortLists: boolean;Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.9]
worksheet
La hoja de cálculo que contiene la tabla dinámica actual.
readonly worksheet: Excel.Worksheet;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.3]
Detalles del método
delete()
Elimina la tabla dinámica.
delete(): void;Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.8]
getDataSourceString()
Devuelve la representación de cadena del origen de datos para la tabla dinámica. Actualmente, este método admite representaciones de cadena para objetos de tabla y rango. De lo contrario, devuelve una cadena vacía.
getDataSourceString(): OfficeExtension.ClientResult<string>;Devoluciones
OfficeExtension.ClientResult<string>
Comentarios
[Conjunto de API: ExcelApi 1.15]
getDataSourceType()
Obtiene el tipo de origen de datos de la tabla dinámica.
getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.15]
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]
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 API del mismo tipo.
set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.PivotTableUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en un objeto cargado existente.
set(properties: Excel.PivotTable): void;Parámetros
- properties
- Excel.PivotTable
Devoluciones
void
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.PivotTable es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PivotTableData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.PivotTableData;