Excel.PivotField class
Representa el campo dinámico de Excel.
- 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. |
| id | Identificador del campo dinámico. |
| items | Devuelve los pivotItems asociados al pivotfield. |
| name | Nombre de PivotField. |
| show |
Determina si se muestran todos los elementos de PivotField. |
| subtotals | Subtotales del PivotField. |
Métodos
| apply |
Establece uno o varios de los pivotfilters actuales del campo y los aplica al campo. Si los filtros proporcionados no son válidos o no se pueden aplicar, se produce una excepción. |
| clear |
Borra todos los criterios de todos los filtros del campo. Esto quita cualquier filtrado activo en el campo. |
| clear |
Borra todos los criterios existentes del filtro del campo del tipo especificado (si se aplica uno actualmente). |
| clear |
Borra todos los criterios existentes del filtro del campo del tipo especificado (si se aplica uno actualmente). |
| get |
Obtiene todos los filtros aplicados actualmente en el campo. |
| is |
Comprueba si hay filtros aplicados en el campo. |
| is |
Comprueba si hay filtros aplicados en el campo. |
| 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 |
| 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 de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| sort |
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. |
| sort |
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. |
| sort |
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() | 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
id
Identificador del campo dinámico.
readonly id: string;Valor de propiedad
string
Comentarios
items
Devuelve los pivotItems asociados al pivotfield.
readonly items: Excel.PivotItemCollection;Valor de propiedad
Comentarios
name
Nombre de PivotField.
name: string;Valor de propiedad
string
Comentarios
showAllItems
Determina si se muestran todos los elementos de PivotField.
showAllItems: boolean;Valor de propiedad
boolean
Comentarios
subtotals
Subtotales del PivotField.
subtotals: Excel.Subtotals;Valor de propiedad
Comentarios
Detalles del método
applyFilter(filter)
Establece uno o varios de los pivotfilters actuales del campo y los aplica al campo. Si los filtros proporcionados no son válidos o no se pueden aplicar, se produce una excepción.
applyFilter(filter: Excel.PivotFilters): void;Parámetros
- filter
- Excel.PivotFilters
Un PivotFilter específico configurado o una interfaz PivotFilters que contiene varios filtros configurados.
Devoluciones
void
Comentarios
clearAllFilters()
Borra todos los criterios de todos los filtros del campo. Esto quita cualquier filtrado activo en el campo.
clearAllFilters(): void;Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.12 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml
await Excel.run(async (context) => {
// Clear all the PivotFilters.
// Get the PivotTable.
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
pivotTable.hierarchies.load("name");
await context.sync();
// Clear the filters on each PivotField.
pivotTable.hierarchies.items.forEach((hierarchy) => {
hierarchy.fields.getItem(hierarchy.name).clearAllFilters();
});
await context.sync();
});
clearFilter(filterType)
Borra todos los criterios existentes del filtro del campo del tipo especificado (si se aplica uno actualmente).
clearFilter(filterType: Excel.PivotFilterType): void;Parámetros
- filterType
- Excel.PivotFilterType
Tipo de filtro en el campo del que se van a borrar todos los criterios.
Devoluciones
void
Comentarios
clearFilter(filterTypeString)
Borra todos los criterios existentes del filtro del campo del tipo especificado (si se aplica uno actualmente).
clearFilter(filterTypeString: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;Parámetros
- filterTypeString
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
Tipo de filtro en el campo del que se van a borrar todos los criterios.
Devoluciones
void
Comentarios
getFilters()
Obtiene todos los filtros aplicados actualmente en el campo.
getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;Devoluciones
Interfaz PivotFilters con todos los filtros activos.
Comentarios
isFiltered(filterType)
Comprueba si hay filtros aplicados en el campo.
isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;Parámetros
- filterType
- Excel.PivotFilterType
Tipo de filtro que se va a comprobar. Si no se proporciona ningún tipo, este método comprobará si se aplica algún filtro.
Devoluciones
OfficeExtension.ClientResult<boolean>
True si el campo tiene aplicado un filtro de tipo filterType . Si filterType no se especifica, true se devuelve si el campo tiene filtros aplicados.
Comentarios
isFiltered(filterTypeString)
Comprueba si hay filtros aplicados en el campo.
isFiltered(filterTypeString?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;Parámetros
- filterTypeString
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
Tipo de filtro que se va a comprobar. Si no se proporciona ningún tipo, este método comprobará si se aplica algún filtro.
Devoluciones
OfficeExtension.ClientResult<boolean>
True si el campo tiene aplicado un filtro de tipo filterType . Si filterType no se especifica, true se devuelve si el campo tiene filtros aplicados.
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.PivotFieldLoadOptions): Excel.PivotField;Parámetros
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.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
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
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 de API del mismo tipo.
set(properties: Interfaces.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.PivotFieldUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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.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
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 va a usar para la ordenación.
- 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 en la que desea ordenar. Si se usa una cadena en lugar de un objeto PivotItem, la cadena representa el identificador del objeto PivotItem. Si no hay ningún elemento que no sea la jerarquía de datos en el eje por el que desea ordenar, puede estar vacío.
Devoluciones
void
Comentarios
sortByValues(sortByString, 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(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Parámetros
- sortByString
-
"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 va a usar para la ordenación.
- 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 en la que desea ordenar. Si se usa una cadena en lugar de un objeto PivotItem, la cadena representa el identificador del objeto PivotItem. Si no hay ningún elemento que no sea la jerarquía de datos en el eje por el que desea ordenar, puede estar vacío.
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.PivotField es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.PivotFieldData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.PivotFieldData;