Excel.SlicerCollection class
Stellt eine Auflistung aller Slicerobjekte in der Arbeitsmappe oder einem Arbeitsblatt dar.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(slicer |
Fügt der Arbeitsmappe einen neuen Datenschnitt hinzu. |
| get |
Gibt die Anzahl der Datenschnitte in der Sammlung zurück. |
| get |
Ruft ein Slicerobjekt unter Verwendung seines Namens oder seiner ID ab. |
| get |
Ruft einen Datenschnitt anhand seiner Position in der Auflistung ab. |
| get |
Ruft einen Datenschnitt unter Verwendung seines Namens oder seiner ID ab. Wenn der Slicer nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
| 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 " |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
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
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.Slicer[];Eigenschaftswert
Details zur Methode
add(slicerSource, sourceField, slicerDestination)
Fügt der Arbeitsmappe einen neuen Datenschnitt hinzu.
add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer;Parameter
- slicerSource
-
string | Excel.PivotTable | Excel.Table
Die Datenquelle, auf der der neue Slicer basiert. Dabei kann es sich um ein PivotTable Objekt, ein Table Objekt oder eine Zeichenfolge handeln. Wenn ein PivotTable-Objekt übergeben wird, ist die Datenquelle die Quelle des PivotTable Objekts. Wenn ein Table Objekt übergeben wird, ist die Datenquelle das Table -Objekt. Wenn eine Zeichenfolge übergeben wird, wird sie als Name oder ID einer PivotTable oder Tabelle interpretiert.
- sourceField
-
string | Excel.PivotField | number | Excel.TableColumn
Das Feld in der Datenquelle, nach dem gefiltert werden soll. Dabei kann es sich um ein PivotField Objekt, ein TableColumn Objekt, die ID eines PivotField oder den Namen oder die ID eines handeln TableColumn.
- slicerDestination
-
string | Excel.Worksheet
Optional. Das Arbeitsblatt, in dem der neue Slicer erstellt wird. Es kann sich um ein Worksheet Objekt oder den Namen oder die ID eines Arbeitsblatts handeln. Dieser Parameter kann weggelassen werden, wenn die Slicerauflistung aus einem Arbeitsblatt abgerufen wird.
Gibt zurück
Der neue Slicer.
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.getItem("Pivot");
const slicer = sheet.slicers.add(
"Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
"Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
);
slicer.name = "Fruit Slicer";
await context.sync();
});
getCount()
Gibt die Anzahl der Datenschnitte in der Sammlung zurück.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItem(key)
Ruft ein Slicerobjekt unter Verwendung seines Namens oder seiner ID ab.
getItem(key: string): Excel.Slicer;Parameter
- key
-
string
Der Name oder die ID des Slicers.
Gibt zurück
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.caption = "Fruit Types";
slicer.left = 395;
slicer.top = 15;
slicer.height = 135;
slicer.width = 150;
await context.sync();
});
getItemAt(index)
Ruft einen Datenschnitt anhand seiner Position in der Auflistung ab.
getItemAt(index: number): Excel.Slicer;Parameter
- index
-
number
Index-Wert des abzurufenden Objekts. Nullindiziert.
Gibt zurück
Hinweise
getItemOrNullObject(key)
Ruft einen Datenschnitt unter Verwendung seines Namens oder seiner ID ab. Wenn der Slicer nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(key: string): Excel.Slicer;Parameter
- key
-
string
Name oder ID des abzurufenden Slicers.
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.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;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.SlicerCollection;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?: OfficeExtension.LoadOption): Excel.SlicerCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.SlicerCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.SlicerCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Excel.Interfaces.SlicerCollectionData;Gibt zurück
Office Add-ins