ExcelScript.PivotField interface

Paquete:

ExcelScript

Representa el campo dinámico de Excel.

Métodos

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.
clearAllFilters()	Borra todos los criterios de todos los filtros del campo. Esto quita cualquier filtrado activo en el campo.
clearFilter(filterType)	Borra todos los criterios existentes del filtro del campo del tipo especificado (si se aplica uno actualmente).
getFilters()	Obtiene todos los filtros aplicados actualmente en el campo.
getId()	Identificador del campo dinámico.
getItems()	Devuelve los pivotItems asociados al pivotfield.
getName()	Nombre de PivotField.
getPivotItem(name)	Obtiene un objeto PivotItem por su nombre. Si el objeto PivotItem no existe, este método devuelve undefined.
getShowAllItems()	Determina si se muestran todos los elementos de PivotField.
getSubtotals()	Subtotales del PivotField.
isFiltered(filterType)	Comprueba si hay filtros aplicados en el campo.
setName(name)	Nombre de PivotField.
setShowAllItems(showAllItems)	Determina si se muestran todos los elementos de PivotField.
setSubtotals(subtotals)	Subtotales del PivotField.
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.

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

Parámetros

filter

ExcelScript.PivotFilters

Un PivotFilter específico configurado o una interfaz PivotFilters que contiene varios filtros configurados.

Devoluciones

void

Ejemplos

/**
 * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Get the first row hierarchy to use as the field which gets filtered.
  let rowHierarchy = pivotTable.getRowHierarchies()[0];

  // Get the first data hierarchy to use as the values for filtering the rows.
  let dataHierarchy = pivotTable.getDataHierarchies()[0];

  // Create a filter that excludes values greater than 500.
  let filter: ExcelScript.PivotValueFilter = {
    condition: ExcelScript.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: dataHierarchy.getName()
  };

  // Apply the filter.
  rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
    valueFilter: filter
  });
}

clearAllFilters()

Borra todos los criterios de todos los filtros del campo. Esto quita cualquier filtrado activo en el campo.

clearAllFilters(): void;

Devoluciones

void

clearFilter(filterType)

Borra todos los criterios existentes del filtro del campo del tipo especificado (si se aplica uno actualmente).

clearFilter(filterType: PivotFilterType): void;

Parámetros

filterType

ExcelScript.PivotFilterType

Tipo de filtro en el campo del que se van a borrar todos los criterios.

Devoluciones

void

Ejemplos

/**
 * This script gets the "Type" field from the "Farms Sales" PivotTable 
 * and clears the value filter from it.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the "Type" field.
  const typeField = pivot.getHierarchy("Type").getPivotField("Type");

  // Clear the value filter (if there is one) from the field.
  typeField.clearFilter(ExcelScript.PivotFilterType.value);
}

getFilters()

Obtiene todos los filtros aplicados actualmente en el campo.

getFilters(): PivotFilters;

Devoluciones

ExcelScript.PivotFilters

getId()

Identificador del campo dinámico.

getId(): string;

Devoluciones

string

getItems()

Devuelve los pivotItems asociados al pivotfield.

getItems(): PivotItem[];

Devoluciones

ExcelScript.PivotItem[]

getName()

Nombre de PivotField.

getName(): string;

Devoluciones

string

getPivotItem(name)

Obtiene un objeto PivotItem por su nombre. Si el objeto PivotItem no existe, este método devuelve undefined.

getPivotItem(name: string): PivotItem | undefined;

Parámetros

name

string

Nombre del objeto PivotItem que se va a recuperar.

Devoluciones

ExcelScript.PivotItem | undefined

getShowAllItems()

Determina si se muestran todos los elementos de PivotField.

getShowAllItems(): boolean;

Devoluciones

boolean

getSubtotals()

Subtotales del PivotField.

getSubtotals(): Subtotals;

Devoluciones

ExcelScript.Subtotals

isFiltered(filterType)

Comprueba si hay filtros aplicados en el campo.

isFiltered(filterType?: PivotFilterType): boolean;

Parámetros

filterType

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

boolean

setName(name)

Nombre de PivotField.

setName(name: string): void;

Parámetros

name

string

Devoluciones

void

setShowAllItems(showAllItems)

Determina si se muestran todos los elementos de PivotField.

setShowAllItems(showAllItems: boolean): void;

Parámetros

showAllItems

boolean

Devoluciones

void

setSubtotals(subtotals)

Subtotales del PivotField.

setSubtotals(subtotals: Subtotals): void;

Parámetros

subtotals

ExcelScript.Subtotals

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

ExcelScript.SortBy

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

Devoluciones

void

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: SortBy,
            valuesHierarchy: DataPivotHierarchy,
            pivotItemScope?: Array<PivotItem | string>
        ): void;

Parámetros

sortBy

ExcelScript.SortBy

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

valuesHierarchy

ExcelScript.DataPivotHierarchy

Especifica la jerarquía de valores en el eje de datos que se va a usar para la ordenación.

pivotItemScope

Array<ExcelScript.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

Ejemplos

/**
 * This sample sorts the rows of a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get an existing PivotTable.
  const pivotTable = workbook.getPivotTable("Farm Sales");

  // Get the data hierarchy to use as the basis of the sort.
  const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort = pivotTable.getRowHierarchy("Farm");

  // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
  rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
}