xlsx-0.6.0: Simple and incomplete Excel file parser/writer

Safe HaskellNone




Higher level interface for creating styled worksheets



data Formatted Source #

Result of formatting

See formatted





Eq Formatted Source # 
Show Formatted Source # 
Generic Formatted Source # 

Associated Types

type Rep Formatted :: * -> * #

type Rep Formatted Source # 
type Rep Formatted = D1 (MetaData "Formatted" "Codec.Xlsx.Formatted" "xlsx-0.6.0-IZdrXDBRg3BFENqFscUY0N" False) (C1 (MetaCons "Formatted" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "formattedCellMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CellMap)) ((:*:) (S1 (MetaSel (Just Symbol "formattedStyleSheet") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 StyleSheet)) (S1 (MetaSel (Just Symbol "formattedMerges") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Range])))))

formatted :: Map (Int, Int) FormattedCell -> StyleSheet -> Formatted Source #

Higher level API for creating formatted documents

Creating formatted Excel spreadsheets using the Cell datatype directly, even with the support for the StyleSheet datatype, is fairly painful. This has a number of causes:

  • The Cell datatype wants an Int for the style, which is supposed to point into the _styleSheetCellXfs part of a stylesheet. However, this can be difficult to work with, as it requires manual tracking of cell style IDs, which in turns requires manual tracking of font IDs, border IDs, etc.
  • Row-span and column-span properties are set on the worksheet as a whole (wsMerges) rather than on individual cells.
  • Excel does not correctly deal with borders on cells that span multiple columns or rows. Instead, these rows must be set on all the edge cells in the block. Again, this means that this becomes a global property of the spreadsheet rather than properties of individual cells.

This function deals with all these problems. Given a map of FormattedCells, which refer directly to Fonts, Borders, etc. (rather than font IDs, border IDs, etc.), and an initial stylesheet, it recovers all possible sharing, constructs IDs, and then constructs the final CellMap, as well as the final stylesheet and list of merges.

If you don't already have a StyleSheet you want to use as starting point then minimalStyleSheet is a good choice.

toFormattedCells :: CellMap -> [Range] -> StyleSheet -> Map (Int, Int) FormattedCell Source #

reverse to formatted which allows to get a map of formatted cells from an existing worksheet and its workbook's style sheet

data CondFormatted Source #








condfmtDxf :: Lens' FormattedCondFmt Dxf Source #

condfmtPriority :: Lens' FormattedCondFmt Int Source #

condfmtStopIfTrue :: Lens' FormattedCondFmt (Maybe Bool) Source #