src/xlsxio

    Dark Mode
Search:
Group by:

Types

XlsxAddMode = enum
  Int, DateTime
XlsxCell = tuple[state: bool, value: string]
XlsxCellMode {.pure.} = enum
  String, Integer, Float
XlsxIOSkip = enum
  None = 0, EmptyRows = 1, EmptyCells = 2, AllEmpty = 3, ExtraCells = 4,
  HiddenRows = 8
XlsxIOVersion = object
  major, minor, micro: int

Procs

proc `$`(version: XlsxIOVersion): string {....raises: [], tags: [].}
Formats version info into a string
proc hasSheet(handle: Xlsxioreader; name: string): bool {....raises: [IOError],
    tags: [].}
proc len(handle: Xlsxioreader): int {....raises: [IOError], tags: [].}
proc readClose(handle: Xlsxioreader) {....raises: [], tags: [].}
Closes a handle.
proc readGetVersion(): XlsxIOVersion {....raises: [], tags: [].}
proc readOpen(filename: string): Xlsxioreader {....raises: [IOError], tags: [].}
Opens a spreadsheet for reading. Returns a handle.
proc readOpenFilehandle(filehandle: File): Xlsxioreader {....raises: [IOError],
    tags: [].}
Opens a spreadsheet file handle for reading. Returns a handle.
proc readOpenMemory(data: var string; datalen: int; freedata: bool = true): Xlsxioreader {.
    ...raises: [IOError], tags: [].}
proc readSheetFlags(sheethandle: Xlsxioreadersheet): XlsxIOSkip {....raises: [],
    tags: [].}
proc readSheetIntoArray(sheethandle: Xlsxioreadersheet): seq[seq[string]] {.
    ...raises: [], tags: [].}
proc readSheetLastColumnIndex(sheethandle: Xlsxioreadersheet): int {....raises: [],
    tags: [].}
proc readSheetLastRowIndex(sheethandle: Xlsxioreadersheet): int {....raises: [],
    tags: [].}
proc readSheetlistOpen(handle: Xlsxioreader): Xlsxioreadersheetlist {.
    ...raises: [IOError], tags: [].}
proc readSheetNextCell(sheethandle: Xlsxioreadersheet): XlsxCell {....raises: [],
    tags: [].}
proc readSheetNextCellEpoch(sheethandle: Xlsxioreadersheet; cellint: var int64): int {.
    ...raises: [], tags: [].}
proc readSheetNextCellFloat(sheethandle: Xlsxioreadersheet;
                            cellfloat: var float64): int {....raises: [], tags: [].}
proc readSheetNextCellInt(sheethandle: Xlsxioreadersheet; cellint: var int64): int {.
    ...raises: [], tags: [].}
proc readSheetNextCellString(sheethandle: Xlsxioreadersheet;
                             cellstring: var string): int {....raises: [], tags: [].}
proc readSheetNextCellTime(sheethandle: Xlsxioreadersheet; celltime: var Time): int {.
    ...raises: [], tags: [].}
proc readSheetNextRow(sheethandle: Xlsxioreadersheet): int {....raises: [],
    tags: [].}
proc readSheetOpen(handle: Xlsxioreader; sheetindex: int;
                   skip: XlsxIOSkip = None): Xlsxioreadersheet {.
    ...raises: [IOError, ValueError], tags: [].}
proc readSheetOpen(handle: Xlsxioreader; sheetname: string;
                   skip: XlsxIOSkip = None): Xlsxioreadersheet {.
    ...raises: [IOError], tags: [].}
proc sheets(handle: Xlsxioreader): seq[string] {....raises: [IOError], tags: [].}
Lists read handle's sheets.
proc writeAddCell(handle: Xlsxiowriter; value: float64) {....raises: [], tags: [].}
proc writeAddCell(handle: Xlsxiowriter; value: int64; mode: XlsxAddMode = Int) {.
    ...raises: [], tags: [].}
proc writeAddCell(handle: Xlsxiowriter; value: string) {....raises: [], tags: [].}
proc writeAddCellEpoch(handle: Xlsxiowriter; value: int64) {....raises: [],
    tags: [].}
proc writeAddCellFloat(handle: Xlsxiowriter; value: float64) {....raises: [],
    tags: [].}
proc writeAddCellInt(handle: Xlsxiowriter; value: int64) {....raises: [], tags: [].}
proc writeAddCellString(handle: Xlsxiowriter; value: string) {....raises: [],
    tags: [].}
proc writeAddCellTime(handle: Xlsxiowriter; value: Time) {....raises: [], tags: [].}
proc writeAddColumn(handle: Xlsxiowriter; name: string; width: int) {.
    ...raises: [], tags: [].}
proc writeClose(handle: Xlsxiowriter) {....raises: [IOError], tags: [].}
proc writeGetVersion(): XlsxIOVersion {....raises: [], tags: [].}
proc writeNextRow(handle: Xlsxiowriter) {....raises: [], tags: [].}
proc writeOpen(filename: string; sheetname: string): Xlsxiowriter {.
    ...raises: [IOError], tags: [].}
proc writeSetDetectionRows(handle: Xlsxiowriter; rows: int) {....raises: [],
    tags: [].}
proc writeSetRowHeight(handle: Xlsxiowriter; height: int) {....raises: [], tags: [].}

Iterators

iterator readSheetRows(sheethandle: Xlsxioreadersheet): seq[string] {.
    ...raises: [], tags: [].}
iterator readSheetRowsEpoch(sheethandle: Xlsxioreadersheet): seq[float] {.
    ...raises: [], tags: [].}
iterator readSheetRowsFloat(sheethandle: Xlsxioreadersheet): seq[float] {.
    ...raises: [], tags: [].}
iterator readSheetRowsInt(sheethandle: Xlsxioreadersheet): seq[int] {.
    ...raises: [], tags: [].}
iterator readSheetRowsTime(sheethandle: Xlsxioreadersheet): seq[Time] {.
    ...raises: [], tags: [].}
iterator readSheets(handle: Xlsxioreader): string {....raises: [IOError], tags: [].}
iterator readSheets(handle: Xlsxioreadersheetlist): string {....raises: [IOError],
    tags: [].}