Kexcel/com.gyanoba.kexcel.sheet

Package-level declarations

The worksheet model: Sheet, the CellValue sealed hierarchy, CellStyle, Border/BorderStyle, CellIndex for "A1" ⇄ (column, row) conversion, and the per-cell Data wrapper.

Types

BoolCellValue

class BoolCellValue(val value: Boolean) : CellValue

Border

class Border(borderStyle: BorderStyle? = null, borderColorHex: ExcelColor? = null)

BorderStyle

enum BorderStyle : Enum<BorderStyle>

CellIndex

class CellIndex

CellStyle

class CellStyle(fontColorHex: ExcelColor = ExcelColor.black, backgroundColorHex: ExcelColor = ExcelColor.none, fontSize: Int? = null, fontFamily: String? = null, fontScheme: FontScheme? = null, horizontalAlign: HorizontalAlign = Left, verticalAlign: VerticalAlign = VerticalAlign.Bottom, textWrapping: TextWrapping? = null, bold: Boolean = false, italic: Boolean = false, underline: Underline = None, rotation: Int = 0, leftBorder: Border? = null, rightBorder: Border? = null, topBorder: Border? = null, bottomBorder: Border? = null, diagonalBorder: Border? = null, diagonalBorderUp: Boolean = false, diagonalBorderDown: Boolean = false, var numberFormat: NumFormat = NumFormat.standard_0)

Styling class for cells.

CellValue

sealed class CellValue

Data

class Data

DateCellValue

class DateCellValue(val year: Int, val month: Int, val day: Int) : CellValue

DateTimeCellValue

class DateTimeCellValue(val year: Int, val month: Int, val day: Int, val hour: Int, val minute: Int, val second: Int = 0, val millisecond: Int = 0, val microsecond: Int = 0) : CellValue

Excel does not know if this is UTC or not. Use asDateTimeLocal or asDateTimeUtc to get the LocalDateTime you prefer.

DoubleCellValue

class DoubleCellValue(val value: Double) : CellValue

FontFamily

enum FontFamily : Enum<FontFamily>

FormulaCellValue

class FormulaCellValue(val formula: String) : CellValue

HeaderFooter

class HeaderFooter(var alignWithMargins: Boolean?, var differentFirst: Boolean?, var differentOddEven: Boolean?, var scaleWithDoc: Boolean?, var evenFooter: String?, var evenHeader: String?, var firstFooter: String?, var firstHeader: String?, var oddFooter: String?, var oddHeader: String?)

IntCellValue

class IntCellValue(val value: Long) : CellValue

Sheet

class Sheet

TextCellValue

class TextCellValue : CellValue

TimeCellValue

class TimeCellValue(val hour: Int = 0, val minute: Int = 0, val second: Int = 0, val millisecond: Int = 0, val microsecond: Int = 0) : CellValue

Functions

getBorderStyleByName

fun getBorderStyleByName(name: String): BorderStyle?

getFontFamily

fun getFontFamily(fontFamily: FontFamily): String

Returns the human-readable font family name for the given FontFamily. e.g. FontFamily.Arial_Narrow → "Arial Narrow"