Excel.SlicerItem class

Paket:

excel

Stellt ein Slicerelement in einem Slicer dar.

Extends

OfficeExtension.ClientObject

Hinweise

API-Satz: ExcelApi 1.10

Verwendet von

• Excel.SlicerItemCollection: getItem, getItemAt, getItemOrNullObject, Elemente

Eigenschaften

context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
hasData	Wert ist true , wenn das Slicerelement Daten enthält.
isSelected	Wert ist true , ob das Slicerelement ausgewählt ist. Wenn Sie diesen Wert festlegen, wird der ausgewählte Status anderer Slicerelemente nicht gelöscht. Wenn das Slicerelement standardmäßig als einziges Element ausgewählt ist, werden beim Aufheben der Auswahl alle Elemente ausgewählt.
key	Stellt den eindeutigen Wert dar, der für das Datenschnittelement steht.
name	Stellt den Titel dar, der in der Excel-Benutzeroberfläche angezeigt wird.

Methoden

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(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(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.
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 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.SlicerItem Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.SlicerItemData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

hasData

Wert ist true , wenn das Slicerelement Daten enthält.

readonly hasData: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.10

isSelected

Wert ist true , ob das Slicerelement ausgewählt ist. Wenn Sie diesen Wert festlegen, wird der ausgewählte Status anderer Slicerelemente nicht gelöscht. Wenn das Slicerelement standardmäßig als einziges Element ausgewählt ist, werden beim Aufheben der Auswahl alle Elemente ausgewählt.

isSelected: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.10

key

Stellt den eindeutigen Wert dar, der für das Datenschnittelement steht.

readonly key: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.10

name

Stellt den Titel dar, der in der Excel-Benutzeroberfläche angezeigt wird.

readonly name: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.10

Details zur Methode

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.SlicerItemLoadOptions): Excel.SlicerItem;

Parameter

options

Excel.Interfaces.SlicerItemLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Excel.SlicerItem

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.SlicerItem

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

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.SlicerItem

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

Parameter

properties

Excel.Interfaces.SlicerItemUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options

OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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.SlicerItem): void;

Parameter

properties

Excel.SlicerItem

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 sie übergeben wird.) Während das ursprüngliche Excel.SlicerItem Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.SlicerItemData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.SlicerItemData;

Gibt zurück

Excel.Interfaces.SlicerItemData