Codec.Xlsx.Types.Common

Documentation

newtype CellRef

Excel cell or cell range reference (e.g. E3) See 18.18.62 ST_Ref (p. 2482)

Constructors

CellRef

Fields

• unCellRef :: Text

Instances

Eq CellRef

Defined in Codec.Xlsx.Types.Common

Methods

(==) :: CellRef -> CellRef -> Bool

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

Ord CellRef

Defined in Codec.Xlsx.Types.Common

Methods

compare :: CellRef -> CellRef -> Ordering

(<) :: CellRef -> CellRef -> Bool

(<=) :: CellRef -> CellRef -> Bool

(>) :: CellRef -> CellRef -> Bool

(>=) :: CellRef -> CellRef -> Bool

max :: CellRef -> CellRef -> CellRef

min :: CellRef -> CellRef -> CellRef

Show CellRef

Defined in Codec.Xlsx.Types.Common

Methods

showsPrec :: Int -> CellRef -> ShowS

show :: CellRef -> String

showList :: [CellRef] -> ShowS

Generic CellRef

Defined in Codec.Xlsx.Types.Common

Associated Types

type Rep CellRef :: Type -> Type

Methods

from :: CellRef -> Rep CellRef x

to :: Rep CellRef x -> CellRef

NFData CellRef

Defined in Codec.Xlsx.Types.Common

Methods

rnf :: CellRef -> ()

FromAttrBs CellRef

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrBs :: ByteString -> Either Text CellRef

FromAttrVal CellRef

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrVal :: Reader CellRef

ToAttrVal CellRef

Defined in Codec.Xlsx.Types.Common

Methods

toAttrVal :: CellRef -> Text

type Rep CellRef

Defined in Codec.Xlsx.Types.Common

