Excel. Pivot Layout class

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Set the alt text for the displayed PivotTable.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.altTextTitle = "Farm Sales PivotTable";
  pivotLayout.altTextDescription = "A summary of fruit sales. It is pivoted on farm name, and fruit type. The aggregated data is both the sums of crates sold at the farms and the sums of crates sold wholesale.";
  console.log("Adding alt text. Check the PivotTable settings to see the changes.");

  await context.sync();
});

altTextTitle

Der Alternativtexttitel der PivotTable.

altTextTitle: string;

Eigenschaftswert

string

Hinweise

autoFormat

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

autoFormat: boolean;

Eigenschaftswert

boolean

Hinweise

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

Excel.RequestContext

emptyCellText

Der Text, der automatisch in eine leere Zelle in der PivotTable gefüllt wird, wenn fillEmptyCells == true. Beachten Sie, dass dieser Wert beibehalten wird, wenn fillEmptyCells auf falsefestgelegt ist, und dass durch Festlegen dieses Werts diese Eigenschaft nicht auf truefestgelegt wird. Standardmäßig ist dies eine leere Zeichenfolge.

emptyCellText: string;

Eigenschaftswert

string

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Set a default value for an empty cell in the PivotTable. This doesn't include cells left blank by the layout.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.emptyCellText = "--";

  // Set the text alignment to match the rest of the PivotTable.
  pivotLayout.getDataBodyRange().format.horizontalAlignment = Excel.HorizontalAlignment.right;
  await context.sync();
});

enableFieldList

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

enableFieldList: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.10 ]

fillEmptyCells

Gibt an, ob leere Zellen in der PivotTable mit emptyCellTextaufgefüllt werden sollen. Der Standardwert ist false. Beachten Sie, dass der Wert von emptyCellText beibehalten wird, wenn diese Eigenschaft auf falsefestgelegt ist.

fillEmptyCells: boolean;

Eigenschaftswert

boolean

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Toggle whether empty cells are filled with a default value.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load("fillEmptyCells");
  await context.sync();

  let fillToSet = !pivotLayout.fillEmptyCells;
  console.log(`Filling empty cells? - ${fillToSet}`);

  pivotLayout.fillEmptyCells = fillToSet;
  await context.sync();
});

layoutType

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

layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

Eigenschaftswert

Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Change the PivotLayout.type to a new type.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
  pivotTable.layout.load("layoutType");
  await context.sync();

  // Cycle between the three layout types.
  if (pivotTable.layout.layoutType === "Compact") {
    pivotTable.layout.layoutType = "Outline";
  } else if (pivotTable.layout.layoutType === "Outline") {
    pivotTable.layout.layoutType = "Tabular";
  } else {
    pivotTable.layout.layoutType = "Compact";
  }

  await context.sync();
  console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});

pivotStyle

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die auf die PivotTable angewendete Formatvorlage.

readonly pivotStyle: Excel.PivotTableStyle;

Eigenschaftswert

Excel.PivotTableStyle

Hinweise

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.

preserveFormatting: boolean;

Eigenschaftswert

boolean

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Set whether the PivotTable keeps the established format after it is refreshed and recalculated.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load("preserveFormatting");
  await context.sync();

  let preserveFormattingToSet = !pivotLayout.preserveFormatting;
  console.log(`Preserve the formatting PivotTable after a refresh? - ${preserveFormattingToSet}`);

  pivotLayout.preserveFormatting = preserveFormattingToSet;
  await context.sync();
});

showColumnGrandTotals

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

showColumnGrandTotals: boolean;

Eigenschaftswert

boolean

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

showFieldHeaders

Gibt an, ob die PivotTable Feldüberschriften (Feldbeschriftungen und Filter-Dropdowns) anzeigt.

showFieldHeaders: boolean;

Eigenschaftswert

boolean

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Turn the field headers on and off for the row and column hierarchies.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;
  pivotLayout.load("showFieldHeaders");
  await context.sync();

  let showHeaders = !pivotLayout.showFieldHeaders;
  console.log(`Show field headers? - ${showHeaders}`);
  pivotLayout.showFieldHeaders = showHeaders;
  await context.sync();
});

showRowGrandTotals

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

showRowGrandTotals: boolean;

Eigenschaftswert

boolean

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

subtotalLocation

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

subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

Eigenschaftswert

Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"

Hinweise

Details zur Methode

displayBlankLineAfterEachItem(display)

Legt fest, ob nach jedem Element eine Leerzeile angezeigt werden soll. Dies wird auf globaler Ebene für die PivotTable festgelegt und auf einzelne PivotFields angewendet. Diese Funktion überschreibt die Einstellung für alle Felder in der PivotTable auf den Wert des display Parameters.

displayBlankLineAfterEachItem(display: boolean): void;

Parameter

display: boolean

True aktiviert die Einstellung für die Leerzeilenanzeige. False deaktiviert sie.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Add a blank row after each PivotItem in the row hierarchy.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.displayBlankLineAfterEachItem(true);
  console.log("Setting `PivotLayout.displayBlankLineAfterEachItem` to true.");

  await context.sync();
});

getCell(dataHierarchy, rowItems, columnItems)

Hinweis

