Excel JavaScript-Vorschau-APIs

Neue JavaScript-APIs für Excel werden zuerst als Vorschau eingeführt und werden später Teil eines bestimmten nummerierten Anforderungssatzes, nachdem sie ausreichend getestet wurden und Feedback von Benutzern gesammelt wurde.

Hinweis

Vorschau-APIs unterliegen Änderungen und können nicht für den Einsatz in Produktionsumgebungen vorgesehen werden. Wir empfehlen, sie nur in Test- und Entwicklungsumgebungen auszuprobieren. Verwenden Sie Vorschau-APIs nicht in einer Produktionsumgebung oder in unternehmenswichtigen Dokumenten.

So verwenden Sie Vorschau-APIs:

  • Sie müssen die Vorschauversion der Office JavaScript-API-Bibliothek aus dem Office.js Content Delivery Network (CDN) verwenden. Die Typdefinitionsdatei für die TypeScript-Kompilierung und IntelliSense finden Sie unter CDN und DefinitelyTyped. Sie können diese Typen mit npm install --save-dev @types/office-js-preview installieren (achten Sie darauf, die Typen @types/office-js zu entfernen, wenn Sie sie zuvor installiert haben).
  • Möglicherweise müssen Sie dem Microsoft 365 Insider-Programm beitreten, um auf neuere Office-Builds zugreifen zu können.

API-Liste

In der folgenden Tabelle sind die Excel-JavaScript-APIs aufgeführt, die sich derzeit in der Vorschau befinden. Eine vollständige Liste aller Excel-JavaScript-APIs (einschließlich Vorschau-APIs und zuvor veröffentlichter APIs) finden Sie unter Alle Excel-JavaScript-APIs.