type Rep CellRef = D1 ('MetaData "CellRef" "Codec.Xlsx.Types.Common" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'True) (C1 ('MetaCons "CellRef" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCellRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

singleCellRef :: (Int, Int) -> CellRef

Render position in (row, col) format to an Excel reference.

mkCellRef (2, 4) == "D2"

fromSingleCellRef :: CellRef -> Maybe (Int, Int)

reverse to mkCellRef

fromSingleCellRefNoting :: CellRef -> (Int, Int)

reverse to mkCellRef expecting valid reference and failig with a standard error message like "Bad cell reference XXX"

type Range = CellRef

Excel range (e.g. D13:H14), actually store as as CellRef in xlsx

mkRange :: (Int, Int) -> (Int, Int) -> Range

Render range

mkRange (2, 4) (6, 8) == "D2:H6"

fromRange :: Range -> Maybe ((Int, Int), (Int, Int))

reverse to mkRange

newtype SqRef

A sequence of cell references

See 18.18.76 "ST_Sqref (Reference Sequence)" (p.2488)

Constructors

SqRef [CellRef]

Instances

Eq SqRef

Defined in Codec.Xlsx.Types.Common

Methods

(==) :: SqRef -> SqRef -> Bool

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

Ord SqRef

Defined in Codec.Xlsx.Types.Common

Methods

compare :: SqRef -> SqRef -> Ordering

(<) :: SqRef -> SqRef -> Bool

(<=) :: SqRef -> SqRef -> Bool

(>) :: SqRef -> SqRef -> Bool

(>=) :: SqRef -> SqRef -> Bool

max :: SqRef -> SqRef -> SqRef

min :: SqRef -> SqRef -> SqRef

Show SqRef

Defined in Codec.Xlsx.Types.Common

Methods

showsPrec :: Int -> SqRef -> ShowS

show :: SqRef -> String

showList :: [SqRef] -> ShowS

Generic SqRef

Defined in Codec.Xlsx.Types.Common

Associated Types

type Rep SqRef :: Type -> Type

Methods

from :: SqRef -> Rep SqRef x

to :: Rep SqRef x -> SqRef

NFData SqRef

Defined in Codec.Xlsx.Types.Common

Methods

rnf :: SqRef -> ()

FromAttrBs SqRef

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrBs :: ByteString -> Either Text SqRef

FromAttrVal SqRef

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrVal :: Reader SqRef

ToAttrVal SqRef

Defined in Codec.Xlsx.Types.Common

Methods

toAttrVal :: SqRef -> Text

type Rep SqRef

Defined in Codec.Xlsx.Types.Common

type Rep SqRef = D1 ('MetaData "SqRef" "Codec.Xlsx.Types.Common" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'True) (C1 ('MetaCons "SqRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CellRef])))

data XlsxText

Common type containing either simple string or rich formatted text. Used in si, comment and is elements

E.g. si spec says: "If the string is just a simple string with formatting applied at the cell level, then the String Item (si) should contain a single text element used to express the string. However, if the string in the cell is more complex - i.e., has formatting applied at the character level - then the string item shall consist of multiple rich text runs which collectively are used to express the string.". So we have either a single Text field, or else a list of RichTextRuns, each of which is some Text with layout properties.

TODO: Currently we do not support phoneticPr (Phonetic Properties, 18.4.3, p. 1723) or rPh (Phonetic Run, 18.4.6, p. 1725).

Section 18.4.8, "si (String Item)" (p. 1725)

See CT_Rst, p. 3903

Constructors

XlsxText Text

XlsxRichText [RichTextRun]

Instances

Eq XlsxText

Defined in Codec.Xlsx.Types.Common

Methods

(==) :: XlsxText -> XlsxText -> Bool

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

Ord XlsxText

Defined in Codec.Xlsx.Types.Common

Methods

compare :: XlsxText -> XlsxText -> Ordering

(<) :: XlsxText -> XlsxText -> Bool

(<=) :: XlsxText -> XlsxText -> Bool

(>) :: XlsxText -> XlsxText -> Bool

(>=) :: XlsxText -> XlsxText -> Bool

max :: XlsxText -> XlsxText -> XlsxText

min :: XlsxText -> XlsxText -> XlsxText

Show XlsxText

Defined in Codec.Xlsx.Types.Common

Methods

showsPrec :: Int -> XlsxText -> ShowS

show :: XlsxText -> String

showList :: [XlsxText] -> ShowS

Generic XlsxText

Defined in Codec.Xlsx.Types.Common

Associated Types

type Rep XlsxText :: Type -> Type

Methods

from :: XlsxText -> Rep XlsxText x

to :: Rep XlsxText x -> XlsxText

NFData XlsxText

Defined in Codec.Xlsx.Types.Common

Methods

rnf :: XlsxText -> ()

FromXenoNode XlsxText

Defined in Codec.Xlsx.Types.Common

Methods

fromXenoNode :: Node -> Either Text XlsxText

FromCursor XlsxText

See CT_Rst, p. 3903

Defined in Codec.Xlsx.Types.Common

Methods

fromCursor :: Cursor -> [XlsxText]

ToElement XlsxText

See CT_Rst, p. 3903

Defined in Codec.Xlsx.Types.Common

Methods

toElement :: Name -> XlsxText -> Element

type Rep XlsxText

Defined in Codec.Xlsx.Types.Common

type Rep XlsxText = D1 ('MetaData "XlsxText" "Codec.Xlsx.Types.Common" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'False) (C1 ('MetaCons "XlsxText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "XlsxRichText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RichTextRun])))

xlsxTextToCellValue :: XlsxText -> CellValue

newtype Formula

A formula

See 18.18.35 "ST_Formula (Formula)" (p. 2457)

Constructors

Formula

Fields

• unFormula :: Text

Instances

Eq Formula

Defined in Codec.Xlsx.Types.Common

Methods

(==) :: Formula -> Formula -> Bool

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

Ord Formula

Defined in Codec.Xlsx.Types.Common

Methods

compare :: Formula -> Formula -> Ordering

(<) :: Formula -> Formula -> Bool

(<=) :: Formula -> Formula -> Bool

(>) :: Formula -> Formula -> Bool

(>=) :: Formula -> Formula -> Bool

max :: Formula -> Formula -> Formula

min :: Formula -> Formula -> Formula

Show Formula

Defined in Codec.Xlsx.Types.Common

Methods

showsPrec :: Int -> Formula -> ShowS

show :: Formula -> String

showList :: [Formula] -> ShowS

Generic Formula

Defined in Codec.Xlsx.Types.Common

Associated Types

type Rep Formula :: Type -> Type

Methods

from :: Formula -> Rep Formula x

to :: Rep Formula x -> Formula

NFData Formula

Defined in Codec.Xlsx.Types.Common

Methods

rnf :: Formula -> ()

FromAttrBs Formula

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrBs :: ByteString -> Either Text Formula

FromXenoNode Formula

Defined in Codec.Xlsx.Types.Common

Methods

fromXenoNode :: Node -> Either Text Formula

FromAttrVal Formula

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrVal :: Reader Formula

FromCursor Formula

See ST_Formula, p. 3873

Defined in Codec.Xlsx.Types.Common

Methods

fromCursor :: Cursor -> [Formula]

ToElement Formula

See ST_Formula, p. 3873

Defined in Codec.Xlsx.Types.Common

Methods

toElement :: Name -> Formula -> Element

type Rep Formula

Defined in Codec.Xlsx.Types.Common

type Rep Formula = D1 ('MetaData "Formula" "Codec.Xlsx.Types.Common" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'True) (C1 ('MetaCons "Formula" 'PrefixI 'True) (S1 ('MetaSel ('Just "unFormula") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data CellValue

Cell values include text, numbers and booleans, standard includes date format also but actually dates are represented by numbers with a date format assigned to a cell containing it

Constructors

CellText Text

CellDouble Double

CellBool Bool

CellRich [RichTextRun]

CellError ErrorType

Instances

Eq CellValue

Defined in Codec.Xlsx.Types.Common

Methods

(==) :: CellValue -> CellValue -> Bool

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

Ord CellValue

Defined in Codec.Xlsx.Types.Common

Methods

compare :: CellValue -> CellValue -> Ordering

(<) :: CellValue -> CellValue -> Bool

(<=) :: CellValue -> CellValue -> Bool

(>) :: CellValue -> CellValue -> Bool

(>=) :: CellValue -> CellValue -> Bool

max :: CellValue -> CellValue -> CellValue

min :: CellValue -> CellValue -> CellValue

Show CellValue

Defined in Codec.Xlsx.Types.Common

Methods

showsPrec :: Int -> CellValue -> ShowS

show :: CellValue -> String

showList :: [CellValue] -> ShowS

Generic CellValue

Defined in Codec.Xlsx.Types.Common

Associated Types

type Rep CellValue :: Type -> Type

Methods

from :: CellValue -> Rep CellValue x

to :: Rep CellValue x -> CellValue

NFData CellValue

Defined in Codec.Xlsx.Types.Common

Methods

rnf :: CellValue -> ()

type Rep CellValue

Defined in Codec.Xlsx.Types.Common

type Rep CellValue = D1 ('MetaData "CellValue" "Codec.Xlsx.Types.Common" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'False) ((C1 ('MetaCons "CellText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "CellDouble" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :+: (C1 ('MetaCons "CellBool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :+: (C1 ('MetaCons "CellRich" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RichTextRun])) :+: C1 ('MetaCons "CellError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ErrorType)))))

data ErrorType

The evaluation of an expression can result in an error having one of a number of error values.

See Annex L, L.2.16.8 "Error values" (p. 4764)

Constructors

ErrorDiv0

#DIV/0! - Intended to indicate when any number, including zero, is divided by zero.

ErrorNA

#N/A - Intended to indicate when a designated value is not available. For example, some functions, such as SUMX2MY2, perform a series of operations on corresponding elements in two arrays. If those arrays do not have the same number of elements, then for some elements in the longer array, there are no corresponding elements in the shorter one; that is, one or more values in the shorter array are not available. This error value can be produced by calling the function NA.

ErrorName

#NAME? - Intended to indicate when what looks like a name is used, but no such name has been defined. For example, XYZ/3, where XYZ is not a defined name. Total is & A10, where neither Total nor is is a defined name. Presumably, "Total is " & A10 was intended. SUM(A1C10), where the range A1:C10 was intended.

ErrorNull

#NULL! - Intended to indicate when two areas are required to intersect, but do not. For example, In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary intersection operator, when a comma was intended.

ErrorNum

#NUM! - Intended to indicate when an argument to a function has a compatible type, but has a value that is outside the domain over which that function is defined. (This is known as a domain error.) For example, Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors. Intended to indicate that the result of a function cannot be represented in a value of the specified type, typically due to extreme magnitude. (This is known as a range error.) For example, FACT(1000) might result in a range error.

ErrorRef

#REF! - Intended to indicate when a cell reference is invalid. For example, If a formula contains a reference to a cell, and then the row or column containing that cell is deleted, a #REF! error results. If a worksheet does not support 20,001 columns, OFFSET(A1,0,20000) results in a #REF! error.

ErrorValue

#VALUE! - Intended to indicate when an incompatible type argument is passed to a function, or an incompatible type operand is used with an operator. For example, In the case of a function argument, a number was expected, but text was provided. In the case of 1+ABC, the binary addition operator is not defined for text.

Instances

Eq ErrorType

Defined in Codec.Xlsx.Types.Common

Methods

(==) :: ErrorType -> ErrorType -> Bool

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

Ord ErrorType

Defined in Codec.Xlsx.Types.Common

Methods

compare :: ErrorType -> ErrorType -> Ordering

(<) :: ErrorType -> ErrorType -> Bool

(<=) :: ErrorType -> ErrorType -> Bool

(>) :: ErrorType -> ErrorType -> Bool

(>=) :: ErrorType -> ErrorType -> Bool

max :: ErrorType -> ErrorType -> ErrorType

min :: ErrorType -> ErrorType -> ErrorType

Show ErrorType

Defined in Codec.Xlsx.Types.Common

Methods

showsPrec :: Int -> ErrorType -> ShowS

show :: ErrorType -> String

showList :: [ErrorType] -> ShowS

Generic ErrorType

Defined in Codec.Xlsx.Types.Common

Associated Types

type Rep ErrorType :: Type -> Type

Methods

from :: ErrorType -> Rep ErrorType x

to :: Rep ErrorType x -> ErrorType

NFData ErrorType

Defined in Codec.Xlsx.Types.Common

Methods

rnf :: ErrorType -> ()

FromAttrBs ErrorType

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrBs :: ByteString -> Either Text ErrorType

FromAttrVal ErrorType

Defined in Codec.Xlsx.Types.Common

Methods

fromAttrVal :: Reader ErrorType

ToAttrVal ErrorType

Defined in Codec.Xlsx.Types.Common

Methods

toAttrVal :: ErrorType -> Text

type Rep ErrorType

Defined in Codec.Xlsx.Types.Common

type Rep ErrorType = D1 ('MetaData "ErrorType" "Codec.Xlsx.Types.Common" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'False) ((C1 ('MetaCons "ErrorDiv0" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ErrorNA" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ErrorName" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ErrorNull" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ErrorNum" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ErrorRef" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ErrorValue" 'PrefixI 'False) (U1 :: Type -> Type))))

data DateBase

Specifies date base used for conversion of serial values to and from datetime values

See Annex L, L.2.16.9.1 "Date Conversion for Serial Values" (p. 4765)

Constructors

DateBase1900

1900 date base system, the lower limit is January 1, -9999 00:00:00, which has serial value -4346018. The upper-limit is December 31, 9999, 23:59:59, which has serial value 2,958,465.9999884. The base date for this date base system is December 30, 1899, which has a serial value of 0.

DateBase1904

1904 backward compatibility date-base system, the lower limit is January 1, 1904, 00:00:00, which has serial value 0. The upper limit is December 31, 9999, 23:59:59, which has serial value 2,957,003.9999884. The base date for this date base system is January 1, 1904, which has a serial value of 0.

Instances

Eq DateBase

Defined in Codec.Xlsx.Types.Common

Methods

(==) :: DateBase -> DateBase -> Bool

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

Show DateBase

Defined in Codec.Xlsx.Types.Common

Methods

showsPrec :: Int -> DateBase -> ShowS

show :: DateBase -> String

showList :: [DateBase] -> ShowS

Generic DateBase

Defined in Codec.Xlsx.Types.Common

Associated Types

type Rep DateBase :: Type -> Type

Methods

from :: DateBase -> Rep DateBase x

to :: Rep DateBase x -> DateBase

NFData DateBase

Defined in Codec.Xlsx.Types.Common

Methods

rnf :: DateBase -> ()

type Rep DateBase

Defined in Codec.Xlsx.Types.Common

type Rep DateBase = D1 ('MetaData "DateBase" "Codec.Xlsx.Types.Common" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'False) (C1 ('MetaCons "DateBase1900" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DateBase1904" 'PrefixI 'False) (U1 :: Type -> Type))

dateFromNumber :: RealFrac t => DateBase -> t -> UTCTime

Convertts serial value into datetime according to the specified date base

show (dateFromNumber DateBase1900 42929.75) == "2017-07-13 18:00:00 UTC"

dateToNumber :: Fractional a => DateBase -> UTCTime -> a

Converts datetime into serial value

int2col :: Int -> Text

convert column number (starting from 1) to its textual form (e.g. 3 -> "C")

col2int :: Text -> Int

reverse to int2col