Neuerungen in der Excel-JavaScript-API 1.12
ExcelApi 1.12 hat die Unterstützung für Formeln in Bereichen erhöht, indem APIs zum Nachverfolgen dynamischer Arrays und zum Suchen der direkten Präzedenzfälle einer Formel hinzugefügt wurden. Außerdem wurde die API-Steuerung von PivotTable-Filtern hinzugefügt. Verbesserungen wurden auch in den Featurebereichen Kommentar, Kultureinstellungen und benutzerdefinierte Eigenschaften vorgenommen.
Funktionsbereich | Beschreibung | Relevante Objekte |
---|---|---|
Kommentarereignisse | Fügt der Kommentarauflistung Ereignisse zum Hinzufügen, Ändern und Löschen hinzu. | CommentCollection |
Kultureinstellungen für Datum und Uhrzeit | Ermöglicht Den Zugriff auf zusätzliche Kulturelle Einstellungen rund um die Formatierung von Datum und Uhrzeit. | CultureInfo, NumberFormatInfo-Anwendung |
Direkte Präzedenzfälle | Gibt Bereiche zurück, die zum Auswerten der Formel einer Zelle verwendet werden. | Range |
Pivotfilter | Wendet wertgesteuerte Filter auf die Felder einer PivotTable an. | PivotField, PivotFilters |
Bereichsüberlauf | Ermöglicht Add-Ins die Suche nach Bereichen, die dynamischen Arrayergebnissen zugeordnet sind. | Range |
Benutzerdefinierte Eigenschaften auf Arbeitsblattebene | Ermöglicht den Bereich benutzerdefinierter Eigenschaften auf Die Arbeitsblattebene und nicht auf die Arbeitsmappenebene. | WorksheetCustomProperty, WorksheetCustomPropertyCollection |
API-Liste
In der folgenden Tabelle sind die APIs im JavaScript-API-Anforderungssatz 1.12 für Excel aufgeführt. Informationen zum Anzeigen der API-Referenzdokumentation für alle APIs, die vom Excel-JavaScript-API-Anforderungssatz 1.12 oder früher unterstützt werden, finden Sie unter Excel-APIs im Anforderungssatz 1.12 oder früher.
Klasse | Felder | Beschreibung |
---|---|---|
ChartAxisTitle | textOrientation | Gibt den Winkel an, an dem der Text für den Titel der Diagrammachse ausgerichtet ist. |
ChartSeries | getDimensionValues(dimension: Excel.ChartSeriesDimension) | Ruft die Werte aus einer einzelnen Dimension der Diagrammreihe ab. |
Kommentar | contentType | Ruft den Inhaltstyp des Kommentars ab. |
CommentAddedEventArgs | commentDetails | Ruft das CommentDetail Array ab, das die Kommentar-ID und die IDs der zugehörigen Antworten enthält. |
source | Gibt die Quelle des Ereignisses an. | |
type | Ruft den Typ des Ereignisses ab. | |
worksheetId | Ruft die ID des Arbeitsblatts ab, in dem das Ereignis aufgetreten ist. | |
CommentChangedEventArgs | changeType | Ruft den Änderungstyp ab, der angibt, wie das geänderte Ereignis ausgelöst wird. |
commentDetails | Rufen Sie das CommentDetail Array ab, das die Kommentar-ID und die IDs der zugehörigen Antworten enthält. |
|
source | Gibt die Quelle des Ereignisses an. | |
type | Ruft den Typ des Ereignisses ab. | |
worksheetId | Ruft die ID des Arbeitsblatts ab, in dem das Ereignis aufgetreten ist. | |
CommentCollection | onAdded | Tritt ein, wenn die Kommentare hinzugefügt werden. |
onChanged | Tritt auf, wenn Kommentare oder Antworten in einer Kommentarsammlung geändert werden, auch wenn Antworten gelöscht werden. | |
onDeleted | Tritt auf, wenn Kommentare in der Kommentarauflistung gelöscht werden. | |
CommentDeletedEventArgs | commentDetails | Ruft das CommentDetail Array ab, das die Kommentar-ID und die IDs der zugehörigen Antworten enthält. |
source | Gibt die Quelle des Ereignisses an. | |
type | Ruft den Typ des Ereignisses ab. | |
worksheetId | Ruft die ID des Arbeitsblatts ab, in dem das Ereignis aufgetreten ist. | |
CommentDetail | commentId | Stellt die ID des Kommentars dar. |
replyIds | Stellt die IDs der zugehörigen Antworten dar, die zum Kommentar gehören. | |
CommentReply | contentType | Der Inhaltstyp der Antwort. |
CultureInfo | datetimeFormat | Definiert das kulturell geeignete Format für die Anzeige von Datum und Uhrzeit. |
DatetimeFormatInfo | dateSeparator | Ruft die Zeichenfolge ab, die als Datumstrennzeichen verwendet wird. |
longDatePattern | Ruft die Formatzeichenfolge für einen langen Datumswert ab. | |
longTimePattern | Ruft die Formatzeichenfolge für einen langen Zeitwert ab. | |
shortDatePattern | Ruft die Formatzeichenfolge für einen kurzen Datumswert ab. | |
timeSeparator | Ruft die Zeichenfolge ab, die als Zeittrennzeichen verwendet wird. | |
PivotDateFilter | Komparator | Der Vergleichsparameter ist der statische Wert, mit dem andere Werte verglichen werden. |
Bedingung | Gibt die Bedingung für den Filter an, der die erforderlichen Filterkriterien definiert. | |
ausschließlich | Wenn true , schließt filter Elemente aus , die Kriterien erfüllen. |
|
lowerBound | Die untere Grenze des Bereichs für die between Filterbedingung. |
|
upperBound | Die obere Grenze des Bereichs für die between Filterbedingung. |
|
wholeDays | Gibt für equals die Filterbedingungen , before , after und between an, ob Vergleiche als ganze Tage durchgeführt werden sollen. |
|
PivotField | applyFilter(filter: Excel.PivotFilters) | Legt einen oder mehrere der aktuellen PivotFilter des Felds fest und wendet sie auf das Feld an. |
clearAllFilters() | Löscht alle Kriterien aus allen Filtern des Felds. | |
clearFilter(filterType: Excel.PivotFilterType) | Löscht alle vorhandenen Kriterien aus dem Filter des Felds des angegebenen Typs (sofern aktuell angewendet). | |
getFilters() | Ruft alle Filter ab, die derzeit auf das Feld angewendet werden. | |
isFiltered(filterType?: Excel.PivotFilterType) | Überprüft, ob für das Feld Filter angewendet werden. | |
PivotFilters | dateFilter | Der aktuell angewendete Datumsfilter des PivotFields. |
labelFilter | Der derzeit angewendete Bezeichnungsfilter des PivotFields. | |
manualFilter | Der derzeit angewendete manuelle Filter des PivotFields. | |
valueFilter | Der aktuell angewendete Wertfilter des PivotFields. | |
PivotLabelFilter | Komparator | Der Vergleichsparameter ist der statische Wert, mit dem andere Werte verglichen werden. |
Bedingung | Gibt die Bedingung für den Filter an, der die erforderlichen Filterkriterien definiert. | |
ausschließlich | Wenn true , schließt filter Elemente aus , die Kriterien erfüllen. |
|
lowerBound | Die untere Grenze des Bereichs für die between Filterbedingung. |
|
substring | Die Teilzeichenfolge, die für die beginsWith Filterbedingungen , endsWith und contains verwendet wird. |
|
upperBound | Die obere Grenze des Bereichs für die between Filterbedingung. |
|
PivotManualFilter | selectedItems | Eine Liste ausgewählter Elemente, die manuell gefiltert werden sollen. |
PivotTable | allowMultipleFiltersPerField | Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilter auf einem bestimmten PivotField in der Tabelle zulässt. |
PivotTableScopedCollection | getCount() | Ruft die Anzahl der PivotTables in der Auflistung ab. |
getFirst() | Ruft die erste PivotTable in der Auflistung ab. | |
getItem(key: string) | Ruft eine PivotTable anhand des Namens ab. | |
GetItemOrNullObject(name: string) | Ruft eine PivotTable anhand des Namens ab. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
PivotValueFilter | Komparator | Der Vergleichsparameter ist der statische Wert, mit dem andere Werte verglichen werden. |
Bedingung | Gibt die Bedingung für den Filter an, der die erforderlichen Filterkriterien definiert. | |
ausschließlich | Wenn true , schließt filter Elemente aus , die Kriterien erfüllen. |
|
lowerBound | Die untere Grenze des Bereichs für die between Filterbedingung. |
|
selectionType | Gibt an, ob der Filter für die obersten/unteren N-Elemente, die obere/untere N-Prozent oder die obere/untere N-Summe gilt. | |
Schwelle | Der Schwellenwert "N" von Elementen, Prozent oder Summe, die nach einer Filterbedingung oben/unten gefiltert werden sollen. | |
upperBound | Die obere Grenze des Bereichs für die between Filterbedingung. |
|
value | Name des ausgewählten "Werts" im Feld, nach dem gefiltert werden soll. | |
Range | getDirectPrecedents() | Gibt ein WorkbookRangeAreas -Objekt zurück, das den Bereich darstellt, der alle direkten Präzedenzzellen eines angegebenen Bereichs im selben Arbeitsblatt oder in mehreren Arbeitsblättern enthält. |
getPivotTables(fullyContained?: boolean) | Ruft eine bereichsbezogene Auflistung von PivotTables ab, die sich mit dem Bereich überlappen. | |
getSpillParent() | Ruft das Bereichsobjekt ab, das die Ankerzelle für eine Zelle enthält, in die ein Überlauf erfolgen kann. | |
getSpillParentOrNullObject() | Ruft das Bereichsobjekt ab, das die Ankerzelle für die Zelle enthält, in die übergelaufen wird. | |
getSpillingToRange() | Ruft beim Aufruf für eine Ankerzelle das Bereichsobjekt ab, das den Überlaufbereich enthält. | |
getSpillingToRangeOrNullObject() | Ruft beim Aufruf für eine Ankerzelle das Bereichsobjekt ab, das den Überlaufbereich enthält. | |
hasSpill | Stellt dar, ob alle Zellen einen Überlaufrahmen aufweisen. | |
numberFormatCategories | Stellt die Kategorie des Zahlenformats jeder Zelle dar. | |
savedAsArray | Stellt dar, ob alle Zellen als Arrayformel gespeichert würden. | |
RangeAreasCollection | getCount() | Ruft die Anzahl der RangeAreas -Objekte in dieser Auflistung ab. |
getItemAt(index: number) | Gibt das -Objekt basierend auf der RangeAreas Position in der Auflistung zurück. |
|
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
WorkbookRangeAreas | addresses | Gibt ein Array von Adressen im A1-Stil zurück. |
areas | Gibt das RangeAreasCollection -Objekt zurück. |
|
getRangeAreasBySheet(key: string) | Gibt das Objekt basierend auf der RangeAreas Arbeitsblatt-ID oder dem Namen in der Auflistung zurück. |
|
getRangeAreasOrNullObjectBySheet(key: string) | Gibt das Objekt basierend auf dem Namen oder der RangeAreas ID des Arbeitsblatts in der Auflistung zurück. |
|
Schussbereiche | Gibt Bereiche zurück, aus denen dieses Objekt in einem -Objekt besteht RangeCollection . |
|
Arbeitsblatt | customProperties | Ruft eine Auflistung von benutzerdefinierten Eigenschaften auf Arbeitsblattebene ab. |
WorksheetCustomProperty | delete() | Löscht die benutzerdefinierte Eigenschaft. |
key | Ruft den Schlüssel der benutzerdefinierten Eigenschaft ab. | |
value | Ruft den Wert der benutzerdefinierten Eigenschaft ab oder legt ihn fest. | |
WorksheetCustomPropertyCollection | add(key: string, value: string) | Fügt eine neue benutzerdefinierte Eigenschaft hinzu, die dem angegebenen Schlüssel zugeordnet ist. |
getCount() | Ruft die Anzahl der benutzerdefinierten Eigenschaften auf diesem Arbeitsblatt ab. | |
getItem(key: string) | Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. | |
getItemOrNullObject(key: string) | Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Siehe auch
Office Add-ins