Excel.PivotField class

Stellt das Excel-PivotField dar.

Extends

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Eigenschaften

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

id

ID des PivotFields.

items

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

name

Der Name von PivotField.

showAllItems

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

subtotals

Zwischensumme von PivotField

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

clearFilter(filterTypeString)

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.

isFiltered(filterType)

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

isFiltered(filterTypeString)

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

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

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.

sortByValues(sortByString, 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.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.PivotField Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.PivotFieldData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

id

ID des PivotFields.

readonly id: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.8 ]

items

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

readonly items: Excel.PivotItemCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

name

Der Name von PivotField.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.8 ]

showAllItems

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

showAllItems: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

subtotals

Zwischensumme von PivotField

subtotals: Excel.Subtotals;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

Parameter

filter
Excel.PivotFilters

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.12 ]

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

Hinweise

[ API-Satz: ExcelApi 1.12 ]

Beispiele

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

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

clearFilter(filterType: Excel.PivotFilterType): void;

Parameter

filterType
Excel.PivotFilterType

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.12 ]

clearFilter(filterTypeString)

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

clearFilter(filterTypeString: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;

Parameter

filterTypeString

"Unknown" | "Value" | "Manual" | "Label" | "Date"

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.12 ]

getFilters()

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

getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;

Gibt zurück

Eine PivotFilters-Schnittstelle mit allen aktiven Filtern.

Hinweise

[ API-Satz: ExcelApi 1.12 ]

isFiltered(filterType)

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

isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;

Parameter

filterType
Excel.PivotFilterType

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

Gibt zurück

True, wenn auf das Feld ein Filter vom Typ filterType angewendet wurde. Wenn filterType nicht angegeben ist, wird zurückgegeben, true wenn das Feld über angewendete Filter verfügt.

Hinweise

[ API-Satz: ExcelApi 1.12 ]

isFiltered(filterTypeString)

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

isFiltered(filterTypeString?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;

Parameter

filterTypeString

"Unknown" | "Value" | "Manual" | "Label" | "Date"

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

Gibt zurück

True, wenn auf das Feld ein Filter vom Typ filterType angewendet wurde. Wenn filterType nicht angegeben ist, wird zurückgegeben, true wenn das Feld über angewendete Filter verfügt.

Hinweise

[ API-Satz: ExcelApi 1.12 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField;

Parameter

options
Excel.Interfaces.PivotFieldLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.PivotField;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.PivotField;

Parameter

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties
Excel.Interfaces.PivotFieldUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.PivotField): void;

Parameter

properties
Excel.PivotField

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
Excel.SortBy

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

Parameter

sortBy
Excel.SortBy

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

valuesHierarchy
Excel.DataPivotHierarchy

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

pivotItemScope

Array<Excel.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 anstelle eines PivotItem eine Zeichenfolge 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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

sortByValues(sortByString, 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(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;

Parameter

sortByString

"Ascending" | "Descending"

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

valuesHierarchy
Excel.DataPivotHierarchy

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

pivotItemScope

Array<Excel.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 anstelle eines PivotItem eine Zeichenfolge 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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.PivotField Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.PivotFieldData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.PivotFieldData;

Gibt zurück