Freigeben über

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 für @types/office-js zu entfernen, wenn Sie sie zuvor installiert haben).
  • Möglicherweise müssen Sie am Microsoft 365 Insider-Programm teilnehmen, um Zugriff auf neuere Office-Builds zu erhalten.

Die folgende Tabelle enthält eine kurze Zusammenfassung der APIs, während die nachfolgende API-Listentabelle eine detaillierte Liste enthält.

Funktionsbereich Beschreibung Relevante Objekte
Dokumentaufgaben Wandeln Sie Kommentare in Aufgaben um, die Benutzern zugewiesen sind. DocumentTask, DocumentTaskChange, DocumentTaskChangeCollection, DocumentTaskCollection
Tabellenformate Ermöglicht die Steuerung von Schriftart, Rahmen, Füllfarbe und anderen Aspekten von Tabellenformatvorlagen. Tabelle, PivotTable, Datenschnitt

API-Liste

In der folgenden Tabelle sind die Excel-JavaScript-APIs aufgeführt, die sich derzeit in der Vorschauphase 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 soll.
autorunEventType Gibt den Typ des autoun-Ereignisses an, das abgeschlossen werden soll, wenn dies zulässig ist.
message Falls angegeben, gibt eine optionale Fehlermeldung an, wenn das Ereignis nicht fortgesetzt werden darf.
Base64EncodedImage data Die Base64-codierte Zeichenfolge.
type Der Dateityp des Base64-codierten Bilds.
Chart getDataRange() Ruft die Datenquelle des gesamten Diagramms ab.
getDataRangeOrNullObject() Ruft die Datenquelle des gesamten Diagramms ab.
Kommentar assignTask(assignee: Excel.EmailIdentity) Weist die Aufgabe, die dem Kommentar angefügt ist, dem angegebenen Benutzer als zugewiesenen Empfänger zu.
getTask() Ruft die aufgabe ab, die diesem Kommentar zugeordnet ist.
getTaskOrNullObject() Ruft die aufgabe ab, die diesem Kommentar zugeordnet ist.
CommentReply assignTask(assignee: Excel.EmailIdentity) Weist die Aufgabe, die dem Kommentar zugeordnet ist, dem angegebenen Benutzer als alleinigen Zugewiesenen 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 Benutzer hinzu, die an die Aufgabe angefügt sind.
Erfüllungsgehilfen Gibt eine Auflistung von Zugewiesenen der Aufgabe zurück.
Änderungen Ruft die Änderungsdatensätze des Vorgangs ab.
comment Ruft den Kommentar ab, der der Aufgabe zugeordnet ist.
completedBy Ruft den letzten Benutzer ab, der die Aufgabe abgeschlossen hat.
completedDateTime Ruft das Datum und die Uhrzeit ab, zu dem die Aufgabe abgeschlossen wurde.
createdBy Ruft den Benutzer ab, der die Aufgabe erstellt hat.
createdDateTime Ruft das Datum und die Uhrzeit der Erstellung der Aufgabe ab.
id Ruft die ID des Tasks 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 der Vorgang 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 Empfänger, die an die Aufgabe angefügt sind.
unassignAll() Entfernt alle Benutzer aus der Liste der zugewiesenen Empfänger, die an die Aufgabe angefügt sind.
DocumentTaskChange Abtretungsempfänger Stellt den Benutzer dar, der der Aufgabe für eine assign Änderungsaktion zugewiesen ist, oder den Benutzer, der der Aufgabe für eine Änderungsaktion unassign zugewiesen wurde.
changedBy Stellt die Identität des Benutzers dar, der die Aufgabenänderung vorgenommen hat.
commentId Stellt die ID des Kommentars oder Kommentars dar, an dem die Aufgabenänderung verankert ist.
createdDateTime Stellt das Erstellungsdatum und die Erstellungszeit des Vorgangsänderungsdatensatzes dar.
dueDateTime Stellt das Fälligkeitsdatum und die Fälligkeitszeit des Vorgangs dar.
id Die eindeutige GUID der Aufgabe ändert sich.
percentComplete Stellt den Abschlussprozentsatz des Vorgangs dar.
Priorität Stellt die Priorität des Vorgangs dar.
startDateTime Stellt das Startdatum und die Startzeit des Vorgangs dar.
title Stellt den Titel des Vorgangs dar.
type Stellt den Aktionstyp des Vorgangsänderungsdatensatzes dar.
undoChangeId Stellt die DocumentTaskChange.id Eigenschaft dar, die für die undo Änderungsaktion rückgängig wurde.
DocumentTaskChangeCollection getCount() Ruft die Anzahl der Änderungsdatensätze in der Auflistung für den Task ab.
getItemAt(index: number) Ruft einen Vorgangsänderungsdatensatz 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 Auflistung ab.
getItem(key: string) Ruft einen Task mithilfe seiner ID ab.
getItemAt(index: number) Ruft einen Task anhand seines Indexes in der Auflistung ab.
getItemOrNullObject(key: string) Ruft einen Task mithilfe seiner ID ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
DocumentTaskSchedule dueDateTime Ruft das Datum und die Uhrzeit ab, zu dem der Vorgang fällig ist.
startDateTime Ruft das Datum und die Uhrzeit ab, zu dem der Task 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 im Karte angezeigte Array enthält.
columnsToReport Stellt die Anzahl der Spalten dar, die sich die Karte Ansprüche im Array befinden.
displayName Stellt den Namen der Eigenschaft dar, die das im Karte angezeigte Array enthält.
firstRowIsHeader Gibt an, ob die erste Zeile des Arrays als Header behandelt wird.
Layout Stellt den Typ dieses Layouts dar.
rowsToReport Stellt die Anzahl der Zeilen dar, die sich die Karte Ansprüche im Array befinden.
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 von Range.valueTypes für eine Zelle mit diesem Wert zurückgegeben wird.
basicValue Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird.
language Stellt die Laufzeitsprache dieses externen Codediensts dar.
Vorschau Stellt den Vorschauwert dar, der in der Zelle angezeigt wird.
Anbieter Stellt Informationen zu dem Dienst dar, der die Daten in diesem ExternalCodeServiceObjectCellValuebereitgestellt hat.
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 Cache für freigegebene Images mit dem cache unique identifier (UID) gespeichert sind.
LocalImageCellValue altText Stellt den alternativen Text dar, der in Barrierefreiheitsszenarien verwendet wird, um zu beschreiben, was das Bild darstellt.
Zuschreibung Stellt Zuordnungsinformationen dar, um die Quell- und Lizenzanforderungen für dieses Bild zu beschreiben.
basicType Stellt den Wert dar, der von Range.valueTypes für eine Zelle mit diesem Wert zurückgegeben wird.
basicValue Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird.
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 Bilds dar, wie sie im Cache angezeigt wird.
NameErrorCellValue errorSubType Stellt den Typ von dar NameErrorCellValue.
NamedSheetViewCollection getItemOrNullObject(key: string) Ruft eine Blattansicht unter Verwendung ihres Namens ab.
NotAvailableErrorCellValue errorSubType Stellt den Typ von dar NotAvailableErrorCellValue.
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 auf die PivotTable angewendete Formatvorlage.
setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle) Legt die auf die PivotTable angewendete Formatvorlage fest.
PivotTable autoRefresh Gibt an, ob die PivotTable automatisch aktualisiert wird, wenn sich die Quelldaten ändern.
PythonErrorCellValue basicType Stellt den Wert dar, der von Range.valueTypes für eine Zelle mit diesem Wert zurückgegeben wird.
basicValue Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird.
errorType Stellt den Typ von dar ErrorCellValue.
type Stellt den Typ dieses Zellwerts dar.
Query delete() Löscht die Abfrage und die zugeordnete Verbindung.
refresh() Aktualisiert die Abfrage.
QueryCollection refreshAll() Aktualisieren Sie alle Abfragen.
Range togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode) Legt den Marshallingmodus von Python in Der Excel-Formel =PY fest.
RequestContext setInvocation(invocation: { invocationId: number isInSyncExecution: boolean })
ShapeCollection addLocalImageReference(address: string) Erstellt einen Verweis für das lokale Bild, das in der Zellenadresse gespeichert ist, und zeigt es als unverankerte Form über Zellen an.
addSvg(xml: string) Erstellt eine skalierbare Vektorgrafik (SVG) aus einer XML-Zeichenfolge und fügt sie dem Arbeitsblatt hinzu.
ShapeFont strikethrough Gibt die durchgestrichene status der Schriftart an.
subscript Gibt den tiefgestellten status der Schriftart an.
superscript Gibt die hochgestellte status der Schriftart an.
tintAndShade Gibt ein Double an, das eine Farbe für die Bereichsschriftart aufhellt oder abdunkeln kann.
Datenschnitt nameInFormula Gibt den in der Formel verwendeten Slicernamen 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 alternativen Text für die Barrierefreiheit an.
altTextTitle Gibt eine Zusammenfassung für die Tabelle an, z. B. eine, die von Sprachausgaben verwendet wird.
clearStyle() Ändert die Tabelle so, dass sie die Standard-Tabellenformatvorlage verwendet.
comment Gibt einen Kommentar an, der der Tabelle zugeordnet ist.
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 ein 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 von Range.valueTypes für eine Zelle mit diesem Wert zurückgegeben wird.
basicValue Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird.
errorSubType Stellt den Typ von dar TimeoutErrorCellValue.
errorType Stellt den Typ von dar ErrorCellValue.
type Stellt den Typ dieses Zellwerts dar.
Window rangeSelection Ruft die Bereichsauswahl im Fenster ab.
Workbook autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions) Benachrichtigt die Hostanwendung darüber, dass der Code des Add-Ins in einem Autorun-Ereignis ausgeführt wurde.
externalCodeServiceTimeout Gibt die maximale Zeitdauer in Sekunden an, die einer Formel zugewiesen wird, die von einem externen Codedienst abhängig ist.
localImage Gibt das LocalImage der Arbeitsmappe zugeordnete Objekt zurück.
showPivotFieldList Gibt an, ob der Feldlistenbereich der PivotTable auf Arbeitsmappenebene angezeigt wird.
Aufgaben Gibt eine Auflistung von Aufgaben zurück, die in der Arbeitsmappe vorhanden sind.
use1904DateSystem True, falls die Arbeitsmappe das 1904-Datumssystem verwendet.
Arbeitsblatt onFiltered Tritt auf, wenn ein Filter auf ein bestimmtes Arbeitsblatt angewendet wird.
Aufgaben Gibt eine Auflistung von Aufgaben zurück, die im Arbeitsblatt vorhanden sind.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string) Fügt die angegebenen Arbeitsblätter einer Arbeitsmappe in die aktuelle Arbeitsmappe ein.
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