ExcelScript.PivotField interface

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 Filter für das Feld entfernt.

clearFilter(filterType)

Löscht alle vorhandenen Kriterien aus dem Feldfilter des angegebenen Typs (sofern derzeit eines angewendet wird).

getFilters()

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

getId()

DIE ID des PivotFields.

getItems()

Gibt die PivotFields-Objekte zurück, die dem PivotField-Objekt zugeordnet sind.

getName()

Der Name von PivotField.

getPivotItem(name)

Ruft ein PivotItem anhand des Namens ab. Wenn das PivotItem nicht vorhanden ist, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true.

getShowAllItems()

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

getSubtotals()

Zwischensumme von PivotField

isFiltered(filterType)

Überprüft, ob auf das Feld angewendete Filter vorhanden sind.

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 spezifischen Werte zum Sortieren verwendet werden, wenn mehrere Werte aus demselben DataPivotHierarchy-Objekt 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

clearAllFilters()

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

clearAllFilters(): void;

Gibt zurück

void

clearFilter(filterType)

Löscht alle vorhandenen Kriterien aus dem Feldfilter des angegebenen Typs (sofern derzeit eines angewendet wird).

clearFilter(filterType: PivotFilterType): void;

Parameter

filterType
ExcelScript.PivotFilterType

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

Gibt zurück

void

getFilters()

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

getFilters(): PivotFilters;

Gibt zurück

getId()

DIE ID des PivotFields.

getId(): string;

Gibt zurück

string

getItems()

Gibt die PivotFields-Objekte zurück, die dem PivotField-Objekt zugeordnet sind.

getItems(): PivotItem[];

Gibt zurück

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 Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true.

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

isFiltered(filterType)

Überprüft, ob auf das Feld angewendete Filter vorhanden sind.

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

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 spezifischen Werte zum Sortieren verwendet werden, wenn mehrere Werte aus demselben DataPivotHierarchy-Objekt 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 Sortierbereich verwendet werden sollen. Dies sind die Elemente, die die Zeile oder Spalte bilden, nach der sortiert werden soll. Wenn anstelle eines PivotItem eine Zeichenfolge verwendet wird, stellt die Zeichenfolge die ID des PivotItem dar. Wenn keine anderen Elemente als die Datenhierarchie auf der Achse vorhanden sind, nach der Sortiert werden soll, kann dies leer sein.

Gibt zurück

void