Excel.PivotLayout class

Die Alternativtextbeschreibung der PivotTable.

Alternativtext stellt alternative, textbasierte Darstellungen der in der PivotTable enthaltenen Informationen bereit. Diese Informationen sind nützlich für Personen mit Seh- oder kognitiven Beeinträchtigungen, die die Tabelle möglicherweise nicht sehen oder verstehen können. Ein Titel kann einer Person mit einer Behinderung vorgelesen werden und wird verwendet, um festzustellen, ob sie die Beschreibung des Inhalts hören möchte.

altTextDescription: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.13

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

Der Alternativtexttitel der PivotTable.

Alternativtext stellt alternative, textbasierte Darstellungen der in der PivotTable enthaltenen Informationen bereit. Diese Informationen sind nützlich für Personen mit Seh- oder kognitiven Beeinträchtigungen, die die Tabelle möglicherweise nicht sehen oder verstehen können. Ein Titel kann einer Person mit einer Behinderung vorgelesen werden und wird verwendet, um festzustellen, ob sie die Beschreibung des Inhalts hören möchte.

altTextTitle: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.13

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

autoFormat: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

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 er auffalse festgelegt ist, und dass das Festlegen dieses Werts diese Eigenschaft nicht auf truesetzt. Standardmäßig ist dies eine leere Zeichenfolge.

emptyCellText: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.13

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

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

enableFieldList: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.10

Gibt an, ob leere Zellen in der PivotTable mit dem 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

Hinweise

API-Satz: ExcelApi 1.13

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

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

Hinweise

API-Satz: ExcelApi 1.8

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

Die Formatvorlage, die auf die PivotTable angewendet wird.

readonly pivotStyle: Excel.PivotTableStyle;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

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

Hinweise

API-Satz: ExcelApi 1.9

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

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

showColumnGrandTotals: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.8

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

Gibt an, ob in der PivotTable Feldüberschriften (Feldbeschriftungen und Dropdownlisten) angezeigt werden.

showFieldHeaders: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.13

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

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

showRowGrandTotals: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.8

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

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

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

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.8

Legt fest, ob nach jedem Element eine leere Zeile 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 mit dem Wert von display Parameter.

displayBlankLineAfterEachItem(display: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

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

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 auf eine bestimmte Zelle.

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

Parameter

Gibt zurück

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

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

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

getColumnLabelRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.8

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

getDataBodyRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.8

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

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

Gibt zurück

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

Hinweise

API-Satz: ExcelApi 1.9

Gibt den Bereich des Filterbereichs von PivotTable zurück.

getFilterAxisRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.8

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

Gibt zurück

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

Hinweise

API-Satz: ExcelApi 1.9

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

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

Parameter

Gibt zurück

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

Hinweise

API-Satz: ExcelApi 1.9

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

getRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.8

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

getRowLabelRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.8

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

repeatAllItemLabels(repeatLabels: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

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

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

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.PivotLayout): void;

Parameter

Gibt zurück

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

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

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: "Ascending" | "Descending"): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Legt die Formatvorlage fest, die auf die PivotTable angewendet wird.

setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.PivotLayout Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.PivotLayoutData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.PivotLayoutData;

Gibt zurück