Codec.Xlsx.Types.Internal.SharedStringTable

Main types

newtype SharedStringTable

Shared string table

A workbook can contain thousands of cells containing string (non-numeric) data. Furthermore this data is very likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared across the workbook is to improve performance in opening and saving the file by only reading and writing the repetitive information once.

Relevant parts of the EMCA standard (2nd edition, part 1, http://www.ecma-international.org/publications/standards/Ecma-376.htm), page numbers refer to the page in the PDF rather than the page number as printed on the page):

• Section 18.4, "Shared String Table" (p. 1712) in particular subsection 18.4.9, "sst (Shared String Table)" (p. 1726)

TODO: The extLst child element is currently unsupported.

Constructors

SharedStringTable

Fields

• sstTable :: Vector XlsxText

Instances

Eq SharedStringTable

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

Methods

(==) :: SharedStringTable -> SharedStringTable -> Bool

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

Ord SharedStringTable

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

Methods

compare :: SharedStringTable -> SharedStringTable -> Ordering

(<) :: SharedStringTable -> SharedStringTable -> Bool

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

(>) :: SharedStringTable -> SharedStringTable -> Bool

(>=) :: SharedStringTable -> SharedStringTable -> Bool

max :: SharedStringTable -> SharedStringTable -> SharedStringTable

min :: SharedStringTable -> SharedStringTable -> SharedStringTable

Show SharedStringTable

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

Methods

showsPrec :: Int -> SharedStringTable -> ShowS

show :: SharedStringTable -> String

showList :: [SharedStringTable] -> ShowS

Generic SharedStringTable

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

Associated Types

type Rep SharedStringTable :: Type -> Type

Methods

from :: SharedStringTable -> Rep SharedStringTable x

to :: Rep SharedStringTable x -> SharedStringTable

FromCursor SharedStringTable

See CT_Sst, p. 3902

The optional attributes count and uniqCount are being ignored at least currently

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

Methods

fromCursor :: Cursor -> [SharedStringTable]

ToElement SharedStringTable

See CT_Sst, p. 3902.

TODO: The count and uniqCount attributes are currently unsupported.

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

Methods

toElement :: Name -> SharedStringTable -> Element

ToDocument SharedStringTable

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

Methods

toDocument :: SharedStringTable -> Document

type Rep SharedStringTable

Defined in Codec.Xlsx.Types.Internal.SharedStringTable

type Rep SharedStringTable = D1 ('MetaData "SharedStringTable" "Codec.Xlsx.Types.Internal.SharedStringTable" "xlsx-0.8.4-HaLEmVo1ZhGFVO4n3Yfot" 'True) (C1 ('MetaCons "SharedStringTable" 'PrefixI 'True) (S1 ('MetaSel ('Just "sstTable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector XlsxText))))

sstConstruct :: [Worksheet] -> SharedStringTable

Construct the SharedStringsTable from an existing document

sstLookupText :: SharedStringTable -> Text -> Int

sstLookupRich :: SharedStringTable -> [RichTextRun] -> Int

sstItem :: SharedStringTable -> Int -> Maybe XlsxText

sstEmpty :: SharedStringTable