Excel.RowColumnPivotHierarchyCollection class
Representa una colección de elementos RowColumnPivotHierarchy asociados a la tabla dinámica.
- 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
| 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 una RowColumnPivotHierarchy por su nombre o id. |
| get |
Obtiene una RowColumnPivotHierarchy por su nombre. Si RowColumnPivotHierarchy 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(row |
Elimina PivotHierarchy del eje actual. |
| 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.RowColumnPivotHierarchy[];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.RowColumnPivotHierarchy;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 una RowColumnPivotHierarchy por su nombre o id.
getItem(name: string): Excel.RowColumnPivotHierarchy;Parámetros
- name
-
string
Nombre de la jerarquía RowColumnPivot que se va a recuperar.
Devoluciones
Comentarios
getItemOrNullObject(name)
Obtiene una RowColumnPivotHierarchy por su nombre. Si RowColumnPivotHierarchy no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getItemOrNullObject(name: string): Excel.RowColumnPivotHierarchy;Parámetros
- name
-
string
Nombre de la jerarquía RowColumnPivot 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.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection;Parámetros
- options
-
Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & 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.RowColumnPivotHierarchyCollection;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.RowColumnPivotHierarchyCollection;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(rowColumnPivotHierarchy)
Elimina PivotHierarchy del eje actual.
remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy): void;Parámetros
- rowColumnPivotHierarchy
- Excel.RowColumnPivotHierarchy
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.RowColumnPivotHierarchyCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.RowColumnPivotHierarchyCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Excel.Interfaces.RowColumnPivotHierarchyCollectionData;