API-Übersicht
Konstruktor
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
rowsCount: 20,
colsCount: 20
});
Parameter:
- ein HTML-Container (oder die ID eines HTML-Containers)
- ein Hash mit Konfigurationsoptionen (siehe unten)
Spreadsheet-Methoden
| Name | Beschreibung |
|---|---|
| addColumn() | Fügt dem Spreadsheet eine neue Spalte hinzu |
| addFormula() | Registriert eine benutzerdefinierte Formelfunktion, die in Zellformeln verwendet werden kann |
| addRow() | Fügt dem Spreadsheet eine neue Zeile hinzu |
| clear() | Leert eine Tabellenkalkulation |
| deleteColumn() | Entfernt eine Spalte aus der Tabellenkalkulation |
| deleteRow() | Entfernt eine Zeile aus der Tabellenkalkulation |
| eachCell() | Iteriert Zellen in der Tabellenkalkulation |
| endEdit() | Beendet die Bearbeitung in der ausgewählten Zelle, schließt den Editor und speichert den eingegebenen Wert |
| fitColumn() | Passt die Breite der Spalte an ihren längsten Wert an |
| freezeCols() | Fixiert ("friert ein") Spalten |
| freezeRows() | Fixiert ("friert ein") Zeilen |
| getFilter() | Gibt ein Objekt mit den für die Datenfilterung festgelegten Kriterien zurück |
| getFormat() | Gibt das Zahlenformat zurück, das auf den Wert einer Zelle angewendet wird |
| getFormula() | Gibt die Formel einer Zelle zurück |
| getStyle() | Gibt die auf eine oder mehrere Zellen angewendeten Stile zurück |
| getValue() | Gibt den/die Wert(e) einer Zelle/von Zellen zurück |
| hideCols() | Blendet Spalten aus |
| hideRows() | Blendet Zeilen aus |
| hideSearch() | Blendet die Suchleiste aus |
| insertLink() | Fügt einen Hyperlink in eine Zelle ein oder entfernt ihn |
| isLocked() | Prüft, ob eine Zelle/Zellen gesperrt ist/sind |
| load() | Lädt Daten aus einer externen Datei |
| lock() | Sperrt die angegebene Zelle |
| mergeCells() | Führt einen Zellbereich zu einer Zelle zusammen oder teilt zusammengeführte Zellen auf |
| parse() | Lädt Daten aus einer lokalen Datenquelle in die Tabelle |
| redo() | Wendet die rückgängig gemachte Aktion erneut an |
| serialize() | Serialisiert die Tabellendaten in ein JSON-Objekt |
| search() | Sucht nach Zellen anhand der angegebenen Parameter |
| setFilter() | Filtert Daten im Spreadsheet nach den angegebenen Kriterien |
| setFormat() | Legt ein bestimmtes Format für den Wert einer Zelle fest |
| setStyle() | Legt den Stil für eine oder mehrere Zellen fest |
| setValidation() | Legt eine Validierung für Zellen fest, indem Dropdown-Listen in die Zellen eingefügt werden |
| setValue() | Setzt einen Wert für eine Zelle |
| showCols() | Zeigt ausgeblendete Spalten an |
| showRows() | Zeigt ausgeblendete Zeilen an |
| startEdit() | Startet die Bearbeitung in der ausgewählten Zelle |
| undo() | Macht die letzte Aktion rückgängig |
| unfreezeCols() | Hebt die Fixierung der fixierten ("eingefrorenen") Spalten auf |
| unfreezeRows() | Hebt die Fixierung der fixierten ("eingefrorenen") Zeilen auf |
| unlock() | Entsperrt eine oder mehrere gesperrte Zelle(n) |
Spreadsheet-Events
| Name | Beschreibung |
|---|---|
| afterAction | Wird ausgelöst, nachdem eine Aktion ausgeführt wurde |
| afterClear | Wird ausgelöst, nachdem eine Tabellenkalkulation geleert wurde |
| afterDataLoaded | Wird ausgelöst, nachdem das Laden der Daten abgeschlossen ist |
| afterEditEnd | Wird ausgelöst, nachdem die Bearbeitung einer Zelle abgeschlossen ist |
| afterEditStart | Wird ausgelöst, nachdem die Bearbeitung einer Zelle beginnt |
| afterFocusSet | Wird ausgelöst, nachdem der Fokus auf eine Zelle gesetzt wurde |
| afterSelectionSet | Wird ausgelöst, nachdem Zellen ausgewählt wurden |
| afterSheetChange | Wird ausgelöst, nachdem das aktuell aktive Tabellenblatt gewechselt wurde |
| beforeAction | Wird ausgelöst, bevor eine Aktion ausgeführt wird |
| beforeClear | Wird ausgelöst, bevor eine Tabellenkalkulation geleert wird |
| beforeEditEnd | Wird ausgelöst, bevor die Bearbeitung einer Zelle abgeschlossen wird |
| beforeEditStart | Wird ausgelöst, bevor die Bearbeitung einer Zelle beginnt |
| beforeFocusSet | Wird ausgelöst, bevor der Fokus auf eine Zelle gesetzt wird |
| beforeSelectionSet | Wird ausgelöst, bevor Zellen ausgewählt werden |
| beforeSheetChange | Wird ausgelöst, bevor das aktuell aktive Tabellenblatt gewechselt wird |
Spreadsheet-Eigenschaften
| Name | Beschreibung |
|---|---|
| colsCount | Optional. Legt die Anzahl der Spalten in einer Tabellenkalkulation bei der Initialisierung fest |
| editLine | Optional. Zeigt die Bearbeitungsleiste an oder blendet sie aus |
| exportModulePath | Optional. Legt den Pfad zum Export-Modul fest |
| formats | Optional. Definiert die Liste der Zahlenformate |
| importModulePath | Optional. Legt den Pfad zum Import-Modul fest |
| localization | Optional. Legt das Format von Zahlen, Daten, Uhrzeit und Währung fest |
| menu | Optional. Blendet das Menü ein oder aus |
| multiSheets | Optional. Aktiviert oder deaktiviert die Möglichkeit, mit mehreren Tabellenblättern zu arbeiten |
| readonly | Optional. Aktiviert oder deaktiviert den Nur-Lesen-Modus |
| rowsCount | Optional. Legt die Anzahl der Zeilen beim Initialisieren einer Tabelle fest |
| toolbarBlocks | Optional. Gibt die Blöcke von Schaltflächen an, die in der Symbolleiste des Spreadsheets angezeigt werden |
Sheet Manager-Methoden
| Name | Beschreibung |
|---|---|
| add() | Fügt der Tabellenkalkulation ein neues leeres Tabellenblatt hinzu und gibt den eindeutigen Bezeichner des neu erstellten Tabellenblatts zurück |
| clear() | Löscht den Inhalt eines bestimmten Sheets (entfernt alle Zellwerte, Styles und Formatierungen), ohne das Sheet selbst zu löschen |
| get() | Gibt ein einzelnes Sheet-Objekt anhand seines Bezeichners zurück |
| getActive() | Gibt das Sheet-Objekt zurück, das im Spreadsheet aktuell aktiv (sichtbar) ist |
| getAll() | Gibt ein Array aller Sheet-Objekte zurück, die aktuell im Spreadsheet vorhanden sind |
| remove() | Entfernt ein Sheet anhand seines Bezeichners aus dem Spreadsheet |
| setActive() | Wechselt das aktive (sichtbare) Sheet zu dem Sheet, das durch seinen Bezeichner angegeben wird |
Selection-Methoden
| Name | Beschreibung |
|---|---|
| getFocusedCell() | Gibt die ID der fokussierten Zelle zurück |
| getSelectedCell() | Gibt die ID(s) der ausgewählten Zelle(n) zurück |
| removeSelectedCell() | Hebt die Auswahl der angegebenen Zelle(n) auf |
| setFocusedCell() | Setzt den Fokus auf die angegebene Zelle |
| setSelectedCell() | Wählt die angegebene(n) Zelle(n) aus |
Events Bus-Methoden
| Name | Beschreibung |
|---|---|
| detach() | Entfernt einen Handler von einem Event (der zuvor mit der on()-Methode hinzugefügt wurde) |
| fire() | Löst ein internes Event aus |
| on() | Fügt einem internen Event des Spreadsheet einen Handler hinzu |
Export-Methoden
| Name | Beschreibung |
|---|---|
| json() | Exportiert Daten aus einer Tabelle in eine JSON-Datei |
| xlsx() | Exportiert Daten aus einer Tabelle in eine Excel-Datei (.xlsx) |