API

constructor

Erstellt eine MultiTableXlsxExporter Instanz.

new MultiTableXlsxExporter(options: MultiTableXlsxExporterOptions, filePath: string): MultiTableXlsxExporter

Parameter	Typ	Beschreibung
options	MultiTableXlsxExporterOptions	Optionen die für den Export benötigt werden
filePath	string	Dateipfad

Um eine neue Instanz zu erzeugen, müssen zwingend der Optionen-Parameter und Dateipfad angegeben werden.

Beispiel:

context.enableModules();
const { MultiTableXlsxExporter } = require("ou.sp.gadget.MultiTable");
const options = {
    title: "Beispieldatensätze",
    rows: [{
            id: "1",
            name: "name1"
        },
        {
            id: "2",
            name: "name2"
        },
        {
            id: "3",
            name: "name3"
        }
    ]
}
const exporter = new MultiTableXlsxExporter(options, "D:\\tmp\\test.xlsx")

Instanz Funktionen

save

Speichert die Xlsx-Datei.

save(): void

Beispiel:

try {
    exporter.save()
} catch (error) {
    context.errorMessage = error
    context.returnValue = -1
}

vorsicht

Es wird eine Exception mit der Fehlermeldung geworfen, sollte das Speichern fehlschlagen.

Instanz Eigenschaften

writer

Gibt die XLSXWriter Instanz zurück.

writer: XLSXWriter

Beispiel:

exporter.writer.setProperties("Title", "Subject", "Author", "manager", "company")

worksheet

Gibt die XLSXWorksheet Instanz zurück.

worksheet: XLSXWorksheet

Beispiel:

exporter.worksheet.setLandscape()

offsetRows

Konstante welche den Beginn der Zeilen zurück gibt, wenn keine Überschrift angegeben wurde (title)

offsetRowsWithTitle = 0

Beispiel:

const offsetRows = exporter.offsetRows

offsetRowsWithTitle

Konstante welche den Beginn der Zeilen zurück gibt, wenn eine Überschrift angegeben wurde (title)

offsetRowsWithTitle = 2

Beispiel:

const offsetRows = exporter.offsetRowsWithTitle