Ruft eine eindeutige Zelle in der PivotTable ab, die auf einer Datenhierarchie und den Zeilen- und Spaltenelementen ihrer jeweiligen Hierarchie basiert. Die zurückgegebene Zelle ist der Schnittpunkt der angegebenen Zeile und Spalte, welche die Daten aus der angegebenen Hierarchie enthält. Diese Methode ist die Umkehrung des Aufrufs getPivotItems von und getDataHierarchy für eine bestimmte Zelle.

getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>): Excel.Range;

Parameter

dataHierarchy: Excel.DataPivotHierarchy | string

Die dataHierarchy , die das zu suchde Datenelement bereitstellt.

rowItems: Array<Excel.PivotItem | string>

Die PivotItems aus der Zeilenachse, aus der der gesuchte Wert besteht.

columnItems: Array<Excel.PivotItem | string>

Die PivotItems aus der Spaltenachse, aus der der gesuchte Wert besteht.

Gibt zurück

Excel.Range

Ein Bereich, der eine einzelne Zelle angibt, die den angegebenen Wert enthält.

Hinweise

getColumnLabelRange()

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

getColumnLabelRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

    // The layout controls the ranges used by the PivotTable.
    const range = pivotTable.layout.getDataBodyRange();

    // Get all the data hierarchy totals.
    const grandTotalRange = range.getLastRow();
    grandTotalRange.load("address");
    await context.sync();
    
    // Use the wholesale and farm sale totals to make a final sum.
    const masterTotalRange = context.workbook.worksheets.getActiveWorksheet().getRange("B27:C27");
    masterTotalRange.formulas = [["All Crates", "=SUM(" + grandTotalRange.address + ")"]];
    await context.sync();
});

getDataHierarchy(cell)

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

getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;

Parameter

cell: Excel.Range | string

Eine einzelne Zelle innerhalb des PivotTable-Datentexts.

Gibt zurück

Excel.DataPivotHierarchy

Das DataPivotHierarchy-Objekt, das zum Berechnen des Werts in der angegebenen Zelle verwendet wird.

Hinweise

getFilterAxisRange()

Gibt den Bereich des Filterbereichs von PivotTable zurück.

getFilterAxisRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

getPivotItems(axis, cell)

Ruft die PivotItems von einer Achse ab, die den Wert in einem angegebenen Bereich innerhalb der PivotTable bilden.

getPivotItems(axis: Excel.PivotAxis, cell: Range | string): Excel.PivotItemCollection;

Parameter

axis: Excel.PivotAxis

Die Achse, von der die PivotItems abgerufen werden sollen. Muss entweder "Zeile" oder "Spalte" sein.

cell: Excel.Range | string

Eine einzelne Zelle im Datentext der PivotTable.

Gibt zurück

Excel.PivotItemCollection

Eine PivotItemCollection der PivotItems, die zum Berechnen der Werte in der angegebenen Zeile verwendet werden.

Hinweise

getPivotItems(axisString, cell)

Ruft die PivotItems von einer Achse ab, die den Wert in einem angegebenen Bereich innerhalb der PivotTable bilden.

getPivotItems(axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection;

Parameter

axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter"

Die Achse, von der die PivotItems abgerufen werden sollen. Muss entweder "Zeile" oder "Spalte" sein.

cell: Excel.Range | string

Eine einzelne Zelle im Datentext der PivotTable.

Gibt zurück

Excel.PivotItemCollection

Eine PivotItemCollection der PivotItems, die zum Berechnen der Werte in der angegebenen Zeile verwendet werden.

Hinweise

getRange()

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

getRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

getRowLabelRange()

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

getRowLabelRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

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.PivotLayoutLoadOptions): Excel.PivotLayout;

Parameter

options: Excel.Interfaces.PivotLayoutLoadOptions

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

Gibt zurück

Excel.PivotLayout

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.PivotLayout;

Parameter

propertyNames: string | string[]

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

Gibt zurück

Excel.PivotLayout

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.PivotLayout;

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

Excel.PivotLayout

repeatAllItemLabels(repeatLabels)

Legt die Einstellung "Alle Elementbeschriftungen wiederholen" für alle Felder in der PivotTable fest.

repeatAllItemLabels(repeatLabels: boolean): void;

Parameter

repeatLabels: boolean

True aktiviert die Anzeigeeinstellung für die Bezeichnungswieholung. False deaktiviert sie.

Gibt zurück

void

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Repeat the PivotItem labels for each row used by another level of the row hierarchy.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.repeatAllItemLabels(true);
  console.log("Setting `PivotLayout.repeatAllItemLabels` to true.");

  await context.sync();
});

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.PivotLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Excel.Interfaces.PivotLayoutUpdateData

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

Parameter

properties: Excel.PivotLayout

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

Parameter

cell: Excel.Range | string

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

sortBy: Excel.SortBy

Die Richtung der Sortierung.

Gibt zurück

void

Hinweise

setAutoSortOnCell(cell, sortByString)

setAutoSortOnCell(cell: Range | string, sortByString: "Ascending" | "Descending"): void;

Parameter

cell: Excel.Range | string

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

sortByString: "Ascending" | "Descending"

Die Richtung der Sortierung.

Gibt zurück

void

Hinweise