Excel-JavaScript-API-Anforderungssatz 1.1

  • Artikel

Die Excel-JavaScript-API 1.1 ist die erste Version der API. Dies ist der einzige Excel-spezifische Anforderungssatz, der von Excel 2016 unterstützt wird.

API-Liste

In der folgenden Tabelle sind die APIs im JavaScript-API-Anforderungssatz 1.1 für Excel aufgeführt. Informationen zum Anzeigen der API-Referenzdokumentation für alle APIs, die vom Excel-JavaScript-API-Anforderungssatz 1.1 unterstützt werden, finden Sie unter Excel-APIs in Anforderungssatz 1.1.

Klasse Felder Beschreibung
Anwendung calculate(calculationType: Excel.CalculationType) Alle in Excel geöffnete Arbeitsmappen werden neu berechnet.
calculationMode Gibt den in der Arbeitsmappe verwendeten Berechnungsmodus zurück, der durch die Konstanten in Excel.CalculationModedefiniert wird.
Binding getRange() Gibt den durch die Bindung dargestellten Bereich zurück.
getTable() Gibt die durch die Bindung dargestellte Tabelle zurück.
getText() Gibt den durch die Bindung dargestellten Text zurück.
id Stellt den Bindungsbezeichner dar.
type Gibt den Typ der Bindung an.
BindingCollection count Gibt die Anzahl der Bindungen in der Sammlung zurück.
getItem(id: string) Ruft ein Binding-Objekt anhand seiner ID ab.
getItemAt(index: number) Ruft ein Binding-Objekt anhand seiner Position im Elementarray ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Chart Achsen Die Achsen des Diagramms.
dataLabels Stellt die Datenbeschriftungen im Diagramm dar.
delete() Löscht das Diagrammobjekt.
format Kapselt die Formateigenschaften für den Diagrammbereich.
height Gibt die Höhe des Diagrammobjekts in Punkt an.
left Der Abstand von der linken Seite des Diagramms zu dem Ursprung des Arbeitsblatts (in Punkten).
Legende Die Legende für das Diagramm.
name Gibt den Namen eines Diagrammobjekts an.
series Eine einzelne Datenreihe oder eine Sammlung von Datenreihen im Diagramm.
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Setzt die Quelldaten für das Diagramm zurück.
setPosition(startCell: Range | string, endCell?: Range | string) Positioniert das Diagramm im Verhältnis zu den Zellen im Arbeitsblatt.
title Der Titel des angegebenen Diagramms, einschließlich Text, Sichtbarkeit, Position und Formatierung des Titels.
top Gibt den Abstand zwischen dem oberen Rand des Objekts und dem oberen Rand der Zeile 1 (auf einem Arbeitsblatt) oder dem oberen Rand des Diagrammbereichs (in einem Diagramm) in Punkt an.
width Gibt die Breite des Diagrammobjekts in Punkt an.
ChartAreaFormat fill Stellt die Füllung eines Objekts dar, einschließlich Informationen zur Hintergrundformatierung.
font Stellt die Zeichenformatierung (Schriftart, Schriftgrad, Farbe usw.) für das aktuelle Objekt dar.
ChartAxes categoryAxis Stellt die Rubrikenachse in einem Diagramm dar.
seriesAxis Stellt die Reihenachse eines 3D-Diagramms dar.
valueAxis Stellt die Größenachse in einer Achse dar.
ChartAxis format Stellt die Formatierung für ein Diagrammobjekt dar, einschließlich Linien- und Schriftartformatierung.
majorGridlines Gibt ein -Objekt zurück, das die Hauptgitternetzlinien für die angegebene Achse darstellt.
majorUnit Stellt das Intervall zwischen zwei Hauptteilstrichen dar.
maximum Stellt den Maximalwert auf der Größenachse dar.
minimum Stellt den Mindestwert auf der Größenachse dar.
minorGridlines Gibt ein -Objekt zurück, das die Nebengitternetzlinien für die angegebene Achse darstellt.
minorUnit Stellt das Intervall zwischen zwei Hilfsteilstrichen dar.
title Stellt den Achsentitel dar.
ChartAxisFormat font Gibt die Schriftartattribute (Schriftartname, Schriftgrad, Farbe usw.) für ein Diagrammachsenelement an.
line Gibt die Diagrammlinienformatierung an.
ChartAxisTitle format Gibt die Formatierung des Titels der Diagrammachse an.
text Gibt den Achsentitel an.
visible Gibt an, ob der Achsentitel sichtbar ist.
ChartAxisTitleFormat font Gibt die Schriftartattribute des Diagrammachsentitels an, z. B. Schriftartname, Schriftgrad oder Farbe des Titelobjekts der Diagrammachse.
ChartCollection add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Erstellt ein neues Diagramm.
count Gibt die Anzahl der Diagramme im Arbeitsblatt zurück.
getItem(name: string) Ruft ein Diagramm über seinen Namen ab.
getItemAt(index: number) Ruft ein Diagramm anhand seiner Position in der Sammlung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
ChartDataLabelFormat fill Stellt die Füllung der aktuellen Diagrammdatenbeschriftung dar.
font Stellt die Schriftartattribute (z. B. Schriftartname, Schriftgrad und Farbe) für eine Diagrammdatenbezeichnung dar.
ChartDataLabels format Gibt das Format von Diagrammdatenbeschriftungen an, einschließlich Füll- und Schriftartformatierung.
position Wert, der die Position der Datenbeschriftung darstellt.
Trennzeichen Zeichenfolge, die das Trennzeichen für die Datenbeschriftungen in einem Diagramm darstellt.
showBubbleSize Gibt an, ob die Größe der Datenbezeichnungsblase sichtbar ist.
showCategoryName Gibt an, ob der Kategoriename der Datenbezeichnung sichtbar ist.
showLegendKey Gibt an, ob der Legendenschlüssel der Datenbezeichnung sichtbar ist.
showPercentage Gibt an, ob der Prozentsatz der Datenbezeichnung sichtbar ist.
showSeriesName Gibt an, ob der Datenbezeichnungsreihenname sichtbar ist.
showValue Gibt an, ob der Datenbeschriftungswert sichtbar ist.
ChartFill clear() Löscht die Füllfarbe eines Diagrammelements.
setSolidColor(color: string) Legt die Füllung eines Diagrammelements auf einfarbige Füllung fest.
ChartFont bold Stellt den Fett-Status der Schriftart dar.
color HTML-Farbcodedarstellung der Textfarbe (z. B. #FF0000 steht für Rot).
italic Stellt den Kursiv-Status der Schriftart dar.
name Schriftartname (z. B. "Calibri")
size Schriftgrad (z. B. 11)
underline Art der auf die Schriftart angewendeten Unterstreichung.
ChartGridlines format Stellt die Formatierung der Diagrammgitternetzlinien dar.
visible Gibt an, ob die Achsengitternetzlinien sichtbar sind.
ChartGridlinesFormat line Stellt die Formatierung der Diagrammlinien dar.
ChartLegend format Stellt die Formatierung für eine Diagrammlegende dar, einschließlich Füllung und Schriftartformatierung.
Overlay Gibt an, ob sich die Diagrammlegende mit dem Standard Textkörper des Diagramms überlappen soll.
position Gibt die Position der Legende im Diagramm an.
visible Gibt an, ob die Diagrammlegende sichtbar ist.
ChartLegendFormat fill Stellt die Füllung eines Objekts dar, einschließlich Informationen zur Hintergrundformatierung.
font Stellt die Schriftartattribute wie Schriftartname, Schriftgrad und Farbe einer Diagrammlegende dar.
ChartLineFormat clear() Löscht das Linienformat eines Diagrammelements.
color HTML-Farbcode, der die Farbe der Linien im Diagramm darstellt.
ChartPoint format Kapselt die Formateigenschaften eines Diagrammpunkts.
value Gibt den Wert eines Diagrammpunkts zurück.
ChartPointFormat fill Stellt das Füllformat eines Diagramms dar, das Informationen zur Hintergrundformatierung enthält.
ChartPointsCollection count Gibt die Anzahl der Diagrammpunkten in der Reihe zurück.
getItemAt(index: number) Abrufen eines Punkts anhand seiner Position in der Datenreihe.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
ChartSeries format Stellt die Formatierung für eine Diagrammdatenreihe dar, einschließlich Füllung und Linienformatierung.
name Gibt den Namen einer Datenreihe in einem Diagramm an.
Punkte Gibt eine Auflistung aller Punkte in der Reihe zurück.
ChartSeriesCollection count Gibt die Anzahl der Datenreihen in der Sammlung zurück.
getItemAt(index: number) Ruft eine Datenreihe anhand ihrer Position in der Sammlung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
ChartSeriesFormat fill Stellt die Füllung einer Diagrammdatenreihe dar, einschließlich Informationen zur Hintergrundformatierung.
line Die Zeilenformatierung.
ChartTitle format Stellt die Formatierung für einen Diagrammtitel dar, einschließlich Füllung und Schriftartformatierung.
Overlay Gibt an, ob der Diagrammtitel das Diagramm überlagert.
text Gibt den Titeltext des Diagramms an.
visible Gibt an, ob der Diagrammtitel sichtbar ist.
ChartTitleFormat fill Stellt die Füllung eines Objekts dar, einschließlich Informationen zur Hintergrundformatierung.
font Stellt die Schriftartattribute (z. B. Schriftartname, Schriftgrad und Farbe) für ein Objekt dar.
NamedItem getRange() Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist.
name Der Name des Objekts.
type Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird.
value Stellt den Wert dar, der von der Formel des Namens berechnet wurde.
visible Gibt an, ob das Objekt sichtbar ist.
NamedItemCollection getItem(name: string) Ruft ein NamedItem -Objekt unter Verwendung seines Namens ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Range address Gibt den Bereichsverweis im A1-Format an.
addressLocal Stellt den Bereichsverweis für den angegebenen Bereich in der Sprache des Benutzers dar.
cellCount Gibt die Anzahl der Zellen im Bereich an.
clear(applyTo?: Excel.ClearApplyTo) Löscht Bereichswerte, Format, Füllung, Rahmen usw.
Columncount Gibt die Gesamtanzahl der Spalten im Bereich an.
columnIndex Gibt die Spaltennummer der ersten Zelle im Bereich an.
delete(shift: Excel.DeleteShiftDirection) Löscht die dem Bereich zugeordneten Zellen.
format Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.
formulas Stellt die Formel in der A1-Schreibweise dar.
formulasLocal Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar.
getBoundingRect(anotherRange: Range | string) Ruft das kleinste Bereichsobjekt ab, das die angegebenen Bereiche umfasst.
getCell(row: number, column: number) Ruft das Bereichsobjekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltenanzahl enthält.
getColumn(column: number) Ruft eine Spalte ab, die im Bereich enthalten ist.
getEntireColumn() Ruft ein -Objekt ab, das die gesamte Spalte des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es getEntireColumn ein Bereich, der spalten "B:E") darstellt.
getEntireRow() Ruft ein -Objekt ab, das die gesamte Zeile des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es GetEntireRow ein Bereich, der die Zeilen "4:11" darstellt).
getIntersection(anotherRange: Range | string) Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt.
getLastCell() Ruft die letzte Zelle im Bereich ab.
getLastColumn() Ruft die letzte Spalte im Bereich ab.
getLastRow() Ruft die letzte Zeile im Bereich ab.
getOffsetRange(rowOffset: number, columnOffset: number) Ruft ein Objekt ab, das einen Bereich darstellt, der aus dem angegebenen Bereich versetzt ist.
getRow(row: number) Ruft eine Zelle ab, die im Bereich enthalten ist.
insert(shift: Excel.InsertShiftDirection) Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen.
Numberformat Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar.
Rowcount Gibt die Anzahl der Zeilen im Bereich zurück.
rowIndex Gibt die Spaltenanzahl der ersten Zelle im Bereich zurück.
select() Wählt den angegebenen Bereich in der Excel-Benutzeroberfläche aus.
text Textwerte des angegebenen Bereichs.
valueTypes Gibt den Datentyp in jeder Zelle an.
values Stellt die Rohwerte des angegebenen Bereichs dar.
worksheet Das Arbeitsblatt, das den aktuellen Bereich enthält.
RangeBorder color HTML-Farbcode, der die Farbe der Rahmenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt.
sideIndex Konstanter Wert, der die bestimmte Seiten des Rahmens angibt.
style Einer der Konstanten der Linienart, die die Linienart für den Rahmen angibt.
weight Gibt die Stärke des Rahmens um einen Bereich an.
RangeBorderCollection count Die Anzahl der Rahmen-Objekte in der Auflistung.
getItem(index: Excel.BorderIndex) Ruft ein Rahmen-Objekt ab, das den Namen verwendet
getItemAt(index: number) Ruft ein Rahmen-Objekt ab, das den Namen verwendet
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
RangeFill clear() Setzt den Hintergrund des Bereichs zurück.
color HTML-Farbcode, der die Farbe des Hintergrunds in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt
RangeFont bold Stellt die fett formatierte status der Schriftart dar.
color HTML-Farbcodedarstellung der Textfarbe (z. B. #FF0000 steht für Rot).
italic Gibt die kursiv formatierte status der Schriftart an.
name Schriftartname (z. B. "Calibri").
size Schriftgrad
underline Art der auf die Schriftart angewendeten Unterstreichung.
RangeFormat borders Auflistung von Border-Objekten, die für den gesamten ausgewählten Bereich gelten.
fill Gibt das Fill-Objekt an, das für den gesamten Bereich definiert ist.
font Gibt das Font-Objekt an, das für den gesamten Bereich definiert ist.
horizontalAlignment Stellt die horizontale Ausrichtung für das angegebene Objekt dar.
verticalAlignment Stellt die vertikale Ausrichtung für das angegebene Objekt dar.
wrapText Gibt an, ob Excel den Text im -Objekt umschließt.
Table columns Stellt eine Auflistung aller Spalten in der Tabelle dar.
delete() Löscht die Tabelle.
getDataBodyRange() Ruft das Bereichsobjekt ab, das mit dem Datenteil der Tabelle verknüpft ist.
getHeaderRowRange() Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Tabelle verknüpft ist.
getRange() Ruft das Bereichsobjekt ab, das mit der gesamten Tabelle verknüpft ist.
getTotalRowRange() Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Tabelle verknüpft ist.
id Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert.
name Der Name der Tabelle.
rows Stellt eine Auflistung aller Zeilen in der Tabelle dar.
showHeaders Gibt an, ob die Kopfzeile sichtbar ist.
showTotals Gibt an, ob die Gesamtzeile sichtbar ist.
style Konstanter Wert, der das Tabellenformat darstellt.
TableCollection add(address: Range | string, hasHeaders: boolean) Erstellt eine neue Tabelle.
count Gibt die Anzahl der Tabellen in der Arbeitsmappe zurück.
getItem(key: string) Ruft eine Tabelle anhand des Namens oder der ID ab.
getItemAt(index: number) Ruft eine Tabelle anhand ihrer Position in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
TableColumn delete() Löscht die Spalte aus der Tabelle.
getDataBodyRange() Ruft das Bereichsobjekt ab, das mit dem Datenteil der Spalte verknüpft ist.
getHeaderRowRange() Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Spalte verknüpft ist.
getRange() Ruft das Bereichsobjekt ab, das mit der gesamten Spalte verknüpft ist.
getTotalRowRange() Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Spalte verknüpft ist.
id Gibt einen eindeutigen Schlüssel an, der die Spalte in der Tabelle angibt.
Index Gibt die Indexnummer der Spalte in der Spaltenauflistung der Tabelle zurück.
name Gibt den Namen der Tabellenspalte an.
values Stellt die Rohwerte des angegebenen Bereichs dar.
TableColumnCollection add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | string | number, name?: string) Fügt der Tabelle eine neue Spalte hinzu.
count Gibt die Anzahl der Spalten in der Tabelle an.
getItem(key: number | string) Ruft ein Spaltenobjekt nach Name oder ID ab.
getItemAt(index: number) Ruft eine Spalte anhand ihrer Position in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
TableRow delete() Löscht die Zeile aus der Tabelle.
getRange() Ruft das Bereichsobjekt ab, das mit der gesamten Zeile verknüpft ist.
Index Gibt die Indexnummer der Zeile in der Zeilenauflistung der Tabelle zurück.
values Stellt die Rohwerte des angegebenen Bereichs dar.
TableRowCollection add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean) Fügt der Tabelle mindestens eine Zeile hinzu.
count Gibt die Anzahl der Zeilen in der Tabelle zurück.
getItemAt(index: number) Ruft eine Zeile anhand ihrer Position in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Workbook application Stellt die Excel-Anwendung instance dar, die diese Arbeitsmappe enthält.
bindings Stellt eine Auflistung aller Bindungen dar, die Teil der Arbeitsmappe sind.
getSelectedRange() Ruft den aktuell ausgewählten einzelnen Bereich aus der Arbeitsmappe ab.
Namen Stellt eine Auflistung von benannten Elementen im Arbeitsmappenbereich (benannte Bereiche und Konstanten) dar.
Tabellen Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Tabellen dar.
Arbeitsblätter Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar.
Arbeitsblatt activate() Aktivieren Sie das Arbeitsblatt in der Excel-Benutzeroberfläche.
Diagramme Gibt eine Auflistung von Diagrammen zurück, die Teil des Arbeitsblatts sind.
delete() Löscht das Arbeitsblatt aus der Arbeitsmappe.
getCell(row: number, column: number) Ruft das Range -Objekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltennummern enthält.
getRange(address?: string) Ruft das Range -Objekt ab, das einen einzelnen rechteckigen Zellblock darstellt, der durch die Adresse oder den Namen angegeben wird.
id Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert.
name Der Anzeigename des Arbeitsblatts.
position Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.
Tabellen Gibt die Sammlung von Tabellen zurück, die Teil des Arbeitsblatts sind.
Sichtbarkeit Die Sichtbarkeit des Arbeitsblatts.
WorksheetCollection add(name?: string) Fügt der Arbeitsmappe ein neues Arbeitsblatt hinzu.
getActiveWorksheet() Ruft das derzeit aktive Arbeitsblatt in der Arbeitsmappe ab.
getItem(key: string) Ruft das Arbeitsblattobjekt mithilfe des Namens oder der ID ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Siehe auch