kexcel-dsl/io.kexcel.driver/WorkbookOptions

WorkbookOptions

data class WorkbookOptions(val flushInterval: Int = 1000, val forceFormulaRecalculation: Boolean = false, val applicationName: String = "KExcel", val applicationVersion: String = "1.0")

Configuration options for the Excel workbook generation.

This DTO centralizes metadata and engine-specific configurations to keep the ExcelDriver interface clean and avoid repetitive method additions for new settings.

Constructors

WorkbookOptions

constructor(flushInterval: Int = 1000, forceFormulaRecalculation: Boolean = false, applicationName: String = "KExcel", applicationVersion: String = "1.0")

Properties

applicationName

val applicationName: String

Application name to be embedded in the Excel metadata.

applicationVersion

val applicationVersion: String

Application version to be embedded in the Excel metadata.

flushInterval

val flushInterval: Int

Interval (in rows) at which the streaming engine should flush data to the output stream. Higher values improve performance but increase memory usage. Default is 1000 rows.

forceFormulaRecalculation

val forceFormulaRecalculation: Boolean

Whether to force formula recalculation when the workbook is opened in an Excel viewer. Default is false.