SheetScope

class SheetScope(driver: ExcelDriver, defaultStyle: ExcelStyle? = null) : BaseScope

Scope for creating a sheet.

Supports column configuration, individual rows, and high-performance streaming of row sequences.

driver

the underlying ExcelDriver

defaultStyle

the style inherited from workbook or sheet level

Constructors

constructor(driver: ExcelDriver, defaultStyle: ExcelStyle? = null)

The zero-based index of the next row to be processed in this sheet.

fun columnWidth(vararg widths: Pair<Int, Int>)

Configures widths for specific columns.

fun mergeCells(firstRow: Int, lastRow: Int, firstCol: Int, lastCol: Int)

Merges a range of cells within this sheet.

inline fun <T> nativeSheet(crossinline block: (T) -> Unit)

Provides access to the underlying native sheet object.

fun row(rowNum: Int? = null, height: Double? = null, style: ExcelStyle? = null, init: RowScope.() -> Unit)

Defines a single row.

fun <T> rows(data: Iterable<T>, height: Double? = null, style: ExcelStyle? = null, init: RowScope.(T) -> Unit)

Creates rows from an Iterable (e.g., List, Set).

fun <T> rows(data: Sequence<T>, height: Double? = null, style: ExcelStyle? = null, init: RowScope.(T) -> Unit)

Creates rows from a Sequence for high-performance, memory-efficient streaming.

fun skipRows(count: Int = 1)

Skips the specified number of rows.