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
Anwendung formatStaleValues Gibt an, ob die Option "Veraltete Werte formatieren" in den Berechnungsoptionen aktiviert oder deaktiviert ist.
AutorunEventCompletedOptions allowEvent Gibt an, ob das Ereignis fortgesetzt werden darf.
autorunEventType Gibt den Typ des Autorun-Ereignisses an, das abgeschlossen werden soll, falls dies zulässig ist.
Nachricht Gibt (falls angegeben) eine optionale Fehlermeldung an, wenn das Ereignis nicht fortgesetzt werden darf.
Base64EncodedImage data Die Base64-codierte Zeichenfolge.
type Der Dateityp des Base64-codierten Bildes.
Chart getDataRange() Ruft die Datenquelle des gesamten Diagramms ab.
getDataRangeOrNullObject() Ruft die Datenquelle des gesamten Diagramms ab.
Kommentar assignTask(assignee: Excel.EmailIdentity) Weist die mit dem Kommentar verknüpfte Aufgabe dem angegebenen Benutzer als Beauftragter zu.
getTask() Ruft die mit diesem Kommentar verbundene Aufgabe ab.
getTaskOrNullObject() Ruft die mit diesem Kommentar verbundene Aufgabe ab.
CommentReply assignTask(assignee: Excel.EmailIdentity) Weist die mit dem Kommentar verknüpfte Aufgabe dem angegebenen Benutzer als alleiniger Beauftragter zu.
getTask() Ruft die Aufgabe ab, die dem Thread dieser Kommentarantwort zugeordnet ist.
getTaskOrNullObject() Ruft die Aufgabe ab, die dem Thread dieser Kommentarantwort zugeordnet ist.
DatetimeFormatInfo shortDateTimePattern Ruft die Formatzeichenfolge für einen kurzen Datums- und Uhrzeitwert ab.
DocumentTask assign(assignee: Excel.EmailIdentity) Fügt den angegebenen Benutzer der Liste der Zugewiesenen hinzu, die der Aufgabe zugeordnet sind.
Zugewiesene Personen Gibt eine Auflistung der Verantwortlichen der Aufgabe zurück.
Änderungen vornehmen Ruft die Änderungsdatensätze der Aufgabe ab.
comment Ruft den mit der Aufgabe verknüpften Kommentar ab.
completedBy Ruft den letzten Benutzer ab, der die Aufgabe abgeschlossen hat.
completedDateTime Ruft das Datum und die Uhrzeit ab, zu der die Aufgabe abgeschlossen wurde.
createdBy Ruft den Benutzer ab, der die Aufgabe erstellt hat.
createdDateTime Ruft das Datum und die Uhrzeit ab, zu der die Aufgabe erstellt wurde.
id Ruft die ID der Aufgabe ab.
percentComplete Gibt den Abschlussprozentsatz der Aufgabe an.
Priorität Gibt die Priorität der Aufgabe an.
startAndDueDateTime Gibt das Datum und die Uhrzeit an, zu der die Aufgabe gestartet werden soll und fällig ist.
title Gibt den Titel der Aufgabe an.
unassign(assignee: Excel.EmailIdentity) Entfernt den angegebenen Benutzer aus der Liste der Zugewiesenen, die der Aufgabe zugeordnet sind.
unassignAll() Entfernt alle Benutzer aus der Liste der zugewiesenen Personen, die der Aufgabe zugeordnet sind.
DocumentTaskChange Beauftragter Stellt den Benutzer dar, der der Aufgabe für eine assign Änderungsaktion zugewiesen wurde, oder den Benutzer, dem die Aufgabe für eine unassign Änderungsaktion nicht zugewiesen wurde.
changedBy Stellt die Identität des Benutzers dar, der die Aufgabenänderung vorgenommen hat.
commentId Stellt die ID des Kommentars oder der Kommentarantwort dar, mit der die Aufgabenänderung verknüpft ist.
createdDateTime Stellt das Erstellungsdatum und die Erstellungszeit des Änderungsdatensatzes der Aufgabe dar.
dueDateTime Stellt das Fälligkeitsdatum und die Uhrzeit der Aufgabe dar.
id Die eindeutige GUID der Aufgabenänderung
percentComplete Stellt den Fertigstellungsprozentsatz der Aufgabe dar.
Priorität Stellt die Priorität der Aufgabe dar.
startDateTime Stellt das Startdatum und die Startzeit der Aufgabe dar.
title Stellt den Titel der Aufgabe dar.
type Stellt den Aktionstyp des Aufgabenänderungsdatensatzes dar.
undoChangeId Stellt die Eigenschaft dar, die DocumentTaskChange.id für die undo Änderungsaktion rückgängig gemacht wurde.
DocumentTaskChangeCollection getCount() Ruft die Anzahl der Änderungsdatensätze in der Sammlung für die Aufgabe ab.
getItemAt(index: number) Ruft einen Änderungsdatensatz für eine Aufgabe mithilfe seines Indexes in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
DocumentTaskCollection getCount() Ruft die Anzahl der Aufgaben in der Sammlung ab.
getItem(key: string) Ruft eine Aufgabe mithilfe ihrer ID ab.
getItemAt(index: number) Ruft eine Aufgabe anhand ihres Index in der Sammlung ab.
getItemOrNullObject(key: string) Ruft eine Aufgabe mithilfe ihrer ID ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
DocumentTaskSchedule dueDateTime Ruft das Datum und die Uhrzeit ab, zu der die Aufgabe fällig ist.
startDateTime Ruft das Datum und die Uhrzeit ab, zu der die Aufgabe gestartet werden soll.
EmailIdentity displayName Stellt den Anzeigenamen des Benutzers dar.
email Stellt die E-Mail-Adresse des Benutzers dar.
id Stellt die eindeutige ID des Benutzers dar.
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.
Identity displayName Stellt den Anzeigenamen des Benutzers dar.
id Stellt die eindeutige ID des Benutzers dar.
LocalImage getBase64EncodedImageData(cacheUid: string) Ruft die Base64-codierten Bilddaten ab, die im freigegebenen Imagecache gespeichert sind, mit dem eindeutigen Cachebezeichner (UID).
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.
PivotLayout getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>) Ruft eine eindeutige Zelle in der PivotTable ab, die auf einer Datenhierarchie und den Zeilen- und Spaltenelementen ihrer jeweiligen Hierarchie basiert.
pivotStyle Die Formatvorlage, die auf die PivotTable angewendet wird.
setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle) Legt die Formatvorlage fest, die auf die PivotTable angewendet wird.
PivotTable autoRefresh Gibt an, ob die PivotTable automatisch aktualisiert wird, wenn sich die Quelldaten ändern.
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.
errorType Stellt den Typ von ErrorCellValuedar.
type Stellt den Typ dieses Zellwerts dar.
Query delete() Löscht die Abfrage und die zugehörige Verbindung.
QueryCollection refreshAll() Alle Abfragen aktualisieren.
Range togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode) Legt den Marshallingmodus der Python in Excel-Formel =PY fest.
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) Versucht, auf die für den Benutzer bereitgestellte Vertraulichkeitsbezeichnung in der Arbeitsmappe zu aktualisieren.
SensitivityLabelDetails Kinder Ruft die untergeordneten Bezeichnungen der Vertraulichkeitsbezeichnung ab.
color Ruft die Farbe der Vertraulichkeitsbezeichnung ab.
id Ruft den eindeutigen Bezeichner (GUID) der Vertraulichkeitsbezeichnung ab.
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.
SensitivityLabelsCatalog 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.
ShapeCollection addLocalImageReference(address: string) Erstellt einen Bezug für das in der Zelladresse gespeicherte lokale Bild und zeigt es als unverankertes Shape über den Zellen an.
addSvg(xml: string) Erstellt eine skalierbare Vektorgrafik (SVG) aus einer XML-Zeichenfolge und fügt sie dem Arbeitsblatt hinzu.
ShapeFont strikethrough Gibt den durchgestrichenen Status einer Schriftart an.
subscript Gibt den tiefgestellten Status der Schriftart an.
superscript Gibt den hochgestellten Status der Schriftart an.
tintAndShade Gibt ein Double-Zeichen an, das eine Farbe für die Bereichsschriftart aufhellt oder abdunkelt.
Datenschnitt nameInFormula Gibt den in der Formel verwendeten Namen des Datenschnitts an.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle) Legt die auf den Slicer angewendete Formatvorlage fest.
slicerStyle Die auf den Slicer angewendete Formatvorlage.
Table altTextDescription Gibt den Alternativtext für die Barrierefreiheit an.
altTextTitle Gibt eine Zusammenfassung für die Tabelle an, z. B. eine von Sprachausgaben verwendete.
clearStyle() Ändert die Tabelle so, dass sie die Standard-Tabellenformatvorlage verwendet.
comment Gibt einen mit der Tabelle verknüpften Kommentar an.
isActive Ruft ab, ob die Tabelle derzeit aktiv ist.
onFiltered Tritt auf, wenn ein Filter auf eine bestimmte Tabelle angewendet wird.
setStyle(style: string | TableStyle | BuiltInTableStyle) Legt die auf die Tabelle angewendete Formatvorlage fest.
source Ruft den Datenquellentyp ab, aus dem die Tabelle stammt.
tableStyle Die auf die Tabelle angewendete Formatvorlage.
TableCollection onFiltered Tritt auf, wenn ein Filter auf eine beliebige Tabelle in einer Arbeitsmappe oder auf einem Arbeitsblatt angewendet wird.
TableFilteredEventArgs tableId Ruft die ID der Tabelle ab, in der der Filter angewendet wird.
type Ruft den Typ des Ereignisses ab.
worksheetId Ruft die ID des Arbeitsblatts ab, das die Tabelle enthält.
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 autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions) Benachrichtigt die Hostanwendung, dass die Ausführung des Add-In-Codes in einem Autorun-Ereignis abgeschlossen wurde.
externalCodeServiceTimeout Gibt die maximale Zeitspanne (in Sekunden) für eine Formel an, deren Abschluss von einem externen Codedienst abhängt.
inPreviewMode() Gibt zurück, ob sich die Arbeitsmappe gerade im Vorschaumodus befindet.
localImage Gibt das LocalImage der Arbeitsmappe zugeordnete Objekt zurück.
sensitivityLabel Gibt die Vertraulichkeitsbezeichnung der Arbeitsmappe zurück.
showPivotFieldList Gibt an, ob der Bereich "Feldliste" der PivotTable auf Arbeitsmappenebene angezeigt wird.
Aufgaben Gibt eine Auflistung der Aufgaben zurück, die in der Arbeitsmappe vorhanden sind.
use1904DateSystem True, falls die Arbeitsmappe das 1904-Datumssystem verwendet.
Arbeitsblatt onCalculationBusy Tritt auf, wenn Zellen im Arbeitsblatt asynchron berechnet werden.
onFiltered Tritt auf, wenn ein Filter auf ein bestimmtes Arbeitsblatt angewendet wird.
Aufgaben Gibt eine Auflistung der Aufgaben zurück, die auf dem Arbeitsblatt vorhanden sind.
WorksheetCalculationBusyEventArgs address Die Adresse der Bereiche, die mit der Berechnung begonnen haben.
source Die Quelle des Ereignisses.
type Ruft den Typ des Ereignisses ab.
worksheetId Die ID des Arbeitsblatts, in dem die Berechnung erfolgt ist.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Arbeitsblatt | Zeichenfolge) Fügt die angegebenen Arbeitsblätter einer Arbeitsmappe in die aktuelle Arbeitsmappe ein.
onCalculationBusy Tritt auf, wenn Zellen im Arbeitsblatt asynchron berechnet werden.
onFiltered Tritt ein, wenn ein Filter eines beliebigen Arbeitsblatts in der Arbeitsmappe angewendet wird.
WorksheetFilteredEventArgs type Ruft den Typ des Ereignisses ab.
worksheetId Ruft die ID des Arbeitsblatts ab, auf das der Filter angewendet wird.

Siehe auch

  • Last updated on