ExcelScript.FilterPivotHierarchy interface

Paket:

ExcelScript

Stellt die Excel-FilterPivotHierarchy dar.

Hinweise

Beispiele

/**
 * This script creates a PivotTable with a filter.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the two worksheets to use in PivotTable creation.
  const dataSheet = workbook.getWorksheet("Data");
  const pivotSheet = workbook.getWorksheet("Pivot");

  // Create a new PivotTable.
  const newPivot = pivotSheet.addPivotTable(
    "My PivotTable", 
    dataSheet.getUsedRange(), 
    pivotSheet.getRange("A1"));

  // Add a filter with the Quarter field.
  const filter: ExcelScript.FilterPivotHierarchy = 
    newPivot.addFilterHierarchy(newPivot.getHierarchy("Quarter"));

  // Add other hierarchies...
}

Methoden

getEnableMultipleFilterItems()	Gibt an, ob mehrere Filterelemente zulässig sind.
getFields()	Gibt die PivotFields-Objekte zurück, die dem FilterPivotHierarchy-Objekt zugeordnet sind.
getId()	ID der FilterPivotHierarchy.
getName()	Der Name des FilterPivotHierarchy-Objekts
getPivotField(name)	Ruft ein PivotField anhand des Namens ab. Wenn das PivotField nicht vorhanden ist, gibt diese Methode zurück undefined.
getPosition()	Die Position des FilterPivotHierarchy-Objekts
setEnableMultipleFilterItems(enableMultipleFilterItems)	Gibt an, ob mehrere Filterelemente zulässig sind.
setName(name)	Der Name des FilterPivotHierarchy-Objekts
setPosition(position)	Die Position des FilterPivotHierarchy-Objekts
setToDefault()	Setzt das FilterPivotHierarchy-Objekt auf die Standardwerte zurück.

Details zur Methode

getEnableMultipleFilterItems()

Gibt an, ob mehrere Filterelemente zulässig sind.

getEnableMultipleFilterItems(): boolean;

Gibt zurück

boolean

getFields()

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

getFields(): PivotField[];

Gibt zurück

ExcelScript.PivotField[]

getId()

ID der FilterPivotHierarchy.

getId(): string;

Gibt zurück

string

getName()

Der Name des FilterPivotHierarchy-Objekts

getName(): string;

Gibt zurück

string

Beispiele

/**
 * This script logs the names of all the filter hierarchies in a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first PivotTable in the workbook.
    const pivotTable = workbook.getPivotTables()[0];

    // For each pivot filter, log its name.
    pivotTable.getFilterHierarchies().forEach((filter: ExcelScript.FilterPivotHierarchy) => {
      console.log(filter.getName());
    });
}

getPivotField(name)

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

getPivotField(name: string): PivotField | undefined;

Parameter

name

string

Name des abzurufenden PivotFields.

Gibt zurück

ExcelScript.PivotField | undefined

getPosition()

Die Position des FilterPivotHierarchy-Objekts

getPosition(): number;

Gibt zurück

number

setEnableMultipleFilterItems(enableMultipleFilterItems)

Gibt an, ob mehrere Filterelemente zulässig sind.

setEnableMultipleFilterItems(enableMultipleFilterItems: boolean): void;

Parameter

enableMultipleFilterItems

boolean

Gibt zurück

void

setName(name)

Der Name des FilterPivotHierarchy-Objekts

setName(name: string): void;

Parameter

name

string

Gibt zurück

void

setPosition(position)

Die Position des FilterPivotHierarchy-Objekts

setPosition(position: number): void;

Parameter

position

number

Gibt zurück

void

setToDefault()

Setzt das FilterPivotHierarchy-Objekt auf die Standardwerte zurück.

setToDefault(): void;

Gibt zurück

void