HExcel

Module exports

Example usage:

{-# LANGUAGE TypeApplications #-}
module Main where

import Control.Monad.Trans.State (execStateT)
import Control.Monad (forM_)
import Data.Time (getZonedTime)
import HExcel

main :: IO ()
main = do
  wb <- workbookNew "test.xlsx"
  let props = mkDocProperties
        { docPropertiesTitle   = "Test Workbook"
        , docPropertiesCompany = "HExcel"
        }
  workbookSetProperties wb props
  ws <- workbookAddWorksheet wb "First Sheet"
  df <- workbookAddFormat wb
  formatSetNumFormat df "mmm d yyyy hh:mm AM/PM"
  now <- getZonedTime
  -- You can create HExcelState which is convenient api for writing to cells
  let initState = HExcelState Nothing ws 4 1 0 1 0
  _ <- flip execStateT initState $ do
         writeCell "David"
         writeCell "Dimitrije"
         -- we can skip some rows
         skipRows 1
         writeCell "Jovana"
         -- skip some columns
         skipCols 1
         writeCell (zonedTimeToDateTime now)
         writeCell @Double 42.5

  -- or use functions that run in plain IO
  forM_ [5 .. 8] $ \n -> do
    writeString ws Nothing n 3 "xxx"
    writeNumber ws Nothing n 4 1234.56
    writeDateTime ws (Just df) n 5 (zonedTimeToDateTime now)
  workbookClose wb

Documentation

data Workbook

Excel Workbook

workbookNew :: FilePath -> IO Workbook

Create new workbook

workbookNewConstantMem :: FilePath -> IO Workbook

Create new workbook but force constant memory. It reduces the amount of data stored in memory so that large files can be written efficiently.

workbookClose :: Workbook -> IO ()

Close the workbook

workbookAddWorksheet :: Workbook -> String -> IO Worksheet

Add the worksheet

workbookAddFormat :: Workbook -> IO Format

Add workbook format

workbookDefineName :: Workbook -> String -> String -> IO ()

Set workbook name

data DocProperties

Excel document properties

Constructors

DocProperties

Fields

• docPropertiesTitle :: String
• docPropertiesSubject :: String
• docPropertiesAuthor :: String
• docPropertiesManager :: String
• docPropertiesCompany :: String
• docPropertiesCategory :: String
• docPropertiesKeywords :: String
• docPropertiesComments :: String
• docPropertiesStatus :: String
• docPropertiesHyperlinkBase :: String
• docPropertiesCreated :: UTCTime

workbookSetProperties :: Workbook -> DocProperties -> IO ()

Set workbook properties

data Worksheet

Excel WorkSheet

type Row = Word32

Excel Row

type Col = Word16

Excel Column

writeNumber :: Worksheet -> Maybe Format -> Row -> Col -> Double -> IO ()

Write a Double value to Excel cell

writeString :: Worksheet -> Maybe Format -> Row -> Col -> String -> IO ()

Write a String value to Excel cell

writeUTCTime :: Worksheet -> Maybe Format -> Row -> Col -> UTCTime -> IO ()

Write a UTCTime value to Excel cell

writeFormula :: Worksheet -> Maybe Format -> Row -> Col -> String -> IO ()

Write a formula to Excel cell

writeArrayFormula :: Worksheet -> Maybe Format -> Row -> Col -> Row -> Col -> String -> IO ()

data DateTime

Type to hold datetime values

Constructors

DateTime

Fields

• dtYear :: CInt
• dtMonth :: CInt
• dtDay :: CInt
• dtHour :: CInt
• dtMinute :: CInt
• dtSecond :: CDouble

Instances

Show DateTime

Defined in HExcel.Types

Methods

showsPrec :: Int -> DateTime -> ShowS

show :: DateTime -> String

showList :: [DateTime] -> ShowS

Storable DateTime

Defined in HExcel.Types

Methods

sizeOf :: DateTime -> Int

alignment :: DateTime -> Int

peekElemOff :: Ptr DateTime -> Int -> IO DateTime

pokeElemOff :: Ptr DateTime -> Int -> DateTime -> IO ()

peekByteOff :: Ptr b -> Int -> IO DateTime

pokeByteOff :: Ptr b -> Int -> DateTime -> IO ()

peek :: Ptr DateTime -> IO DateTime

poke :: Ptr DateTime -> DateTime -> IO ()

HExcel DateTime

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => DateTime -> StateT HExcelState m ()

utcTimeToDateTime :: UTCTime -> DateTime

Helper function to convert UTCTime to DateTime

zonedTimeToDateTime :: ZonedTime -> DateTime

Helper function to convert ZonedTime to DateTime

writeDateTime :: Worksheet -> Maybe Format -> Row -> Col -> DateTime -> IO ()

Write a DateTime to Excel cell

writeUrl :: Worksheet -> Maybe Format -> Row -> Col -> String -> IO ()

Write a url to Excel cell

worksheetSetRow :: Worksheet -> Maybe Format -> Row -> Double -> IO ()

Set worksheet row

worksheetSetColumn :: Worksheet -> Maybe Format -> Col -> Col -> Double -> IO ()

Set worksheet column

data ImageOptions

Type to hold image options

Constructors

ImageOptions

Fields

• imageOffsetX :: Int32
• imageOffsetY :: Int32
• imageScaleX :: Double
• imageScaleY :: Double

Instances

Storable ImageOptions

Defined in HExcel.Types

Methods

sizeOf :: ImageOptions -> Int

alignment :: ImageOptions -> Int

peekElemOff :: Ptr ImageOptions -> Int -> IO ImageOptions

pokeElemOff :: Ptr ImageOptions -> Int -> ImageOptions -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImageOptions

pokeByteOff :: Ptr b -> Int -> ImageOptions -> IO ()

peek :: Ptr ImageOptions -> IO ImageOptions

poke :: Ptr ImageOptions -> ImageOptions -> IO ()

worksheetInsertImage :: Worksheet -> Word32 -> Word16 -> String -> IO ()

Insert image to worksheet

worksheetInsertImageOpt :: Worksheet -> Row -> Col -> FilePath -> ImageOptions -> IO ()

worksheetMergeRange :: Worksheet -> Maybe Format -> Row -> Col -> Row -> Col -> String -> IO ()

Merge columns

worksheetFreezePanes :: Worksheet -> Row -> Col -> IO ()

worksheetSplitPanes :: Worksheet -> Double -> Double -> IO ()

worksheetSetLandscape :: Worksheet -> IO ()

Set worksheet to Landscape

worksheetSetPortrait :: Worksheet -> IO ()

Set worksheet to Portrait

worksheetSetPageView :: Worksheet -> IO ()

data PaperSize

Paper size

Constructors

DefaultPaper

LetterPaper

A3Paper

A4Paper

A5Paper

OtherPaper Word8

Instances

Eq PaperSize

Defined in HExcel.Types

Methods

(==) :: PaperSize -> PaperSize -> Bool

(/=) :: PaperSize -> PaperSize -> Bool

skipCols :: MonadIO m => Word16 -> StateT HExcelState m ()

Skip a number of columns

skipRows :: MonadIO m => Word32 -> StateT HExcelState m ()

Skip a number of rows

worksheetSetPaperSize :: Worksheet -> PaperSize -> IO ()

Set worksheet PaperSize

worksheetSetMargins :: Worksheet -> Double -> Double -> Double -> Double -> IO ()

Set worksheet margins

worksheetSetHeaderCtl :: Worksheet -> String -> IO ()

worksheetSetFooterCtl :: Worksheet -> String -> IO ()

worksheetSetZoom :: Worksheet -> Double -> IO ()

worksheetSetPrintScale :: Worksheet -> Double -> IO ()

data Format

Excel Format

formatSetFontName :: Format -> String -> IO ()

Set font name

formatSetFontSize :: Format -> Word16 -> IO ()

Set font size

data Color

Colors

Constructors

ColorBlack

ColorBlue

ColorBrown

ColorCyan

ColorGray

ColorGreen

ColorLime

ColorMagenta

ColorNavy

ColorOrange

ColorPink

ColorPurple

ColorRed

ColorSilver

ColorWhite

ColorYellow

Color Word8 Word8 Word8

formatSetFontColor :: Format -> Color -> IO ()

Set font color

formatSetNumFormat :: Format -> String -> IO ()

Set number format

formatSetBold :: Format -> IO ()

Set bold style

formatSetItalic :: Format -> IO ()

Set italic style

data UnderlineStyle

Underline styles

Constructors

UnderlineNone

UnderlineSingle

UnderlineDouble

UnderlineSingleAccounting

UnderlineDoubleAccounting

Instances

Enum UnderlineStyle

Defined in HExcel.Types

Methods

succ :: UnderlineStyle -> UnderlineStyle

pred :: UnderlineStyle -> UnderlineStyle

toEnum :: Int -> UnderlineStyle

fromEnum :: UnderlineStyle -> Int

enumFrom :: UnderlineStyle -> [UnderlineStyle]

enumFromThen :: UnderlineStyle -> UnderlineStyle -> [UnderlineStyle]

enumFromTo :: UnderlineStyle -> UnderlineStyle -> [UnderlineStyle]

enumFromThenTo :: UnderlineStyle -> UnderlineStyle -> UnderlineStyle -> [UnderlineStyle]

Eq UnderlineStyle

Defined in HExcel.Types

Methods

(==) :: UnderlineStyle -> UnderlineStyle -> Bool

(/=) :: UnderlineStyle -> UnderlineStyle -> Bool

Read UnderlineStyle

Defined in HExcel.Types

Methods

readsPrec :: Int -> ReadS UnderlineStyle

readList :: ReadS [UnderlineStyle]

readPrec :: ReadPrec UnderlineStyle

readListPrec :: ReadPrec [UnderlineStyle]

Show UnderlineStyle

Defined in HExcel.Types

Methods

showsPrec :: Int -> UnderlineStyle -> ShowS

show :: UnderlineStyle -> String

showList :: [UnderlineStyle] -> ShowS

formatSetUnderline :: Format -> UnderlineStyle -> IO ()

Set underline style

formatSetStrikeout :: Format -> IO ()

data ScriptStyle

Script styles

Constructors

SuperScript

SubScript

Instances

Enum ScriptStyle

Defined in HExcel.Types

Methods

succ :: ScriptStyle -> ScriptStyle

pred :: ScriptStyle -> ScriptStyle

toEnum :: Int -> ScriptStyle

fromEnum :: ScriptStyle -> Int

enumFrom :: ScriptStyle -> [ScriptStyle]

enumFromThen :: ScriptStyle -> ScriptStyle -> [ScriptStyle]

enumFromTo :: ScriptStyle -> ScriptStyle -> [ScriptStyle]

enumFromThenTo :: ScriptStyle -> ScriptStyle -> ScriptStyle -> [ScriptStyle]

Eq ScriptStyle

Defined in HExcel.Types

Methods

(==) :: ScriptStyle -> ScriptStyle -> Bool

(/=) :: ScriptStyle -> ScriptStyle -> Bool

Read ScriptStyle

Defined in HExcel.Types

Methods

readsPrec :: Int -> ReadS ScriptStyle

readList :: ReadS [ScriptStyle]

readPrec :: ReadPrec ScriptStyle

readListPrec :: ReadPrec [ScriptStyle]

Show ScriptStyle

Defined in HExcel.Types

Methods

showsPrec :: Int -> ScriptStyle -> ShowS

show :: ScriptStyle -> String

showList :: [ScriptStyle] -> ShowS

formatSetScript :: Format -> ScriptStyle -> IO ()

formatSetBuiltInFormat :: Format -> Word8 -> IO ()

data Align

Alignment styles

Constructors

AlignNone

AlignLeft

AlignCenter

AlignRight

AlignFill

AlignJustify

AlignCenterAcross

AlignDistributed

Instances

Enum Align

Defined in HExcel.Types

Methods

succ :: Align -> Align

pred :: Align -> Align

toEnum :: Int -> Align

fromEnum :: Align -> Int

enumFrom :: Align -> [Align]

enumFromThen :: Align -> Align -> [Align]

enumFromTo :: Align -> Align -> [Align]

enumFromThenTo :: Align -> Align -> Align -> [Align]

Eq Align

Defined in HExcel.Types

Methods

(==) :: Align -> Align -> Bool

(/=) :: Align -> Align -> Bool

Read Align

Defined in HExcel.Types

Methods

readsPrec :: Int -> ReadS Align

readList :: ReadS [Align]

readPrec :: ReadPrec Align

readListPrec :: ReadPrec [Align]

Show Align

Defined in HExcel.Types

Methods

showsPrec :: Int -> Align -> ShowS

show :: Align -> String

showList :: [Align] -> ShowS

data VerticalAlign

Vertical align styles

Constructors

VerticalAlignNone

VerticalAlignTop

VerticalAlignBottom

VerticalAlignCenter

VerticalAlignJustify

VerticalAlignDistributed

Instances

Enum VerticalAlign

Defined in HExcel.Types

Methods

succ :: VerticalAlign -> VerticalAlign

pred :: VerticalAlign -> VerticalAlign

toEnum :: Int -> VerticalAlign

fromEnum :: VerticalAlign -> Int

enumFrom :: VerticalAlign -> [VerticalAlign]

enumFromThen :: VerticalAlign -> VerticalAlign -> [VerticalAlign]

enumFromTo :: VerticalAlign -> VerticalAlign -> [VerticalAlign]

enumFromThenTo :: VerticalAlign -> VerticalAlign -> VerticalAlign -> [VerticalAlign]

Eq VerticalAlign

Defined in HExcel.Types

Methods

(==) :: VerticalAlign -> VerticalAlign -> Bool

(/=) :: VerticalAlign -> VerticalAlign -> Bool

Read VerticalAlign

Defined in HExcel.Types

Methods

readsPrec :: Int -> ReadS VerticalAlign

readList :: ReadS [VerticalAlign]

readPrec :: ReadPrec VerticalAlign

readListPrec :: ReadPrec [VerticalAlign]

Show VerticalAlign

Defined in HExcel.Types

Methods

showsPrec :: Int -> VerticalAlign -> ShowS

show :: VerticalAlign -> String

showList :: [VerticalAlign] -> ShowS

formatSetAlign :: Format -> Align -> IO ()

formatSetVerticalAlign :: Format -> VerticalAlign -> IO ()

formatSetTextWrap :: Format -> IO ()

formatSetRotation :: Format -> Int -> IO ()

formatSetShrink :: Format -> IO ()

data Pattern

Pattern styles

Constructors

PatternNone

PatternSolid

PatternMediumGray

PatternDarkGray

PatternLightGray

PatternDarkHorizontal

PatternDarkVertical

PatternDarkDown

PatternDarkUp

PatternDarkGrid

PatternDarkTrellis

PatternLightHorizontal

PatternLightVertical

PatternLightDown

PatternLightUp

PatternLightGrid

PatternLightTrellis

PatternGray125

PatternGray0625

Instances

Enum Pattern

Defined in HExcel.Types

Methods

succ :: Pattern -> Pattern

pred :: Pattern -> Pattern

toEnum :: Int -> Pattern

fromEnum :: Pattern -> Int

enumFrom :: Pattern -> [Pattern]

enumFromThen :: Pattern -> Pattern -> [Pattern]

enumFromTo :: Pattern -> Pattern -> [Pattern]

enumFromThenTo :: Pattern -> Pattern -> Pattern -> [Pattern]

Eq Pattern

Defined in HExcel.Types

Methods

(==) :: Pattern -> Pattern -> Bool

(/=) :: Pattern -> Pattern -> Bool

Read Pattern

Defined in HExcel.Types

Methods

readsPrec :: Int -> ReadS Pattern

readList :: ReadS [Pattern]

readPrec :: ReadPrec Pattern

readListPrec :: ReadPrec [Pattern]

Show Pattern

Defined in HExcel.Types

Methods

showsPrec :: Int -> Pattern -> ShowS

show :: Pattern -> String

showList :: [Pattern] -> ShowS

formatSetPattern :: Format -> Pattern -> IO ()

formatSetBackgroundColor :: Format -> Color -> IO ()

formatSetForegroundColor :: Format -> Color -> IO ()

data Border

Border options

Constructors

BorderAll

BorderBottom

BorderTop

BorderLeft

BorderRight

Instances

Eq Border

Defined in HExcel.Types

Methods

(==) :: Border -> Border -> Bool

(/=) :: Border -> Border -> Bool

Read Border

Defined in HExcel.Types

Methods

readsPrec :: Int -> ReadS Border

readList :: ReadS [Border]

readPrec :: ReadPrec Border

readListPrec :: ReadPrec [Border]

Show Border

Defined in HExcel.Types

Methods

showsPrec :: Int -> Border -> ShowS

show :: Border -> String

showList :: [Border] -> ShowS

data BorderStyle

Border styles

Constructors

BorderNone

BorderThin

BorderMedium

BorderDashed

BorderDotted

BorderThick

BorderDouble

BorderHair

BorderMediumDashed

BorderDashDot

BorderMediumDashDot

BorderDashDotDot

BorderMediumDashDotDot

BorderSlantDashDot

Instances

Enum BorderStyle

Defined in HExcel.Types

Methods

succ :: BorderStyle -> BorderStyle

pred :: BorderStyle -> BorderStyle

toEnum :: Int -> BorderStyle

fromEnum :: BorderStyle -> Int

enumFrom :: BorderStyle -> [BorderStyle]

enumFromThen :: BorderStyle -> BorderStyle -> [BorderStyle]

enumFromTo :: BorderStyle -> BorderStyle -> [BorderStyle]

enumFromThenTo :: BorderStyle -> BorderStyle -> BorderStyle -> [BorderStyle]

Eq BorderStyle

Defined in HExcel.Types

Methods

(==) :: BorderStyle -> BorderStyle -> Bool

(/=) :: BorderStyle -> BorderStyle -> Bool

Read BorderStyle

Defined in HExcel.Types

Methods

readsPrec :: Int -> ReadS BorderStyle

readList :: ReadS [BorderStyle]

readPrec :: ReadPrec BorderStyle

readListPrec :: ReadPrec [BorderStyle]

Show BorderStyle

Defined in HExcel.Types

Methods

showsPrec :: Int -> BorderStyle -> ShowS

show :: BorderStyle -> String

showList :: [BorderStyle] -> ShowS

formatSetBorder :: Format -> Border -> BorderStyle -> IO ()

formatSetBorderColor :: Format -> Border -> Color -> IO ()

data HExcelState

HExcelState is the state we thread trough for the writeCell function of the HExcel typeclass. We are trying to create a convenient api for writing cell values without too much hassle.

Constructors

HExcelState

Fields

• _hexcelStateFormat :: Maybe Format

  define a formatting to be used on all cells

• _hexcelStateSheet :: Worksheet

  define a worksheet to write to

• _hexcelStateRowCeiling :: Word32

  max row size

• _hexcelStateInitRow :: Row

  first row to write to

• _hexcelStateInitCol :: Col

  first column to write to

• _hexcelStateRow :: Row

  current row

• _hexcelStateCol :: Col

  current column

class HExcel a where

HExcel class that provides a single function writeCell as a convenient method of writing excel cell values

Methods

writeCell :: MonadIO m => a -> StateT HExcelState m ()

Instances

HExcel Double

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => Double -> StateT HExcelState m ()

HExcel Float

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => Float -> StateT HExcelState m ()

HExcel Int

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => Int -> StateT HExcelState m ()

HExcel Integer

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => Integer -> StateT HExcelState m ()

HExcel Word

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => Word -> StateT HExcelState m ()

HExcel String

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => String -> StateT HExcelState m ()

HExcel UTCTime

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => UTCTime -> StateT HExcelState m ()

HExcel DateTime

Defined in HExcel.HExcelInternal

Methods

writeCell :: MonadIO m => DateTime -> StateT HExcelState m ()

mkDocProperties :: DocProperties