Excel.PivotLayout class
Stellt das visuelle Layout der PivotTable dar.
- Extends
Hinweise
Eigenschaften
| auto |
Gibt an, ob die Formatierung automatisch formatiert wird, wenn sie aktualisiert wird oder wenn Felder verschoben werden. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| enable |
Gibt an, ob die Feldliste auf der Benutzeroberfläche angezeigt werden kann. |
| layout |
Diese Eigenschaft gibt das PivotLayoutType-Objekt aller Felder in PivotTable an. Wenn Felder verschiedenen Status aufweisen, lautet dies NULL. |
| preserve |
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. |
| show |
Gibt an, ob der PivotTable-Bericht Gesamtsummen für Spalten anzeigt. |
| show |
Gibt an, ob der PivotTable-Bericht Gesamtsummen für Zeilen anzeigt. |
| subtotal |
Diese Eigenschaft gibt die |
Methoden
| get |
Gibt den Bereich zurück, in dem sich die Spaltenbeschriftungen in PivotTable befinden. |
| get |
Gibt den Bereich zurück, in dem sich die Datenwerte in PivotTable befinden. |
| get |
Ruft die DataHierarchy ab, die zum Berechnen des Werts in einem angegebenen Bereich innerhalb der PivotTable verwendet wird. |
| get |
Gibt den Bereich des Filterbereichs von PivotTable zurück. |
| get |
Ruft die PivotItems von einer Achse ab, die den Wert in einem angegebenen Bereich innerhalb der PivotTable bilden. |
| get |
Ruft die PivotItems von einer Achse ab, die den Wert in einem angegebenen Bereich innerhalb der PivotTable bilden. |
| get |
Gibt den Bereich an, in dem PivotTable vorhanden ist, mit Ausnahme des Filterbereichs. |
| get |
Gibt den Bereich zurück, in dem sich die Zeilenbeschriftungen in PivotTable befinden. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| set |
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. |
| set |
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. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
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
enableFieldList
Gibt an, ob die Feldliste auf der Benutzeroberfläche angezeigt werden kann.
enableFieldList: boolean;Eigenschaftswert
boolean
Hinweise
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
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);
});
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();
});
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
getColumnLabelRange()
Gibt den Bereich zurück, in dem sich die Spaltenbeschriftungen in PivotTable befinden.
getColumnLabelRange(): Excel.Range;Gibt zurück
Hinweise
getDataBodyRange()
Gibt den Bereich zurück, in dem sich die Datenwerte in PivotTable befinden.
getDataBodyRange(): Excel.Range;Gibt zurück
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
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
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
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
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
Hinweise
getRowLabelRange()
Gibt den Bereich zurück, in dem sich die Zeilenbeschriftungen in PivotTable befinden.
getRowLabelRange(): Excel.Range;Gibt zurück
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
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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
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
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)
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, 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
toJSON()
Ü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 das Objekt übergeben wird.) Während das ursprüngliche Excel.PivotLayout Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.PivotLayoutData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.PivotLayoutData;Gibt zurück
Office Add-ins