Excel.PivotField class

Paquete:
excel

Representa el campo dinámico de Excel.

Extends
OfficeExtension.ClientObject

Comentarios

Conjunto de API: ExcelApi 1.8

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.
id

Identificador del campo dinámico.
items

Devuelve los elementos dinámicos asociados al campo dinámico.
name

Nombre de PivotField.
showAllItems

Determina si se muestran todos los elementos de PivotField.
subtotals

Subtotales del PivotField.

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.
sortByLabels(sortBy)

Ordena el PivotField. Si se especifica una DataPivotHierarchy, entonces el orden se aplicará basándose en ella, si no, se basará en el propio PivotField.
sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Ordena el campo de tabla dinámica por los valores especificados en un ámbito determinado. El ámbito define qué valores específicos se usarán para ordenar cuando haya varios valores de la misma DataPivotHierarchy.
sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Ordena el campo de tabla dinámica por los valores especificados en un ámbito determinado. El ámbito define qué valores específicos se usarán para ordenar cuando haya varios valores de la misma DataPivotHierarchy.
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.PivotField es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PivotFieldData) 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

id

Identificador del campo dinámico.

readonly id: string;

Valor de propiedad

string

Comentarios

Conjunto de API: ExcelApi 1.8

items

Devuelve los elementos dinámicos asociados al campo dinámico.

readonly items: Excel.PivotItemCollection;

Valor de propiedad

Excel.PivotItemCollection

Comentarios

Conjunto de API: ExcelApi 1.8

name

Nombre de PivotField.

name: string;

Valor de propiedad

string

Comentarios

Conjunto de API: ExcelApi 1.8

showAllItems

Determina si se muestran todos los elementos de PivotField.

showAllItems: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: ExcelApi 1.8

subtotals

Subtotales del PivotField.

subtotals: Excel.Subtotals;

Valor de propiedad

Excel.Subtotals

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.PivotFieldLoadOptions): Excel.PivotField;

Parámetros

options
Excel.Interfaces.PivotFieldLoadOptions

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

Devoluciones

Excel.PivotField

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

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.PivotField

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

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.PivotField

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

Parámetros

properties
Excel.Interfaces.PivotFieldUpdateData

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

Parámetros

properties
Excel.PivotField

Devoluciones

void

sortByLabels(sortBy)

Ordena el PivotField. Si se especifica una DataPivotHierarchy, entonces el orden se aplicará basándose en ella, si no, se basará en el propio PivotField.

sortByLabels(sortBy: SortBy): void;

Parámetros

sortBy
Excel.SortBy

Especifica si la ordenación se realiza en orden ascendente o descendente.

Devoluciones

void

Comentarios

Conjunto de API: ExcelApi 1.8

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Ordena el campo de tabla dinámica por los valores especificados en un ámbito determinado. El ámbito define qué valores específicos se usarán para ordenar cuando haya varios valores de la misma DataPivotHierarchy.

sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;

Parámetros

sortBy
Excel.SortBy

Especifica si la ordenación se realiza en orden ascendente o descendente.

valuesHierarchy
Excel.DataPivotHierarchy

Especifica la jerarquía de valores en el eje de datos que se utilizará para ordenar.

pivotItemScope

Array<Excel.PivotItem | string>

Los elementos que se deben usar para el ámbito de la ordenación. Estos serán los elementos que componen la fila o columna que quiera ordenar. Si se usa una cadena en lugar de un elemento dinámico, la cadena representa el identificador del elemento dinámico. Si no hay elementos distintos de la jerarquía de datos en el eje que desea ordenar, este puede estar vacío.

Devoluciones

void

Comentarios

Conjunto de API: ExcelApi 1.9

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Ordena el campo de tabla dinámica por los valores especificados en un ámbito determinado. El ámbito define qué valores específicos se usarán para ordenar cuando haya varios valores de la misma DataPivotHierarchy.

sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;

Parámetros

sortBy

"Ascending" | "Descending"

Especifica si la ordenación se realiza en orden ascendente o descendente.

valuesHierarchy
Excel.DataPivotHierarchy

Especifica la jerarquía de valores en el eje de datos que se utilizará para ordenar.

pivotItemScope

Array<Excel.PivotItem | string>

Los elementos que se deben usar para el ámbito de la ordenación. Estos serán los elementos que componen la fila o columna que quiera ordenar. Si se usa una cadena en lugar de un elemento dinámico, la cadena representa el identificador del elemento dinámico. Si no hay elementos distintos de la jerarquía de datos en el eje que desea ordenar, este puede estar vacío.

Devoluciones

void

Comentarios

Conjunto de API: ExcelApi 1.9

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

toJSON(): Excel.Interfaces.PivotFieldData;

Devoluciones

Excel.Interfaces.PivotFieldData