Zum Hauptinhalt springen

MultiTableXlsxExporter

Constructors

Constructor

new MultiTableXlsxExporter(options, filePath): MultiTableXlsxExporter

Parameters

options

MultiTableXlsxExportOptions

filePath

string

Returns

MultiTableXlsxExporter

Properties

options

options: MultiTableXlsxExportOptions


offsetRows

offsetRows: number


offsetRowsWithTitle

offsetRowsWithTitle: number


writer

writer: XLSXWriter


worksheet

worksheet: XLSXWorksheet


typeMapper

typeMapper: XlsxTypeMapping

Methods

save()

save(): void

Returns

void


importOptions()

importOptions(options): void

Parameters

options

MultiTableXlsxExportOptions

Returns

void


addTitle()

addTitle(options): void

Parameters

options

MultiTableXlsxExportOptions

Returns

void


getTitleFormat()

getTitleFormat(options): XLSXFormat

Parameters

options

MultiTableXlsxExportOptions

Returns

XLSXFormat


getFormats()

getFormats(options): MultiTableXlsxExportFormatOptions[]

Parameters

options

MultiTableXlsxExportOptions

Returns

MultiTableXlsxExportFormatOptions[]


getTypeFormats()

getTypeFormats(options): MultiTableXlsxExportFormatOptions[]

Parameters

options

MultiTableXlsxExportOptions

Returns

MultiTableXlsxExportFormatOptions[]


mapColumns()

mapColumns(options): DocumentsJSONColumn[]

Parameters

options

MultiTableXlsxExportOptions

Returns

DocumentsJSONColumn[]


mapRows()

mapRows(options): unknown[][]

Parameters

options

MultiTableXlsxExportOptions

Returns

unknown[][]


colorMapper()

colorMapper(color): number

Parameters

color

ExportFormatColorNames

Returns

number


alignMapper()

alignMapper(align): number

Parameters

align

string

Returns

number


patternMapper()

patternMapper(pattern): number

Parameters

pattern

string

Returns

number


saveAsXlsx()

static saveAsXlsx(options, filePath): MultiTableXlsxExporter

Speichert die Excel Datei auf dem Dateisystem.

Wichtig! Der Rückgabewert muss dem Skript-Rückgabewert entsprechen.

Parameters

options

MultiTableXlsxExportOptions

filePath

string

Returns

MultiTableXlsxExporter

Example

context.returnValue = MultiTable.downloadAsXlsx(options, filePath);

downloadAsXlsx()

static downloadAsXlsx(options, filePath): string

Saves the Excel file and start the download.

Wichtig! Der Rückgabewert muss dem Skript-Rückgabewert entsprechen.

Parameters

options

MultiTableXlsxExportOptions

filePath

string

Returns

string

Example

context.returnValue = MultiTable.downloadAsXlsx(options, filePath);