ExcelScript.PivotLayout interface

Paket:

ExcelScript

Stellt das visuelle Layout der PivotTable dar.

Methoden

getAutoFormat()	Gibt an, ob die Formatierung automatisch formatiert wird, wenn sie aktualisiert wird oder wenn Felder verschoben werden.
getBodyAndTotalRange()	Gibt den Bereich zurück, in dem sich die Datenwerte in PivotTable befinden.
getColumnLabelRange()	Gibt den Bereich zurück, in dem sich die Spaltenbeschriftungen in PivotTable befinden.
getDataHierarchy(cell)	Ruft die DataHierarchy ab, die zum Berechnen des Werts in einem angegebenen Bereich innerhalb der PivotTable verwendet wird.
getEnableFieldList()	Gibt an, ob die Feldliste auf der Benutzeroberfläche angezeigt werden kann.
getFilterAxisRange()	Gibt den Bereich des Filterbereichs von PivotTable zurück.
getLayoutType()	Diese Eigenschaft gibt das PivotLayoutType-Objekt aller Felder in PivotTable an. Wenn Felder verschiedenen Status aufweisen, lautet dies NULL.
getPreserveFormatting()	Gibt an, ob die Formatierung beibehalten wird, wenn der Bericht durch Vorgänge wie Pivotieren, Sortieren oder Ändern von Seitenfeldelementen aktualisiert oder neu berechnet wird.
getRange()	Gibt den Bereich an, in dem PivotTable vorhanden ist, mit Ausnahme des Filterbereichs.
getRowLabelRange()	Gibt den Bereich zurück, in dem sich die Zeilenbeschriftungen in PivotTable befinden.
getShowColumnGrandTotals()	Gibt an, ob der PivotTable-Bericht Gesamtsummen für Spalten anzeigt.
getShowRowGrandTotals()	Gibt an, ob der PivotTable-Bericht Gesamtsummen für Zeilen anzeigt.
getSubtotalLocation()	Diese Eigenschaft gibt die SubtotalLocationType aller Felder in der PivotTable an. Wenn Felder unterschiedliche Zustände aufweisen, ist nulldies .
setAutoFormat(autoFormat)	Gibt an, ob die Formatierung automatisch formatiert wird, wenn sie aktualisiert wird oder wenn Felder verschoben werden.
setAutoSortOnCell(cell, sortBy)	Legt fest, dass die PivotTable automatisch nach der angegebenen Zelle sortiert, um automatisch alle notwendigen Kriterien und den Kontext auszuwählen. Dies verhält sich identisch wie das Anwenden eines Autosortes aus der Benutzeroberfläche.
setEnableFieldList(enableFieldList)	Gibt an, ob die Feldliste auf der Benutzeroberfläche angezeigt werden kann.
setLayoutType(layoutType)	Diese Eigenschaft gibt das PivotLayoutType-Objekt aller Felder in PivotTable an. Wenn Felder verschiedenen Status aufweisen, lautet dies NULL.
setPreserveFormatting(preserveFormatting)	Gibt an, ob die Formatierung beibehalten wird, wenn der Bericht durch Vorgänge wie Pivotieren, Sortieren oder Ändern von Seitenfeldelementen aktualisiert oder neu berechnet wird.
setShowColumnGrandTotals(showColumnGrandTotals)	Gibt an, ob der PivotTable-Bericht Gesamtsummen für Spalten anzeigt.
setShowRowGrandTotals(showRowGrandTotals)	Gibt an, ob der PivotTable-Bericht Gesamtsummen für Zeilen anzeigt.
setSubtotalLocation(subtotalLocation)	Diese Eigenschaft gibt die SubtotalLocationType aller Felder in der PivotTable an. Wenn Felder unterschiedliche Zustände aufweisen, ist nulldies .

Details zur Methode

getAutoFormat()

Gibt an, ob die Formatierung automatisch formatiert wird, wenn sie aktualisiert wird oder wenn Felder verschoben werden.

getAutoFormat(): boolean;

Gibt zurück

boolean

getBodyAndTotalRange()

Gibt den Bereich zurück, in dem sich die Datenwerte in PivotTable befinden.

getBodyAndTotalRange(): Range;

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  let pivotTable = workbook.getPivotTables()[0];

  // Get the names of each data column in the PivotTable.
  let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();

  // Get the range displaying the pivoted data.
  let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();

  // Get the range with the "grand totals" for the PivotTable columns.
  let grandTotalRange = pivotDataRange.getLastRow();

  // Print each of the "Grand Totals" to the console.
  grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
    console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
    // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
  });
}

getColumnLabelRange()

Gibt den Bereich zurück, in dem sich die Spaltenbeschriftungen in PivotTable befinden.

getColumnLabelRange(): Range;

Gibt zurück

ExcelScript.Range

getDataHierarchy(cell)

Ruft die DataHierarchy ab, die zum Berechnen des Werts in einem angegebenen Bereich innerhalb der PivotTable verwendet wird.

getDataHierarchy(cell: Range | string): DataPivotHierarchy;

Parameter

cell

ExcelScript.Range | string

Eine einzelne Zelle innerhalb des PivotTable-Datentexts.

