ExcelScript.PivotField interface

Paket:

ExcelScript

Stellt das Excel-PivotField dar.

Methoden

applyFilter(filter)	Legt einen oder mehrere der aktuellen PivotFilter des Felds fest und wendet sie auf das Feld an. Wenn die bereitgestellten Filter ungültig sind oder nicht angewendet werden können, wird eine Ausnahme ausgelöst.
clearAllFilters()	Löscht alle Kriterien aus allen Filtern des Felds. Dadurch werden alle aktiven Filterungen für das Feld entfernt.
clearFilter(filterType)	Löscht alle vorhandenen Kriterien aus dem Filter des Felds des angegebenen Typs (sofern aktuell angewendet).
getFilters()	Ruft alle Filter ab, die derzeit auf das Feld angewendet werden.
getId()	ID des PivotFields.
getItems()	Gibt die PivotItems zurück, die pivotField zugeordnet sind.
getName()	Der Name von PivotField.
getPivotItem(name)	Ruft ein PivotItem anhand des Namens ab. Wenn das PivotItem nicht vorhanden ist, gibt diese Methode zurück undefined.
getShowAllItems()	Legt fest, ob alle Elemente des PivotField-Objekts angezeigt werden.
getSubtotals()	Zwischensumme von PivotField
isFiltered(filterType)	Überprüft, ob für das Feld Filter angewendet werden.
setName(name)	Der Name von PivotField.
setShowAllItems(showAllItems)	Legt fest, ob alle Elemente des PivotField-Objekts angezeigt werden.
setSubtotals(subtotals)	Zwischensumme von PivotField
sortByLabels(sortBy)	Sortiert das PivotField-Objekt. Wenn ein DataPivotHierarchy-Objekt angegeben ist, wird die Sortierung basierend auf diesem Objekt angewendet. Andernfalls erfolgt die Sortierung auf Grundlage von PivotField.
sortByValues(sortBy, valuesHierarchy, pivotItemScope)	Sortiert das PivotField in einem bestimmten Bereich nach den angegebenen Werten. Der Bereich definiert, welche bestimmten Werte zum Sortieren verwendet werden, wenn mehrere Werte aus derselben DataPivotHierarchy vorhanden sind.

Details zur Methode

applyFilter(filter)

Legt einen oder mehrere der aktuellen PivotFilter des Felds fest und wendet sie auf das Feld an. Wenn die bereitgestellten Filter ungültig sind oder nicht angewendet werden können, wird eine Ausnahme ausgelöst.

applyFilter(filter: PivotFilters): void;

Parameter

filter

ExcelScript.PivotFilters

Ein konfigurierter bestimmter PivotFilter oder eine PivotFilters-Schnittstelle, die mehrere konfigurierte Filter enthält.

Gibt zurück

void

Beispiele

/**
 * 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()

Löscht alle Kriterien aus allen Filtern des Felds. Dadurch werden alle aktiven Filterungen für das Feld entfernt.

clearAllFilters(): void;

Gibt zurück

void

clearFilter(filterType)

Löscht alle vorhandenen Kriterien aus dem Filter des Felds des angegebenen Typs (sofern aktuell angewendet).

clearFilter(filterType: PivotFilterType): void;

Parameter

filterType

ExcelScript.PivotFilterType

Der Filtertyp für das Feld, von dem alle Kriterien gelöscht werden sollen.

Gibt zurück

void

Beispiele

/**
 * 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()

Ruft alle Filter ab, die derzeit auf das Feld angewendet werden.

getFilters(): PivotFilters;

Gibt zurück

ExcelScript.PivotFilters

getId()

ID des PivotFields.

getId(): string;

Gibt zurück

string

getItems()

Gibt die PivotItems zurück, die pivotField zugeordnet sind.

getItems(): PivotItem[];

Gibt zurück

ExcelScript.PivotItem[]

getName()

Der Name von PivotField.

getName(): string;

Gibt zurück

string

getPivotItem(name)

Ruft ein PivotItem anhand des Namens ab. Wenn das PivotItem nicht vorhanden ist, gibt diese Methode zurück undefined.

getPivotItem(name: string): PivotItem | undefined;

Parameter

name

string

Name des abzurufenden PivotItem.

Gibt zurück

ExcelScript.PivotItem | undefined

getShowAllItems()

Legt fest, ob alle Elemente des PivotField-Objekts angezeigt werden.

getShowAllItems(): boolean;

Gibt zurück

boolean

getSubtotals()

Zwischensumme von PivotField

getSubtotals(): Subtotals;

Gibt zurück

ExcelScript.Subtotals

isFiltered(filterType)

Überprüft, ob für das Feld Filter angewendet werden.

isFiltered(filterType?: PivotFilterType): boolean;

Parameter

filterType

ExcelScript.PivotFilterType

Der zu überprüfende Filtertyp. Wenn kein Typ angegeben wird, überprüft diese Methode, ob ein Filter angewendet wird.

Gibt zurück

boolean

setName(name)

Der Name von PivotField.

setName(name: string): void;

Parameter

name

string

Gibt zurück

void

setShowAllItems(showAllItems)

Legt fest, ob alle Elemente des PivotField-Objekts angezeigt werden.

setShowAllItems(showAllItems: boolean): void;

Parameter

showAllItems

boolean

Gibt zurück

void

setSubtotals(subtotals)

Zwischensumme von PivotField

setSubtotals(subtotals: Subtotals): void;

Parameter

subtotals

ExcelScript.Subtotals

Gibt zurück

void

sortByLabels(sortBy)

Sortiert das PivotField-Objekt. Wenn ein DataPivotHierarchy-Objekt angegeben ist, wird die Sortierung basierend auf diesem Objekt angewendet. Andernfalls erfolgt die Sortierung auf Grundlage von PivotField.

sortByLabels(sortBy: SortBy): void;

Parameter

sortBy

ExcelScript.SortBy

Gibt an, ob die Sortierung in aufsteigender oder absteigender Reihenfolge erfolgt.

Gibt zurück

void

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Sortiert das PivotField in einem bestimmten Bereich nach den angegebenen Werten. Der Bereich definiert, welche bestimmten Werte zum Sortieren verwendet werden, wenn mehrere Werte aus derselben DataPivotHierarchy vorhanden sind.

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

Parameter

sortBy

ExcelScript.SortBy

Gibt an, ob die Sortierung in aufsteigender oder absteigender Reihenfolge erfolgt.

valuesHierarchy

ExcelScript.DataPivotHierarchy

Gibt die Wertehierarchie auf der Datenachse an, die für die Sortierung verwendet werden soll.

pivotItemScope

Array<ExcelScript.PivotItem | string>

Die Elemente, die für den Bereich der Sortierung verwendet werden sollen. Dies sind die Elemente, aus denen die Zeile oder Spalte besteht, nach der Sie sortieren möchten. Wenn eine Zeichenfolge anstelle eines PivotItem verwendet wird, stellt die Zeichenfolge die ID des PivotItem dar. Wenn auf der Achse, nach der Sie sortieren möchten, keine anderen Elemente als die Datenhierarchie vorhanden sind, kann dies leer sein.

Gibt zurück

void

Beispiele

/**
 * 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);
}