Codec.Xlsx.Util.Tabular

Convenience utility to read Xlsx tabular cells.

The majority of the toTableRows* functions assume that the table of interest consiste of contiguous rows styled with borders lines surrounding all cells, with possible text above and below the table that is not of interest. Like so:

Some documentation here....
---------------------------
| Header1 | Header2 | ... |
---------------------------
| Value1  | Value2  | ... |
---------------------------
| Value1  | Value2  | ... |
---------------------------
Maybe some annoying text here, I don't care about.

The heauristic used for table row selection in these functions is that any table rows will have a bottom border line.

If the above heuristic is not valid for your table you can instead provide your own row selection predicate to the toTableRowsCustom function. For example, the predicate \_ _ -> True (or (const . const) True) will select all contiguous rows.

Types

data Tabular

Tabular cells

Instances

Show Tabular

Methods

showsPrec :: Int -> Tabular -> ShowS

show :: Tabular -> String

showList :: [Tabular] -> ShowS

Default Tabular

Methods

def :: Tabular

data TabularHead

Tabular header

Instances

Show TabularHead

Methods

showsPrec :: Int -> TabularHead -> ShowS

show :: TabularHead -> String

showList :: [TabularHead] -> ShowS

Default TabularHead

Methods

def :: TabularHead

data TabularRow

Tabular row

Instances

Show TabularRow

Methods

showsPrec :: Int -> TabularRow -> ShowS

show :: TabularRow -> String

showList :: [TabularRow] -> ShowS

Default TabularRow

Methods

def :: TabularRow

Lenses

Tabular

tabularHeads :: Lens' Tabular [TabularHead]

tabularRows :: Lens' Tabular [TabularRow]

TabularHead

tabularHeadIx :: Lens' TabularHead Int

tabularHeadLabel :: Lens' TabularHead Text

TabularRow

tabularRowIx :: Lens' TabularRow Int

tabularRowCells :: Lens' TabularRow [Maybe CellValue]

Functions

toTableRowsFromFile

Arguments

:: Int

Starting row index (header row)

-> String

File name

-> IO (Maybe Tabular)

Read tabular rows from the first sheel of an Xlsx file. The table is assumed to consist of all contiguous rows that have bottom border lines, starting with the header.

toTableRows

Arguments

:: Xlsx

Xlsx Workbook

-> Text

Worksheet name to decode

-> Int

Starting row index (header row)

-> Maybe Tabular

Decode cells as tabular rows. The table is assumed to consist of all contiguous rows that have bottom border lines, starting with the header.

toTableRows'

Arguments

:: Xlsx

Xlsx Workbook

-> Int

Starting row index (header row)

-> Maybe Tabular

Decode cells from first sheet as tabular rows. The table is assumed to consist of all contiguous rows that have bottom border lines, starting with the header.

Custom row predicates

toTableRowsCustom

Arguments

:: (StyleSheet -> (Int, [(Int, Cell)]) -> Bool)

Predicate for row selection

-> Xlsx

Xlsx Workbook

-> Text

Worksheet name to decode

-> Int

Starting row index (header row)

-> Maybe Tabular

Decode cells as tabular rows. The table is assumed to consist of all contiguous rows that fulfill the given predicate, starting with the header.

The predicate function is given the Xlsx StyleSheet as well as a row (consisting of the row's index and the row's cells) and should return True if the row is part of the table.

Since 0.1.1