Class ExcelExporter

Excel exporter using ExcelJS Supports multi-sheet workbooks, formatting, styling, formulas, and all sampling options

Hierarchy (View Summary)

BaseExporter
- ExcelExporter

Index

Constructors

Properties

Methods

applySampling deriveColumns export extractRowValues formatColumnName formatValue getFileExtension getFullFileName getMimeType

Constructors

constructor

new ExcelExporter(options?: Partial<ExportOptions>): ExcelExporter
Parameters
- options: Partial<ExportOptions> = {}
Returns ExcelExporter
Overrides BaseExporter.constructor
- Defined in excel-exporter.ts:32

Properties

`Protected`options

options: ExportOptions

Methods

`Protected`applySampling

applySampling(data: ExportData): ExportData
Apply sampling to data based on options
Parameters
- data: ExportData
Returns ExportData
Inherited from BaseExporter.applySampling
- Defined in base-exporter.ts:75

`Protected`deriveColumns

deriveColumns(data: ExportData): ExportColumn[]
Derive columns from data if not explicitly provided
Parameters
- data: ExportData
Returns ExportColumn[]
Inherited from BaseExporter.deriveColumns
- Defined in base-exporter.ts:34

export

export(data: ExportData): Promise<ExportResult>
Export data to the target format
Parameters
- data: ExportData
  Array of data objects or arrays to export
Returns Promise<ExportResult>
Export result with buffer and metadata
Overrides BaseExporter.export
- Defined in excel-exporter.ts:44

`Protected`extractRowValues

extractRowValues(row: ExportDataRow, columns: ExportColumn[]): unknown[]
Extract row values in column order
Parameters
- row: ExportDataRow
- columns: ExportColumn[]
Returns unknown[]
Inherited from BaseExporter.extractRowValues
- Defined in base-exporter.ts:145

`Protected`formatColumnName

formatColumnName(name: string): string
Format a column name for display (e.g., "firstName" -> "First Name")
Parameters
- name: string
Returns string
Inherited from BaseExporter.formatColumnName
- Defined in base-exporter.ts:63

`Protected`formatValue

formatValue(value: unknown, column: ExportColumn): unknown
Format a cell value based on column type
Parameters
- value: unknown
- column: ExportColumn
Returns unknown
Inherited from BaseExporter.formatValue
- Defined in base-exporter.ts:159

getFileExtension

getFileExtension(): string
Get the file extension for this export format

Returns string
Overrides BaseExporter.getFileExtension
- Defined in excel-exporter.ts:40

`Protected`getFullFileName

getFullFileName(): string
Generate the full file name with extension

Returns string
Inherited from BaseExporter.getFullFileName
- Defined in base-exporter.ts:194

getMimeType

getMimeType(): string
Get the MIME type for this export format

Returns string
Overrides BaseExporter.getMimeType
- Defined in excel-exporter.ts:36