Excel.PivotItem class

Representa el Excel PivotItem.

Extends

Comentarios

[Conjunto de API: ExcelApi 1.8 ]

Propiedades

context

Contexto de solicitud asociado al objeto. Esto conecta el proceso del complemento con el Office proceso de la aplicación host.

id

Id. del objeto PivotItem.

isExpanded

Determina si el elemento se expande para mostrar los elementos secundarios o si está contraído y se ocultan los elementos secundarios.

name

Nombre del PivotItem.

visible

Especifica si el objeto PivotItem está visible.

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, en función de un objeto cargado existente.

toJSON()

Invalida el método JavaScript para proporcionar resultados más útiles cuando se pasa un objeto API a toJSON()``JSON.stringify(). (JSON.stringify, a su vez, llama toJSON al método del objeto que se pasa a él). Mientras que la Excel. El objeto PivotItem es un objeto API, el método devuelve un objeto JavaScript sin formato toJSON (se escribe comoExcel.Interfaces.PivotItemData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto. Esto conecta el proceso del complemento con el Office proceso de la aplicación host.

context: RequestContext;

Valor de propiedad

id

Id. del objeto PivotItem.

readonly id: string;

Valor de propiedad

string

Comentarios

[Conjunto de API: ExcelApi 1.8 ]

isExpanded

Determina si el elemento se expande para mostrar los elementos secundarios o si está contraído y se ocultan los elementos secundarios.

isExpanded: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.8 ]

name

Nombre del PivotItem.

name: string;

Valor de propiedad

string

Comentarios

[Conjunto de API: ExcelApi 1.8 ]

visible

Especifica si el objeto PivotItem está visible.

visible: boolean;

Valor de propiedad

boolean

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.PivotItemLoadOptions): Excel.PivotItem;

Parámetros

options
Excel.Interfaces.PivotItemLoadOptions

Proporciona opciones para las propiedades del objeto que se cargarán.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se cargarán.

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

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se cargarán y es una cadena delimitada por comas que especifica las propiedades de navegación que propertyNamesAndPaths.expand se cargarán.

Devoluciones

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

Parámetros

properties
Excel.Interfaces.PivotItemUpdateData

Un objeto JavaScript con propiedades que se estructuran isomórficamente en 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, en función de un objeto cargado existente.

set(properties: Excel.PivotItem): void;

Parámetros

properties
Excel.PivotItem

Devoluciones

void

toJSON()

Invalida el método JavaScript para proporcionar resultados más útiles cuando se pasa un objeto API a toJSON()``JSON.stringify(). (JSON.stringify, a su vez, llama toJSON al método del objeto que se pasa a él). Mientras que la Excel. El objeto PivotItem es un objeto API, el método devuelve un objeto JavaScript sin formato toJSON (se escribe comoExcel.Interfaces.PivotItemData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.PivotItemData;

Devoluciones