ExcelScript.PivotTable interface

Paket:

ExcelScript

Stellt eine Excel-PivotTable dar.

Hinweise

Beispiele

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

Methoden

addColumnHierarchy(pivotHierarchy)	Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu. Wenn die Hierarchie an anderer Stelle in der Zeile, Spalte oder Filterachse vorhanden ist, wird sie von dieser Stelle entfernt.
addDataHierarchy(pivotHierarchy)	Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu.
addFilterHierarchy(pivotHierarchy)	Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu. Wenn die Hierarchie an anderer Stelle in der Zeile, Spalte oder Filterachse vorhanden ist, wird sie von dieser Stelle entfernt.
addRowHierarchy(pivotHierarchy)	Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu. Wenn die Hierarchie an anderer Stelle in der Zeile, Spalte oder Filterachse vorhanden ist, wird sie von dieser Stelle entfernt.
delete()	Aktualisiert PivotTable
getAllowMultipleFiltersPerField()	Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilter auf einem bestimmten PivotField in der Tabelle zulässt.
getColumnHierarchies()	Die Pivot-Hierarchien der Spalten von PivotTable.
getColumnHierarchy(name)	Ruft das RowColumnPivotHierarchy-Objekt anhand des Namens ab. Wenn RowColumnPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.
getDataHierarchies()	Die Pivot-Hierarchien der Daten von PivotTable.
getDataHierarchy(name)	Ruft das DataPivotHierarchy-Objekt anhand des Namens ab. Wenn DataPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.
getEnableDataValueEditing()	Gibt an, ob die PivotTable das Bearbeiten von Werten im Datentext durch den Benutzer zulässt.
getFilterHierarchies()	Die Pivot-Hierarchien der Filter von PivotTable.
getFilterHierarchy(name)	Ruft das FilterPivotHierarchy-Objekt anhand des Namens ab. Wenn FilterPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.
getHierarchies()	Die Pivot-Hierarchien von PivotTable.
getHierarchy(name)	Ruft das PivotHierarchy-Objekt anhand des Namens ab. Wenn pivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.
getId()	ID der PivotTable.
getLayout()	Das PivotLayout-Objekt, das das Layout und die visuelle Struktur von PivotTable beschreibt.
getName()	Der Name der PivotTable.
getRowHierarchies()	Die Pivot-Hierarchien der Zeilen von PivotTable.
getRowHierarchy(name)	Ruft das RowColumnPivotHierarchy-Objekt anhand des Namens ab. Wenn RowColumnPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.
getUseCustomSortLists()	Gibt an, ob die PivotTable beim Sortieren benutzerdefinierte Listen verwendet.
getWorksheet()	Das Arbeitsblatt, das die aktuelle PivotTable enthält.
refresh()	Aktualisiert die PivotTable.
removeColumnHierarchy(rowColumnPivotHierarchy)	Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.
removeDataHierarchy(DataPivotHierarchy)	Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.
removeFilterHierarchy(filterPivotHierarchy)	Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.
removeRowHierarchy(rowColumnPivotHierarchy)	Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.
setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)	Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilter auf einem bestimmten PivotField in der Tabelle zulässt.
setEnableDataValueEditing(enableDataValueEditing)	Gibt an, ob die PivotTable das Bearbeiten von Werten im Datentext durch den Benutzer zulässt.
setName(name)	Der Name der PivotTable.
setUseCustomSortLists(useCustomSortLists)	Gibt an, ob die PivotTable beim Sortieren benutzerdefinierte Listen verwendet.

Details zur Methode

addColumnHierarchy(pivotHierarchy)

Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu. Wenn die Hierarchie an anderer Stelle in der Zeile, Spalte oder Filterachse vorhanden ist, wird sie von dieser Stelle entfernt.

addColumnHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Parameter

pivotHierarchy

ExcelScript.PivotHierarchy

Gibt zurück

ExcelScript.RowColumnPivotHierarchy

Beispiele

