Excel.RowColumnPivotHierarchy class

Paquete:

excel

Representa la RowColumnPivotHierarchy de Excel.

Extends

OfficeExtension.ClientObject

Comentarios

Conjunto de API: ExcelApi 1.8

Usada por

• Excel.RowColumnPivotHierarchyCollection: add, getItem, getItemOrNullObject, items, remove

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.
fields	Devuelve los PivotFields asociados con la RowColumnPivotHierarchy.
id	Identificador de RowColumnPivotHierarchy.
name	Nombre de la RowColumnPivotHierarchy.
position	Posición de la RowColumnPivotHierarchy.

Métodos

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(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
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.
setToDefault()	Restablece la RowColumnPivotHierarchy a sus valores predeterminados.
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.RowColumnPivotHierarchy es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.RowColumnPivotHierarchyData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

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

Excel.RequestContext

fields

Devuelve los PivotFields asociados con la RowColumnPivotHierarchy.

readonly fields: Excel.PivotFieldCollection;

Valor de propiedad

Excel.PivotFieldCollection

Comentarios

Conjunto de API: ExcelApi 1.8

id

Identificador de RowColumnPivotHierarchy.

readonly id: string;

Valor de propiedad

string

Comentarios

Conjunto de API: ExcelApi 1.8

name

Nombre de la RowColumnPivotHierarchy.

name: string;

Valor de propiedad

string

Comentarios

Conjunto de API: ExcelApi 1.8

position

Posición de la RowColumnPivotHierarchy.

position: number;

Valor de propiedad

number

Comentarios

Conjunto de API: ExcelApi 1.8

Detalles del método

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.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy;

Parámetros

options

Excel.Interfaces.RowColumnPivotHierarchyLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.RowColumnPivotHierarchy

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.RowColumnPivotHierarchy;

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

Excel.RowColumnPivotHierarchy

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.RowColumnPivotHierarchy;

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

Excel.RowColumnPivotHierarchy

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.RowColumnPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

Excel.Interfaces.RowColumnPivotHierarchyUpdateData

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.RowColumnPivotHierarchy): void;

Parámetros

properties

Excel.RowColumnPivotHierarchy

Devoluciones

void

setToDefault()

Restablece la RowColumnPivotHierarchy a sus valores predeterminados.

setToDefault(): void;

Devoluciones

void

Comentarios

Conjunto de API: ExcelApi 1.8

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.RowColumnPivotHierarchy es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.RowColumnPivotHierarchyData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.RowColumnPivotHierarchyData;

Devoluciones

Excel.Interfaces.RowColumnPivotHierarchyData