Excel.FilterPivotHierarchyCollection class
Representa una colección de elementos FilterPivotHierarchy asociados a la tabla dinámica.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.8 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(pivot |
Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación. |
| get |
Obtiene el número de jerarquías dinámicas en la colección. |
| get |
Obtiene un filterPivotHierarchy por su nombre o identificador. |
| get |
Obtiene una FilterPivotHierarchy por su nombre. Si filterPivotHierarchy no existe, este método devuelve un objeto con su |
| 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 |
| remove(filter |
Elimina PivotHierarchy del eje actual. |
| 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
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.FilterPivotHierarchy[];Valor de propiedad
Detalles del método
add(pivotHierarchy)
Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación.
add(pivotHierarchy: Excel.PivotHierarchy): Excel.FilterPivotHierarchy;Parámetros
- pivotHierarchy
- Excel.PivotHierarchy
Devoluciones
Comentarios
getCount()
Obtiene el número de jerarquías dinámicas en la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(name)
Obtiene un filterPivotHierarchy por su nombre o identificador.
getItem(name: string): Excel.FilterPivotHierarchy;Parámetros
- name
-
string
Nombre de filterPivotHierarchy que se va a recuperar.
Devoluciones
Comentarios
getItemOrNullObject(name)
Obtiene una FilterPivotHierarchy por su nombre. Si filterPivotHierarchy no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(name: string): Excel.FilterPivotHierarchy;Parámetros
- name
-
string
Nombre de filterPivotHierarchy que se va a recuperar.
Devoluciones
Comentarios
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.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection;Parámetros
- options
-
Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.FilterPivotHierarchyCollection;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.FilterPivotHierarchyCollection;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
remove(filterPivotHierarchy)
Elimina PivotHierarchy del eje actual.
remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void;Parámetros
- filterPivotHierarchy
- Excel.FilterPivotHierarchy
Devoluciones
void
Comentarios
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.FilterPivotHierarchyCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.FilterPivotHierarchyCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.FilterPivotHierarchyCollectionData;