/**
 * This script adds a row hierarchy to the PivotTable on the current worksheet.
 * This assumes the source data has columns named 
 * "Type", "Classification", and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Add the field "Type" to the PivotTable as a row hierarchy.
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));

  // Add the field "Classification" to the PivotTable as a column hierarchy.
  pivotTable.addColumnHierarchy(pivotTable.getHierarchy("Classification"));

  // Add the field "Sales" to the PivotTable as a data hierarchy.
  // By default, this displays the sums of the values in "Sales" based on the "Type".
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addDataHierarchy(pivotHierarchy)

Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu.

addDataHierarchy(pivotHierarchy: PivotHierarchy): DataPivotHierarchy;

Parameter

pivotHierarchy

ExcelScript.PivotHierarchy

Gibt zurück

ExcelScript.DataPivotHierarchy

Beispiele

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addFilterHierarchy(pivotHierarchy)

Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu. Wenn die Hierarchie an anderer Stelle in der Zeile, Spalte oder Filterachse vorhanden ist, wird sie von dieser Stelle entfernt.

addFilterHierarchy(
            pivotHierarchy: PivotHierarchy
        ): FilterPivotHierarchy;

Parameter

pivotHierarchy

ExcelScript.PivotHierarchy

Gibt zurück

ExcelScript.FilterPivotHierarchy

Beispiele

/**
 * This script adds a manual filter to a PivotTable. 
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the first PivotTable in the workbook.
  const pivot = workbook.getPivotTables()[0];

  // Get the hierarchy to use as the filter.
  const location = pivot.getHierarchy("Location");

  // Use "Location" as the FilterHierarchy.
  pivot.addFilterHierarchy(location);

  // Select items for the filter.
  // Note that hierarchies and fields have a 1:1 relationship in Excel,
  // so `getFields()[0]` always gets the correct field.
  location.getFields()[0].applyFilter({
    manualFilter: {
      selectedItems: ["Seattle", "Chicago"]
    }
  });
}

addRowHierarchy(pivotHierarchy)

Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu. Wenn die Hierarchie an anderer Stelle in der Zeile, Spalte oder Filterachse vorhanden ist, wird sie von dieser Stelle entfernt.

addRowHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Parameter

pivotHierarchy

ExcelScript.PivotHierarchy

Gibt zurück

ExcelScript.RowColumnPivotHierarchy

Beispiele

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

delete()

Aktualisiert PivotTable

delete(): void;

Gibt zurück

void

getAllowMultipleFiltersPerField()

Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilter auf einem bestimmten PivotField in der Tabelle zulässt.

getAllowMultipleFiltersPerField(): boolean;

Gibt zurück

boolean

getColumnHierarchies()

Die Pivot-Hierarchien der Spalten von PivotTable.

getColumnHierarchies(): RowColumnPivotHierarchy[];

Gibt zurück

ExcelScript.RowColumnPivotHierarchy[]

getColumnHierarchy(name)

Ruft das RowColumnPivotHierarchy-Objekt anhand des Namens ab. Wenn RowColumnPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.

getColumnHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Parameter

name

string

Name der abzurufenden RowColumnPivotHierarchy.

Gibt zurück

ExcelScript.RowColumnPivotHierarchy | undefined

getDataHierarchies()

Die Pivot-Hierarchien der Daten von PivotTable.

getDataHierarchies(): DataPivotHierarchy[];

Gibt zurück

ExcelScript.DataPivotHierarchy[]

getDataHierarchy(name)

Ruft das DataPivotHierarchy-Objekt anhand des Namens ab. Wenn DataPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.

getDataHierarchy(name: string): DataPivotHierarchy | undefined;

Parameter

name

string

Name der abzurufenden DataPivotHierarchy.

Gibt zurück

ExcelScript.DataPivotHierarchy | undefined

getEnableDataValueEditing()

Gibt an, ob die PivotTable das Bearbeiten von Werten im Datentext durch den Benutzer zulässt.

getEnableDataValueEditing(): boolean;

Gibt zurück

boolean

getFilterHierarchies()

Die Pivot-Hierarchien der Filter von PivotTable.

getFilterHierarchies(): FilterPivotHierarchy[];

Gibt zurück

ExcelScript.FilterPivotHierarchy[]

getFilterHierarchy(name)

Ruft das FilterPivotHierarchy-Objekt anhand des Namens ab. Wenn FilterPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.

getFilterHierarchy(name: string): FilterPivotHierarchy | undefined;

Parameter

name

string

Name der abzurufenden FilterPivotHierarchy.

Gibt zurück

ExcelScript.FilterPivotHierarchy | undefined

getHierarchies()

Die Pivot-Hierarchien von PivotTable.

getHierarchies(): PivotHierarchy[];

Gibt zurück

ExcelScript.PivotHierarchy[]

getHierarchy(name)

Ruft das PivotHierarchy-Objekt anhand des Namens ab. Wenn pivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.

getHierarchy(name: string): PivotHierarchy | undefined;

Parameter

name

string

Name der abzurufenden PivotHierarchy.

Gibt zurück

ExcelScript.PivotHierarchy | undefined

getId()

ID der PivotTable.

getId(): string;

Gibt zurück

string

getLayout()

Das PivotLayout-Objekt, das das Layout und die visuelle Struktur von PivotTable beschreibt.

getLayout(): PivotLayout;

Gibt zurück

ExcelScript.PivotLayout

Beispiele

/**
 * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
 * setting. This places the fields from the Rows area in separate columns.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Set the layout type to "tabular".
  layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
}

getName()

Der Name der PivotTable.

getName(): string;

Gibt zurück

string

getRowHierarchies()

Die Pivot-Hierarchien der Zeilen von PivotTable.

getRowHierarchies(): RowColumnPivotHierarchy[];

Gibt zurück

ExcelScript.RowColumnPivotHierarchy[]

getRowHierarchy(name)

Ruft das RowColumnPivotHierarchy-Objekt anhand des Namens ab. Wenn RowColumnPivotHierarchy nicht vorhanden ist, gibt diese Methode zurück undefined.

getRowHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Parameter

name

string

Name der abzurufenden RowColumnPivotHierarchy.

Gibt zurück

ExcelScript.RowColumnPivotHierarchy | undefined

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

getUseCustomSortLists()

Gibt an, ob die PivotTable beim Sortieren benutzerdefinierte Listen verwendet.

getUseCustomSortLists(): boolean;

Gibt zurück

boolean

getWorksheet()

Das Arbeitsblatt, das die aktuelle PivotTable enthält.

getWorksheet(): Worksheet;

Gibt zurück

ExcelScript.Worksheet

refresh()

Aktualisiert die PivotTable.

refresh(): void;

Gibt zurück

void

removeColumnHierarchy(rowColumnPivotHierarchy)

Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.

removeColumnHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Parameter

rowColumnPivotHierarchy

ExcelScript.RowColumnPivotHierarchy

Gibt zurück

void

removeDataHierarchy(DataPivotHierarchy)

Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.

removeDataHierarchy(DataPivotHierarchy: DataPivotHierarchy): void;

Parameter

DataPivotHierarchy

ExcelScript.DataPivotHierarchy

Gibt zurück

void

removeFilterHierarchy(filterPivotHierarchy)

Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.

removeFilterHierarchy(filterPivotHierarchy: FilterPivotHierarchy): void;

Parameter

filterPivotHierarchy

ExcelScript.FilterPivotHierarchy

Gibt zurück

void

removeRowHierarchy(rowColumnPivotHierarchy)

Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.

removeRowHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Parameter

rowColumnPivotHierarchy

ExcelScript.RowColumnPivotHierarchy

Gibt zurück

void

setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)

Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilter auf einem bestimmten PivotField in der Tabelle zulässt.

setAllowMultipleFiltersPerField(
            allowMultipleFiltersPerField: boolean
        ): void;

Parameter

allowMultipleFiltersPerField

boolean

Gibt zurück

void

setEnableDataValueEditing(enableDataValueEditing)

Gibt an, ob die PivotTable das Bearbeiten von Werten im Datentext durch den Benutzer zulässt.

setEnableDataValueEditing(enableDataValueEditing: boolean): void;

Parameter

enableDataValueEditing

boolean

Gibt zurück

void

setName(name)

Der Name der PivotTable.

setName(name: string): void;

Parameter

name

string

Gibt zurück

void

setUseCustomSortLists(useCustomSortLists)

Gibt an, ob die PivotTable beim Sortieren benutzerdefinierte Listen verwendet.

setUseCustomSortLists(useCustomSortLists: boolean): void;

Parameter

useCustomSortLists

boolean

Gibt zurück

void