Klasse Felder Beschreibung
Base64EncodedImage data Die Base64-codierte Zeichenfolge.
type Der Dateityp des Base64-codierten Bildes.
BusyErrorCellValue previousValue Optional ist ein #BUSY! speichern möglicherweise den vorherigen Wert, der in der Zelle gespeichert war, bevor der aktuelle vorübergehende Vorgang begann.
Chart getDataRange() Ruft die Datenquelle des gesamten Diagramms ab.
getDataRangeOrNullObject() Ruft die Datenquelle des gesamten Diagramms ab.
EntityArrayCardLayout arrayProperty Stellt den Namen der Eigenschaft dar, die das auf der Karte angezeigte Array enthält.
columnsToReport Stellt die Anzahl der Spalten dar, die die Karte für das Array beansprucht.
displayName Stellt den Namen der Eigenschaft dar, die das auf der Karte angezeigte Array enthält.
firstRowIsHeader Gibt an, ob die erste Zeile der Matrix als Überschrift behandelt wird.
Aufteilung Stellt den Typ dieses Layouts dar.
rowsToReport Stellt die Anzahl der Zeilen dar, die die Karte für sich im Array beansprucht.
ExternalCodeServiceObjectCellValue Python_str Stellt die Ausgabe der str() Funktion dar, wenn sie für dieses Objekt verwendet wird.
Python_type Stellt den vollständigen Typnamen dieses Objekts dar.
Python_typeName Stellt den Kurztypnamen dieses Objekts dar.
basicType Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.valueTypes würde.
basicValue Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.values würde.
language Stellt die Laufzeitsprache dieses externen Codediensts dar.
Vorschau Stellt den in der Zelle angezeigten Vorschauwert dar.
Anbieter Stellt Informationen über den Dienst dar, der die Daten in diesem ExternalCodeServiceObjectCellValue.
type Stellt den Typ dieses Zellwerts dar.
LocalImageCellValue altText Stellt den Alternativtext dar, der in Barrierefreiheitsszenarien verwendet wird, um zu beschreiben, was das Bild darstellt.
Namensnennung Stellt Zuordnungsinformationen dar, um die Quelle und die Lizenzanforderungen für dieses Bild zu beschreiben.
basicType Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.valueTypes würde.
basicValue Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.values würde.
image Stellt das Bild selbst dar, entweder zwischengespeichert oder codiert.
Anbieter Stellt Informationen dar, die die Entität oder Person beschreiben, die das Bild bereitgestellt hat.
type Stellt den Typ dieses Zellwerts dar.
LocalImageCellValueCacheId cachedUid Stellt die UID des Bildes dar, wie sie im Cache angezeigt wird.
NameErrorCellValue errorSubType Stellt den Typ von NameErrorCellValuedar.
NamedSheetViewCollection getItemOrNullObject(key: string) Ruft eine Tabellenansicht unter Verwendung ihres Namens ab.
NotAvailableErrorCellValue errorSubType Stellt den Typ von NotAvailableErrorCellValuedar.
PythonErrorCellValue basicType Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.valueTypes würde.
basicValue Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.values würde.
duringInitialization Gibt an, dass dieser #PYTHON! Fehler auf den Initialisierungs-Python-Code der Arbeitsmappe zurückzuführen ist (und nicht auf eine Zellenformel auf dem Arbeitsblatt).
errorType Stellt den Typ von ErrorCellValuedar.
type Stellt den Typ dieses Zellwerts dar.
RequestContext sensitivityLabelsCatalog [API-Satz: ExcelApi BETA (NUR VORSCHAU)]
setInvocation(invocation: { invocationId: number isInSyncExecution: boolean })
SensitivityLabel getCurrentOrNullObject() Ruft die aktuellen Bezeichnungsinformationen ab, die in der Arbeitsmappe für den Benutzer vorhanden sind.
tryToUpdate(labelId: string, options?: Excel.SensitivityLabelTryUpdateOptions) Versucht, auf die für den Benutzer bereitgestellte Vertraulichkeitsbezeichnung in der Arbeitsmappe zu aktualisieren.
SensitivityLabelAbacAttribute dataType Ruft den Datentyp des ABAC-Attributs ab.
displayName Ruft den Anzeigenamen des ABAC-Attributs ab.
displayOrder Ruft die empfohlene Reihenfolge dieses ABAC-Attributs ab, wenn es einem Benutzer angezeigt wird.
isActive Ruft ab, ob dieses ABAC-Attribut aktiv ist.
isMultiValued Ruft ab, ob mehr als ein Wert für dieses ABAC-Attribut ausgewählt werden kann.
values Ruft die Werte ab, die für dieses ABAC-Attribut ausgewählt werden können.
SensitivityLabelAbacAttributeValue displayName Ruft den Anzeigenamen des ABAC-Attributwerts ab.
displayOrder Ruft die empfohlene Reihenfolge dieses ABAC-Werts innerhalb seines Attributs ab, wenn er einem Benutzer angezeigt wird.
id Ruft den eindeutigen Bezeichner des ABAC-Attributwerts ab.
isActive Ruft ab, ob dieser ABAC-Attributwert aktiv ist.
SensitivityLabelDetails abacAttributeValues Ruft die ATTRIBUTWERTE der attributbasierten Zugriffssteuerung (ABAC) ab, die derzeit auf diese Vertraulichkeitsbezeichnung angewendet werden.
Kinder Ruft die untergeordneten Bezeichnungen der Vertraulichkeitsbezeichnung ab.
color Ruft die Farbe der Vertraulichkeitsbezeichnung ab.
id Ruft den eindeutigen Bezeichner (GUID) der Vertraulichkeitsbezeichnung ab.
isAbacAttributesRequired Ruft ab, ob ABAC-Attributauswahlen erforderlich sind, um diese Bezeichnung anzuwenden.
isAbacEnabled Ruft ab, ob für diese Bezeichnung die attributbasierte Zugriffssteuerung (ABAC) aktiviert ist.
isEnabled Ruft einen Wert ab, der angibt, ob die Bezeichnung aktiviert ist.
name Ruft den Namen der Vertraulichkeitsbezeichnung ab.
order Ruft die Priorität der Vertraulichkeitsbezeichnung, wobei 0 die niedrigste Priorität ist.
protectionType Ruft einen Wert ab, der den von dieser Bezeichnung bereitgestellten Schutztyp angibt.
siteId Ruft den eindeutigen Bezeichner (GUID) des Mandanten ab, zu dem die Vertraulichkeitsbezeichnung gehört.
QuickInfo Ruft die Beschreibung der Vertraulichkeitsbezeichnung ab.
SensitivityLabelDetailsCollection getFirst() Ruft das erste SensitivityLabelDetails Objekt in dieser Sammlung ab.
getFirstOrNullObject() Ruft das erste SensitivityLabelDetails Objekt in dieser Sammlung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
SensitivityLabelTryUpdateOptions abacAttributes Gibt (falls angegeben) die Attribute für die attributbasierte Zugriffssteuerung (ABAC) an, die mit der Bezeichnung angewendet werden sollen.
SensitivityLabelUpdateResult status Ruft den Status des Ergebnisses des Updateversuchs ab.
SensitivityLabelsCatalog getAttributes() Ruft die Metadaten des attributbasierten Zugriffssteuerungs-Attributkatalogs (ABAC) für ABAC-fähige Etiketten ab.
getLabelingCapabilities Ruft die Bezeichnungsfunktionen für Excel ab.
getLabelingCapability Ruft ab, ob der Katalog der Vertraulichkeitsbezeichnungen in Excel aktiviert ist.
getLabels() Ruft Vertraulichkeitsbezeichnungen ab, die für den aktuellen Benutzer verfügbar sind.
TimeoutErrorCellValue basicType Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.valueTypes würde.
basicValue Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.values würde.
errorSubType Stellt den Typ von TimeoutErrorCellValuedar.
errorType Stellt den Typ von ErrorCellValuedar.
type Stellt den Typ dieses Zellwerts dar.
Window rangeSelection Ruft die Bereichsauswahl im Fenster ab.
Workbook sensitivityLabel Gibt die Vertraulichkeitsbezeichnung der Arbeitsmappe zurück.

Siehe auch