Gibt zurück

ExcelScript.DataPivotHierarchy

getEnableFieldList()

Gibt an, ob die Feldliste auf der Benutzeroberfläche angezeigt werden kann.

getEnableFieldList(): boolean;

Gibt zurück

boolean

getFilterAxisRange()

Gibt den Bereich des Filterbereichs von PivotTable zurück.

getFilterAxisRange(): Range;

Gibt zurück

ExcelScript.Range

getLayoutType()

Diese Eigenschaft gibt das PivotLayoutType-Objekt aller Felder in PivotTable an. Wenn Felder verschiedenen Status aufweisen, lautet dies NULL.

getLayoutType(): PivotLayoutType;

Gibt zurück

ExcelScript.PivotLayoutType

getPreserveFormatting()

Gibt an, ob die Formatierung beibehalten wird, wenn der Bericht durch Vorgänge wie Pivotieren, Sortieren oder Ändern von Seitenfeldelementen aktualisiert oder neu berechnet wird.

getPreserveFormatting(): boolean;

Gibt zurück

boolean

getRange()

Gibt den Bereich an, in dem PivotTable vorhanden ist, mit Ausnahme des Filterbereichs.

getRange(): Range;

Gibt zurück

ExcelScript.Range

getRowLabelRange()

Gibt den Bereich zurück, in dem sich die Zeilenbeschriftungen in PivotTable befinden.

getRowLabelRange(): Range;

Gibt zurück

ExcelScript.Range

getShowColumnGrandTotals()

Gibt an, ob der PivotTable-Bericht Gesamtsummen für Spalten anzeigt.

getShowColumnGrandTotals(): boolean;

Gibt zurück

boolean

getShowRowGrandTotals()

Gibt an, ob der PivotTable-Bericht Gesamtsummen für Zeilen anzeigt.

getShowRowGrandTotals(): boolean;

Gibt zurück

boolean

getSubtotalLocation()

Diese Eigenschaft gibt die SubtotalLocationType aller Felder in der PivotTable an. Wenn Felder unterschiedliche Zustände aufweisen, ist nulldies .

getSubtotalLocation(): SubtotalLocationType;

Gibt zurück

ExcelScript.SubtotalLocationType

setAutoFormat(autoFormat)

Gibt an, ob die Formatierung automatisch formatiert wird, wenn sie aktualisiert wird oder wenn Felder verschoben werden.

setAutoFormat(autoFormat: boolean): void;

Parameter

autoFormat

boolean

Gibt zurück

void

setAutoSortOnCell(cell, sortBy)

Legt fest, dass die PivotTable automatisch nach der angegebenen Zelle sortiert, um automatisch alle notwendigen Kriterien und den Kontext auszuwählen. Dies verhält sich identisch wie das Anwenden eines Autosortes aus der Benutzeroberfläche.

setAutoSortOnCell(cell: Range | string, sortBy: SortBy): void;

Parameter

cell

ExcelScript.Range | string

Eine einzelne Zelle, die verwendet werden soll, ruft die Kriterien für die Anwendung der automatischen Sortierung ab.

sortBy

ExcelScript.SortBy

Die Richtung der Sortierung.

Gibt zurück

void

setEnableFieldList(enableFieldList)

Gibt an, ob die Feldliste auf der Benutzeroberfläche angezeigt werden kann.

setEnableFieldList(enableFieldList: boolean): void;

Parameter

enableFieldList

boolean

Gibt zurück

void

setLayoutType(layoutType)

Diese Eigenschaft gibt das PivotLayoutType-Objekt aller Felder in PivotTable an. Wenn Felder verschiedenen Status aufweisen, lautet dies NULL.

setLayoutType(layoutType: PivotLayoutType): void;

Parameter

layoutType

ExcelScript.PivotLayoutType

Gibt zurück

void

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

setPreserveFormatting(preserveFormatting)

Gibt an, ob die Formatierung beibehalten wird, wenn der Bericht durch Vorgänge wie Pivotieren, Sortieren oder Ändern von Seitenfeldelementen aktualisiert oder neu berechnet wird.

setPreserveFormatting(preserveFormatting: boolean): void;

Parameter

preserveFormatting

boolean

Gibt zurück

void

setShowColumnGrandTotals(showColumnGrandTotals)

Gibt an, ob der PivotTable-Bericht Gesamtsummen für Spalten anzeigt.

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

Parameter

showColumnGrandTotals

boolean

Gibt zurück

void

setShowRowGrandTotals(showRowGrandTotals)

Gibt an, ob der PivotTable-Bericht Gesamtsummen für Zeilen anzeigt.

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

Parameter

showRowGrandTotals

boolean

Gibt zurück

void

setSubtotalLocation(subtotalLocation)

Diese Eigenschaft gibt die SubtotalLocationType aller Felder in der PivotTable an. Wenn Felder unterschiedliche Zustände aufweisen, ist nulldies .

setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;

Parameter

subtotalLocation

ExcelScript.SubtotalLocationType

Gibt zurück

void

Beispiele

/**
 * This script displays group subtotals of the "Farms Sales" PivotTable.
 */
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();

  // Show all the subtotals at the bottom of each group.
  layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}