CoreXLSX Documentation Beta

Classes

XLSXFile

The entry point class that represents an open file handle to an existing .xlsx file on the user's filesystem.

Structures

Comments
Comment​List
Comment
Text
Path
Relationships

An array of Relationship values. This type directly maps the internal XML structure of the .xlsx format.

Relationship

Relationship to an entity stored in a given .xlsx archive. These can be worksheets, chartsheets, thumbnails and a few other internal entities. Most of the time users of CoreXLSX wouldn't need to handle relationships directly.

Shared​Strings

Strings in spreadsheet internals are frequently represented as strings shared between multiple worksheets. To parse a string value from a cell you should use stringValue(_: SharedStrings) function on Cell together with parseSharedString() on your XLSXFile instance.

Shared​Strings.​Item
Rich​Text
Rich​Text.​Family
Rich​Text.​Scheme
Rich​Text.​Size
Rich​Text.​Color
Rich​Text.​Font
Rich​Text.​Properties
Styles
Color
Number​Formats
Number​Format
Fonts
Font
Font.​Size
Font.​Name
Font.​Bold
Font.​Italic
Font.​Strike
Fills
Fill
Pattern​Fill
Borders
Border
Border.​Value
Cell​Style​Formats
Cell​Formats
Format

Storage for cell formatting properties. More details are available at datypic.com

Format.​Alignment
Cell​Styles
Cell​Style
Differential​Formats

Specifies a subset of formatting instead of applying formatting globally. More details are available at officeopenxml.com.

Table​Styles
Table​Style
Table​Style.​Element
Colors
Colors.​Indexed
Workbook
Workbook.​Views
Workbook.​View
Workbook.​Sheets
Workbook.​Sheet
Cell

The representation of a spreadsheet cell. More details of how cells are encoded in .xlsx internals are available at wiki.ucl.ac.uk.

Cell.​Formula
Cell​Reference
Column​Reference
Worksheet
Worksheet.​Properties
Worksheet.​Data
Worksheet.​Format​Properties
Worksheet.​Dimension
Page​Set​UpProperties
Sheet​Views
Sheet​View
Pane
Columns

An array of Column values. This type directly maps the internal XML structure of the .xlsx format.

Column

The styling information for a given column. Full specification for the internals of this type is available in Microsoft docs.

Row

The primary storage for spreadsheet cells.

Merge​Cells
Merge​Cell
Inline​String

Enumerations

Relationship.​Schema​Type
Cell​Type

The type of the value stored in a spreadsheet cell. The specification for the internals is available at datypic.com.

Core​XLSXError

Typealiases

Sheet​Data
Sheet​Pr
Sheet​Format​Pr
Worksheet​Dimension
Cols
Col
XLSXReader​Error