Excel.Slicer class
Stellt ein Slicer -Objekt in der Arbeitsmappe dar.
- Extends
Hinweise
Eigenschaften
| caption | Stellt den Untertitel des Datenschnitts dar. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| height | Stellt die Höhe des Datenschnitts in typografischen Punkten dar. Löst eine Ausnahme aus |
| id | Stellt die eindeutige ID des Slicers dar. |
| is |
Der Wert ist |
| left | Stellt den Abstand in Punkt von der linken Seite des Datenschnitts zur linken Seite des Arbeitsblatts dar. Löst einen Fehler aus |
| name | Stellt den Namen des Datenschnitts dar. |
| slicer |
Stellt die Auflistung von Slicerelementen dar, die Teil des Datenschnitts sind. |
| sort |
Stellt die Sortierreihenfolge der Elemente im Datenschnitt dar. Mögliche Werte sind: "DataSourceOrder", "Ascending", "Descending". |
| style | Konstanter Wert, der das Slicerformat darstellt. Mögliche Werte sind: "SlicerStyleLight1" bis "SlicerStyleLight6", "TableStyleOther1" bis "TableStyleOther2", "SlicerStyleDark1" bis "SlicerStyleDark6". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden. |
| top | Stellt den Abstand in Punkt von der Oberkante des Datenschnitts zur Oberkante des Arbeitsblatts dar. Löst einen Fehler aus |
| width | Die Breite des Datenschnitts in Punkten. Löst einen Fehler aus |
| worksheet | Stellt das Arbeitsblatt dar, das den Datenschnitt enthält. |
Methoden
| clear |
Löscht alle Filter, die derzeit für den Datenschnitt verwendet werden. |
| delete() | Löscht den Datenschnitt. |
| get |
Gibt ein Array mit den Schlüsseln der ausgewählten Elemente zurück. |
| 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 " |
| select |
Wählt Slicerelemente basierend auf ihren Schlüsseln aus. Die vorherige Auswahl ist deaktiviert. Alle Elemente werden standardmäßig ausgewählt, wenn das Array leer ist. |
| 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. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
caption
Stellt den Untertitel des Datenschnitts dar.
caption: string;Eigenschaftswert
string
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
height
Stellt die Höhe des Datenschnitts in typografischen Punkten dar. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.
height: number;Eigenschaftswert
number
Hinweise
id
Stellt die eindeutige ID des Slicers dar.
readonly id: string;Eigenschaftswert
string
Hinweise
isFilterCleared
Der Wert ist true , wenn alle Filter, die derzeit auf den Slicer angewendet werden, gelöscht werden.
readonly isFilterCleared: boolean;Eigenschaftswert
boolean
Hinweise
left
Stellt den Abstand in Punkt von der linken Seite des Datenschnitts zur linken Seite des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.
left: number;Eigenschaftswert
number
Hinweise
name
Stellt den Namen des Datenschnitts dar.
name: string;Eigenschaftswert
string
Hinweise
slicerItems
Stellt die Auflistung von Slicerelementen dar, die Teil des Datenschnitts sind.
readonly slicerItems: Excel.SlicerItemCollection;Eigenschaftswert
Hinweise
sortBy
Stellt die Sortierreihenfolge der Elemente im Datenschnitt dar. Mögliche Werte sind: "DataSourceOrder", "Ascending", "Descending".
sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";Eigenschaftswert
Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"
Hinweise
style
Konstanter Wert, der das Slicerformat darstellt. Mögliche Werte sind: "SlicerStyleLight1" bis "SlicerStyleLight6", "TableStyleOther1" bis "TableStyleOther2", "SlicerStyleDark1" bis "SlicerStyleDark6". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.
style: string;Eigenschaftswert
string
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const slicer = context.workbook.slicers.getItem("Fruit Slicer");
slicer.style = "SlicerStyleLight6";
await context.sync();
});
top
Stellt den Abstand in Punkt von der Oberkante des Datenschnitts zur Oberkante des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.
top: number;Eigenschaftswert
number
Hinweise
width
Die Breite des Datenschnitts in Punkten. Löst einen Fehler aus InvalidArgument , wenn mit einem negativen Wert oder null als Eingabe festgelegt wird.
width: number;Eigenschaftswert
number
Hinweise
worksheet
Stellt das Arbeitsblatt dar, das den Datenschnitt enthält.
readonly worksheet: Excel.Worksheet;Eigenschaftswert
Hinweise
Details zur Methode
clearFilters()
Löscht alle Filter, die derzeit für den Datenschnitt verwendet werden.
clearFilters(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const slicer = context.workbook.slicers.getItem("Fruit Slicer");
slicer.clearFilters();
await context.sync();
});
delete()
Löscht den Datenschnitt.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
sheet.slicers.getItemAt(0).delete();
await context.sync();
});
getSelectedItems()
Gibt ein Array mit den Schlüsseln der ausgewählten Elemente zurück.
getSelectedItems(): OfficeExtension.ClientResult<string[]>;Gibt zurück
OfficeExtension.ClientResult<string[]>
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.SlicerLoadOptions): Excel.Slicer;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.Slicer;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.Slicer;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
selectItems(items)
Wählt Slicerelemente basierend auf ihren Schlüsseln aus. Die vorherige Auswahl ist deaktiviert. Alle Elemente werden standardmäßig ausgewählt, wenn das Array leer ist.
selectItems(items?: string[]): void;Parameter
- items
-
string[]
Optional. Die angegebenen Slicerelementnamen, die ausgewählt werden sollen.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const slicer = context.workbook.slicers.getItem("Fruit Slicer");
slicer.selectItems(["Lemon", "Lime", "Orange"]);
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.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.SlicerUpdateData
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.Slicer): void;Parameter
- properties
- Excel.Slicer
Gibt zurück
void
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.Slicer Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.SlicerData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.SlicerData;Gibt zurück
Office Add-ins