OpenXLSX Namespace Reference

Namespaces
namespace	Crypto
namespace	DistanceLiterals
namespace	IndexLiterals

Data Structures
struct	EnumStringMap
class	IZipArchive
	This class functions as a wrapper around any class that provides the necessary functionality for a zip archive. More...
class	NameProxy
class	OpenXLSX_xml_document
class	OpenXLSX_xml_node
struct	StringViewHash
struct	VisitXLCellValueTypeToDouble
struct	VisitXLCellValueTypeToString
class	XLAlignment
	An encapsulation of an alignment item. More...
class	XLAppProperties
	The XLAppProperties class represents the extended/application properties (docProps/app.xml). More...
struct	XLASTNode
	Polymorphic AST node. Uses a tagged-union approach with std::unique_ptr children. More...
class	XLAutoFilter
class	XLAxis
class	XLBorder
	An encapsulation of a border item. More...
class	XLBorders
	An encapsulation of the XLSX borders. More...
class	XLCell
	An implementation class encapsulating the properties and behaviours of a spreadsheet cell. More...
class	XLCellAddressError
class	XLCellAssignable
class	XLCellFormat
	An encapsulation of a cell format item. More...
class	XLCellFormats
	An encapsulation of the XLSX cell style formats. More...
class	XLCellIterator
	A forward iterator for iterating over a range of cells. More...
class	XLCellRange
	Represents a rectangular area of cells within a worksheet. More...
class	XLCellReference
class	XLCellStyle
	An encapsulation of a cell style item. More...
class	XLCellStyles
	An encapsulation of the XLSX cell styles. More...
class	XLCellValue
	Class encapsulating a cell value. More...
class	XLCellValueProxy
	The XLCellValueProxy class is used for proxy (or placeholder) objects for XLCellValue objects. More...
class	XLCfColorScale
class	XLCfDataBar
class	XLCfIconSet
class	XLCfRule
class	XLCfRules
class	XLCfvo
class	XLChart
struct	XLChartAnchor
class	XLChartSeries
class	XLChartsheet
	Class representing an Excel chartsheet. More...
struct	XLColIndex
class	XLColor
class	XLColumn
class	XLCommand
class	XLComment
	An encapsulation of a comment element. More...
class	XLComments
	The XLComments class is the base class for worksheet comments. More...
class	XLConditionalFormat
class	XLConditionalFormats
class	XLContentItem
class	XLContentTypes
	The purpose of this class is to load, store add and save item in the [Content_Types].xml file. More...
struct	XLCoordinates
class	XLCustomProperties
	The XLCustomProperties class represents custom user-defined properties (docProps/custom.xml). More...
class	XLDataBarColor
	An encapsulation of an XLSX Data Bar Color (CT_Color) item. More...
class	XLDataValidation
struct	XLDataValidationConfig
class	XLDataValidations
class	XLDateTime
	Manages date and time values according to the Excel 1900 date system. More...
class	XLDateTimeError
class	XLDefinedName
	A class representing a single defined name in a workbook. More...
class	XLDefinedNames
	A class representing the collection of defined names in a workbook. More...
class	XLDistance
class	XLDocument
	This class encapsulates the concept of an excel file. It is different from the XLWorkbook, in that an XLDocument holds an XLWorkbook together with its metadata, as well as methods for opening, closing and saving the document. The XLDocument is the entrypoint for clients using the RapidXLSX library. More...
class	XLDrawing
	The XLDrawing class is the base class for worksheet drawings (images, charts, etc.) More...
class	XLDrawingItem
class	XLDxf
	An encapsulation of a differential cell format item (DXF) More...
class	XLDxfs
	An encapsulation of the XLSX differential cell formats (dxfs) More...
class	XLEMUConverter
	Utility for handling Excel's complex coordinate and measurement conversions. Excel uses EMU (English Metric Units) for drawings. 1 inch = 914400 EMUs. At 96 DPI (Standard), 1 pixel = 9525 EMUs. More...
class	XLException
class	XLFill
	An encapsulation of a fill item. More...
class	XLFills
	An encapsulation of the XLSX fills. More...
class	XLFilterColumn
	The XLFilterColumn class encapsulates the <filterColumn> XML node. It allows setting different kinds of filter criteria for a specific column in an AutoFilter range. More...
class	XLFont
	An encapsulation of a font item. More...
class	XLFonts
	An encapsulation of the XLSX fonts. More...
class	XLFormula
	The XLFormula class encapsulates the concept of an Excel formula. The class is essentially a wrapper around a std::string. More...
class	XLFormulaArg
	Lightweight formula evaluation engine. More...
class	XLFormulaEngine
class	XLFormulaError
class	XLFormulaLexer
	Tokenises a raw Excel formula string (with or without leading '='). More...
class	XLFormulaParser
	Recursive-descent (Pratt) parser that converts a token stream into an AST. More...
class	XLFormulaProxy
	The XLFormulaProxy serves as a placeholder for XLFormula objects. This enable getting and setting formulas through the same interface. More...
class	XLGradientStop
	An encapsulation of an fill::gradientFill::stop item. More...
class	XLGradientStops
	An encapsulation of an array of fill::gradientFill::stop items. More...
class	XLHeaderFooter
	A class representing the page setup of a worksheet. More...
struct	XLImageOptions
	Options for inserting an image into a worksheet. More...
class	XLImageParser
	Parses binary image headers (PNG, JPG, GIF) to extract width and height without external dependencies. More...
struct	XLImageSize
class	XLInputError
class	XLInternalAccess
	Passkey Idiom for internal access control. Only the specified friend classes can instantiate this passkey. This prevents public API users from calling internal XLDocument methods. More...
class	XLInternalError
class	XLLine
	An encapsulation of a line item. More...
class	XLMergeCells
	Manages merged cell ranges in a worksheet. More...
class	XLNumberFormat
	An encapsulation of a number format (numFmt) item. More...
class	XLNumberFormats
	An encapsulation of the XLSX number formats (numFmts) More...
class	XLOverflowError
class	XLPageMargins
	A class representing the page margins of a worksheet. More...
class	XLPageSetup
class	XLPerson
	A proxy class encapsulating a single person (author) entity. More...
class	XLPersons
	A class encapsulating modern Excel persons metadata (persons.xml) More...
class	XLPivotCacheDefinition
class	XLPivotCacheRecords
struct	XLPivotField
class	XLPivotTable
class	XLPivotTableOptions
class	XLPrintOptions
	A class representing the print options of a worksheet. More...
class	XLProperties
	The XLProperties class represents the core properties of the document (docProps/core.xml). More...
class	XLPropertyError
class	XLQuery
class	XLRelationshipItem
class	XLRelationships
class	XLRichText
	A class representing rich text in a cell. More...
class	XLRichTextRun
	A class representing a single run of rich text. More...
class	XLRow
	The XLRow class represent a row in an Excel spreadsheet. Using XLRow objects, various row formatting options can be set and modified. More...
class	XLRowDataIterator
	This class encapsulates a (non-const) iterator, for iterating over the cells in a row. More...
class	XLRowDataProxy
	The XLRowDataProxy is used as a proxy object when getting or setting row data. The class facilitates easy conversion to/from containers. More...
class	XLRowDataRange
	This class encapsulates the concept of a contiguous range of cells in a row. More...
struct	XLRowIndex
class	XLRowIterator
class	XLRowRange
class	XLShape
class	XLShapeClientData
	An encapsulation of a shape client data element x:ClientData. More...
class	XLShapeStyle
struct	XLShapeStyleAttribute
class	XLSharedStrings
	This class encapsulate the Excel concept of Shared Strings. In Excel, instead of havig individual strings in each cell, cells have a reference to an entry in the SharedStrings register. This results in smalle file sizes, as repeated strings are referenced easily. More...
struct	XLSharedStringsState
class	XLSheet
	The XLAbstractSheet is a generalized sheet class, which functions as superclass for specialized classes, such as XLWorksheet. It implements functionality common to all sheet types. This is a pure abstract class, so it cannot be instantiated. More...
class	XLSheetBase
	The XLSheetBase class is the base class for the XLWorksheet and XLChartsheet classes. However, it is not a base class in the traditional sense. Rather, it provides common functionality that is inherited via the CRTP (Curiously Recurring Template Pattern) pattern. More...
class	XLSheetError
struct	XLSheetProtectionOptions
	A structure defining all granular sheet protection options. More...
struct	XLSlicerOptions
class	XLSparkline
	The XLSparkline class encapsulates a single sparkline group in a worksheet. More...
struct	XLSparklineOptions
	The XLSparklineOptions struct encapsulates configuration for a sparkline group. More...
class	XLStreamCell
	A structure that represents a cell to be appended via the streaming API. More...
class	XLStreamReader
class	XLStreamWriter
class	XLStringArena
	String memory pool (Arena Allocator) with block recycling. More...
struct	XLStyle
	A high-level, human-ergonomic structure representing the styling of a cell or range. This acts as a builder and facade over the complex underlying OpenXLSX XLStyles system. More...
class	XLStyles
	An encapsulation of the styles file (xl/styles.xml) in an Excel document package. More...
class	XLTable
	The XLTable class represents a single Excel table (.xml file). More...
class	XLTableCollection
	The XLTableCollection class manages multiple tables within a worksheet. More...
class	XLTableColumn
	The XLTableColumn class encapsulates the <tableColumn> XML node. It allows setting different kinds of column properties in a table. More...
class	XLThreadedComment
	A proxy class encapsulating a single modern threaded comment. More...
class	XLThreadedComments
	A class encapsulating modern Excel threaded comments (ThreadedComments.xml) More...
struct	XLToken
	A single lexical token from a formula string. More...
class	XLUnsupportedElement
	The XLUnsupportedElement class provides a stub implementation that can be used as function parameter or return type for currently unsupported XML features. More...
class	XLValueTypeError
struct	XLVectorShapeOptions
class	XLVmlDrawing
	The XLVmlDrawing class is the base class for worksheet comments. More...
class	XLWorkbook
	This class encapsulates the concept of a Workbook. It provides access to the individual sheets (worksheets or chartsheets), as well as functionality for adding, deleting, moving and renaming sheets. More...
class	XLWorksheet
	A class encapsulating an Excel worksheet. Access to XLWorksheet objects should be via the workbook object. More...
struct	XLWorksheetImpl
class	XLXmlData
	The XLXmlData class encapsulates the properties and behaviour of the .xml files in an .xlsx file zip package. Objects of the XLXmlData type are intended to be stored centrally in an XLDocument object, from where they can be retrieved by other objects that encapsulates the behaviour of Excel elements, such as XLWorkbook and XLWorksheet. More...
class	XLXmlFile
	The XLXmlFile class provides an interface for derived classes to use. It functions as an ancestor to all classes which are represented by an .xml file in an .xlsx package. More...
class	XLXmlSavingDeclaration
	The XLXmlSavingDeclaration class encapsulates the properties of an XML saving declaration, that can be used in calls to XLXmlData::getRawData to enforce specific settings. More...
class	XLZipArchive

Typedefs
using	XLCellResolver = std::function< XLCellValue(std::string_view ref)>
	Callback type: resolves a cell reference string to a cell value.
typedef int32_t	XLMergeIndex
template<typename Key , typename Value >
using	FlatHashMap = ankerl::unordered_dense::map< Key, Value, StringViewHash, std::equal_to<> >
typedef std::reference_wrapper< const XLSharedStrings >	XLSharedStringsRef
using	XLStyleIndex = size_t
using	XLDiffCellFormat = XLDxf
	Backward compatibility alias.
using	XLDiffCellFormats = XLDxfs
	Backward compatibility alias.
using	XLTables = XLTableCollection
using	XMLNode = OpenXLSX_xml_node
using	XMLAttribute = pugi::xml_attribute
using	XMLDocument = OpenXLSX_xml_document

Enumerations
enum class	XLFilterLogic { And , Or }
	Enum class defining the logical operator for custom filters. More...
enum class	XLValueType {   Empty , Boolean , Integer , Float ,   Error , String , RichText }
	Enum defining the valid value types for a an Excel spreadsheet cell. More...
enum class	XLChartType {   Bar , BarStacked , BarPercentStacked , Bar3D ,   Bar3DStacked , Bar3DPercentStacked , Column , ColumnStacked ,   ColumnPercentStacked , Column3D , Column3DStacked , Column3DPercentStacked ,   Line , LineStacked , LinePercentStacked , Line3D ,   Pie , Pie3D , Scatter , ScatterLine ,   ScatterLineMarker , ScatterSmooth , ScatterSmoothMarker , ScatterMarker ,   Bubble , StockHLC , StockOHLC , Surface ,   Surface3D , SurfaceWireframe , Surface3DWireframe , Area ,   AreaStacked , AreaPercentStacked , Area3D , Area3DStacked ,   Area3DPercentStacked , Doughnut , Radar , RadarFilled ,   RadarMarkers }
enum class	XLLegendPosition {   Bottom , Left , Right , Top ,   TopRight , Hidden }
enum class	XLMarkerStyle {   None , Circle , Dash , Diamond ,   Dot , Picture , Plus , Square ,   Star , Triangle , X , Default }
enum class	XLErrorBarDirection { X , Y }
enum class	XLErrorBarType { Both , Minus , Plus }
enum class	XLErrorBarValueType {   Custom , FixedValue , Percentage , StandardDeviation ,   StandardError }
enum class	XLTrendlineType {   Linear , Exponential , Logarithmic , Polynomial ,   Power , MovingAverage }
enum class	XLAxisOrientation { MinMax , MaxMin }
enum class	XLAxisCrosses { AutoZero , Min , Max }
enum class	XLCommandType : uint8_t {   SetSheetName , SetSheetVisibility , SetSheetIndex , SetSheetActive ,   ResetCalcChain , SetFullCalcOnLoad , CheckAndFixCoreProperties , CheckAndFixExtendedProperties ,   CheckAndFixCustomProperties , AddSharedStrings , AddWorksheet , AddChartsheet ,   DeleteSheet , CloneSheet , AddStyles }
enum class	XLQueryType : uint8_t {   QuerySheetName , QuerySheetIndex , QuerySheetVisibility , QuerySheetIsActive ,   QuerySheetType , QuerySheetID , QuerySheetRelsID , QuerySheetRelsTarget ,   QuerySharedStrings , QueryXmlData }
enum class	XLCfType : uint8_t {   Expression = 0 , CellIs = 1 , ColorScale = 2 , DataBar = 3 ,   IconSet = 4 , Top10 = 5 , UniqueValues = 6 , DuplicateValues = 7 ,   ContainsText = 8 , NotContainsText = 9 , BeginsWith = 10 , EndsWith = 11 ,   ContainsBlanks = 12 , NotContainsBlanks = 13 , ContainsErrors = 14 , NotContainsErrors = 15 ,   TimePeriod = 16 , AboveAverage = 17 , Invalid = 255 }
enum class	XLCfOperator : uint8_t {   LessThan = 0 , LessThanOrEqual = 1 , Equal = 2 , NotEqual = 3 ,   GreaterThanOrEqual = 4 , GreaterThan = 5 , Between = 6 , NotBetween = 7 ,   ContainsText = 8 , NotContains = 9 , BeginsWith = 10 , EndsWith = 11 ,   Invalid = 255 }
enum class	XLCfTimePeriod : uint8_t {   Today = 0 , Yesterday = 1 , Tomorrow = 2 , Last7Days = 3 ,   ThisMonth = 4 , LastMonth = 5 , NextMonth = 6 , ThisWeek = 7 ,   LastWeek = 8 , NextWeek = 9 , Invalid = 255 }
enum class	XLCfvoType : uint8_t {   Min = 0 , Max = 1 , Number = 2 , Percent = 3 ,   Formula = 4 , Percentile = 5 , Invalid = 255 }
enum class	XLDataBarDirection : uint8_t { Context = 0 , LeftToRight = 1 , RightToLeft = 2 }
enum class	XLDataBarAxisPosition : uint8_t { Automatic = 0 , Middle = 1 , None = 2 }
enum class	XLContentType : uint8_t {   Workbook , Relationships , WorkbookMacroEnabled , Worksheet ,   Chartsheet , ExternalLink , Theme , Styles ,   SharedStrings , Drawing , Chart , ChartStyle ,   ChartColorStyle , ControlProperties , CalculationChain , VBAProject ,   CoreProperties , ExtendedProperties , CustomProperties , Comments ,   Table , VMLDrawing , Hyperlink , Unknown ,   PivotTable , Slicer , SlicerCache , PivotCacheDefinition ,   PivotCacheRecords , ThreadedComments , Persons }
enum class	XLDataValidationType {   None , Custom , Date , Decimal ,   List , TextLength , Time , Whole }
enum class	XLDataValidationOperator {   Between , Equal , GreaterThan , GreaterThanOrEqual ,   LessThan , LessThanOrEqual , NotBetween , NotEqual }
enum class	XLDataValidationErrorStyle { Stop , Warning , Information }
enum class	XLIMEMode {   NoControl , Off , On , Disabled ,   Hiragana , FullKatakana , HalfKatakana , FullAlpha ,   HalfAlpha , FullHangul , HalfHangul }
	IME (Input Method Editor) mode for data validation. More...
enum class	XLProperty {   Title , Subject , Creator , Keywords ,   Description , LastModifiedBy , LastPrinted , CreationDate ,   ModificationDate , Category , Application , DocSecurity ,   ScaleCrop , Manager , Company , LinksUpToDate ,   SharedDoc , HyperlinkBase , HyperlinksChanged , AppVersion }
	The XLDocumentProperties class is an enumeration of the possible properties (metadata) that can be set for a XLDocument object (and .xlsx file) More...
enum class	XLShapeTextVAlign : uint8_t { Center = 3 , Top = 4 , Bottom = 5 , Invalid = 255 }
enum class	XLShapeTextHAlign : uint8_t { Left = 1 , Right = 2 , Center = 3 , Invalid = 255 }
enum class	XLVectorShapeType {   Rectangle , Ellipse , Line , Triangle ,   RightTriangle , Arrow , Diamond , Parallelogram ,   Hexagon , Star4 , Star5 , Star16 ,   Star24 , Heart , SmileyFace , Cloud ,   Donut , Ribbon , Sun , Moon ,   LightningBolt , FlowChartProcess , FlowChartDecision , FlowChartDocument ,   FlowChartData }
	An encapsulation of a drawing item (e.g. an image) More...
enum class	XLDynamicFilterType {   Null , AboveAverage , BelowAverage , Tomorrow ,   Today , Yesterday , NextWeek , ThisWeek ,   LastWeek , NextMonth , ThisMonth , LastMonth ,   NextQuarter , ThisQuarter , LastQuarter , NextYear ,   ThisYear , LastYear , YearToDate , Q1 ,   Q2 , Q3 , Q4 , M1 ,   M2 , M3 , M4 , M5 ,   M6 , M7 , M8 , M9 ,   M10 , M11 , M12 }
	Enum defining all valid dynamic filter types according to ECMA-376 18.18.25. More...
enum class	XLTokenKind : uint8_t {   Number , String , Bool , CellRef ,   Ident , Plus , Minus , Star ,   Slash , Caret , Percent , Amp ,   Eq , NEq , Lt , Le ,   Gt , Ge , LParen , RParen ,   Comma , Semicolon , Colon , End ,   Error }
	Kinds of tokens produced by the lexer. More...
enum class	XLNodeKind : uint8_t {   Number , StringLit , BoolLit , CellRef ,   Range , BinOp , UnaryOp , FuncCall ,   ErrorLit }
	Kind discriminator for AST nodes. More...
enum class	XLImagePositioning { OneCell , TwoCell , Absolute }
	Determines how an image behaves when cells are resized or inserted/deleted. More...
enum class	XLIteratorDirection { Forward , Reverse }
enum class	XLIteratorLocation { Begin , End }
enum class	XLPageOrientation { Default , Portrait , Landscape }
	Enum defining page orientation. More...
enum class	XLPivotSubtotal {   Sum , Average , Count , Max ,   Min , Product }
enum class	XLRelationshipType {   CoreProperties , ExtendedProperties , CustomProperties , Workbook ,   Worksheet , Chartsheet , Dialogsheet , Macrosheet ,   CalculationChain , ExternalLink , ExternalLinkPath , Theme ,   Styles , Chart , ChartStyle , ChartColorStyle ,   Image , Drawing , VMLDrawing , SharedStrings ,   PrinterSettings , VBAProject , ControlProperties , Comments ,   Table , Hyperlink , Unknown , PivotTable ,   Slicer , SlicerCache , PivotCacheDefinition , PivotCacheRecords ,   ThreadedComments , Person }
	An enum of the possible relationship (or XML document) types used in relationship (.rels) XML files. More...
enum class	XLSheetState : uint8_t { Visible , Hidden , VeryHidden }
	The XLSheetState is an enumeration of the possible (visibility) states, e.g. Visible or Hidden. More...
enum class	XLPaneState : uint8_t { Split , Frozen , FrozenSplit }
	The XLPaneState is an enumeration of the possible states of a pane, e.g. Frozen or Split. More...
enum class	XLPane : uint8_t { BottomRight , TopRight , BottomLeft , TopLeft }
	The XLPane is an enumeration of the possible pane identifiers. More...
enum class	XLSparklineType { Line , Column , Stacked }
	The XLSparklineType enum represents the type of a sparkline. More...
enum	XLUnderlineStyle : uint8_t {   XLUnderlineNone = 0 , XLUnderlineSingle = 1 , XLUnderlineDouble = 2 , XLUnderlineSingleAccounting = 3 ,   XLUnderlineDoubleAccounting = 4 , XLUnderlineInvalid = 255 }
enum	XLFontSchemeStyle : uint8_t { XLFontSchemeNone = 0 , XLFontSchemeMajor = 1 , XLFontSchemeMinor = 2 , XLFontSchemeInvalid = 255 }
enum	XLVerticalAlignRunStyle : uint8_t { XLBaseline = 0 , XLSubscript = 1 , XLSuperscript = 2 , XLVerticalAlignRunInvalid = 255 }
enum	XLFillType : uint8_t { XLGradientFill = 0 , XLPatternFill = 1 , XLFillTypeInvalid = 255 }
enum	XLGradientType : uint8_t { XLGradientLinear = 0 , XLGradientPath = 1 , XLGradientTypeInvalid = 255 }
enum	XLPatternType : uint8_t {   XLPatternNone = 0 , XLPatternSolid = 1 , XLPatternMediumGray = 2 , XLPatternDarkGray = 3 ,   XLPatternLightGray = 4 , XLPatternDarkHorizontal = 5 , XLPatternDarkVertical = 6 , XLPatternDarkDown = 7 ,   XLPatternDarkUp = 8 , XLPatternDarkGrid = 9 , XLPatternDarkTrellis = 10 , XLPatternLightHorizontal = 11 ,   XLPatternLightVertical = 12 , XLPatternLightDown = 13 , XLPatternLightUp = 14 , XLPatternLightGrid = 15 ,   XLPatternLightTrellis = 16 , XLPatternGray125 = 17 , XLPatternGray0625 = 18 , XLPatternTypeInvalid = 255 }
enum	XLLineType : uint8_t {   XLLineLeft = 0 , XLLineRight = 1 , XLLineTop = 2 , XLLineBottom = 3 ,   XLLineDiagonal = 4 , XLLineVertical = 5 , XLLineHorizontal = 6 , XLLineInvalid = 255 }
enum	XLLineStyle : uint8_t {   XLLineStyleNone = 0 , XLLineStyleThin = 1 , XLLineStyleMedium = 2 , XLLineStyleDashed = 3 ,   XLLineStyleDotted = 4 , XLLineStyleThick = 5 , XLLineStyleDouble = 6 , XLLineStyleHair = 7 ,   XLLineStyleMediumDashed = 8 , XLLineStyleDashDot = 9 , XLLineStyleMediumDashDot = 10 , XLLineStyleDashDotDot = 11 ,   XLLineStyleMediumDashDotDot = 12 , XLLineStyleSlantDashDot = 13 , XLLineStyleInvalid = 255 }
enum	XLAlignmentStyle : uint8_t {   XLAlignGeneral = 0 , XLAlignLeft = 1 , XLAlignRight = 2 , XLAlignCenter = 3 ,   XLAlignTop = 4 , XLAlignBottom = 5 , XLAlignFill = 6 , XLAlignJustify = 7 ,   XLAlignCenterContinuous = 8 , XLAlignDistributed = 9 , XLAlignInvalid = 255 }
enum	XLReadingOrder : uint32_t { XLReadingOrderContextual = 0 , XLReadingOrderLeftToRight = 1 , XLReadingOrderRightToLeft = 2 }
enum class	XLTotalsRowFunction {   None , Sum , Min , Max ,   Average , Count , CountNums , StdDev ,   Var , Custom }
	Enum class defining the possible functions for a table's totals row. More...
enum class	XLSheetType { Worksheet , Chartsheet , Dialogsheet , Macrosheet }
	Enumeration of the different types of sheets. More...

Functions
bool	operator== (const XLCell &lhs, const XLCell &rhs)
bool	operator!= (const XLCell &lhs, const XLCell &rhs)
std::ostream &	operator<< (std::ostream &os, const XLCell &c)
	ostream output of XLCell content
std::ostream &	operator<< (std::ostream &os, const XLCellAssignable &c)
	ostream output of XLCellAssignable content
XMLNode	findRowNode (XMLNode sheetDataNode, uint32_t rowNumber)
	locate the XML row node within sheetDataNode for the row at rowNumber
XMLNode	findCellNode (XMLNode rowNode, uint16_t columnNumber)
	locate the XML cell node within rownode for the cell at columnNumber
std::ostream &	operator<< (std::ostream &os, const XLCellIterator &it)
bool	operator== (const XLCellReference &lhs, const XLCellReference &rhs) noexcept
	Determines exact coordinate identity, allowing comparisons without resolving their DOM node equivalence.
bool	operator!= (const XLCellReference &lhs, const XLCellReference &rhs) noexcept
	Detects coordinate divergence, effectively identical to !(lhs == rhs).
bool	operator< (const XLCellReference &lhs, const XLCellReference &rhs) noexcept
	Evaluates precedence primarily by row, then by column, allowing cell ranges to be sorted efficiently and sequentially from left-to-right, top-to-bottom.
bool	operator> (const XLCellReference &lhs, const XLCellReference &rhs) noexcept
	Inverts the less-than operator logic to verify strict left-to-right, top-to-bottom traversal dominance.
bool	operator<= (const XLCellReference &lhs, const XLCellReference &rhs) noexcept
	Asserts whether a cell sequentially precedes or occupies the exact same coordinate as another.
bool	operator>= (const XLCellReference &lhs, const XLCellReference &rhs) noexcept
	Asserts whether a cell sequentially follows or occupies the exact same coordinate as another.
OPENXLSX_EXPORT XLCfType	XLCfTypeFromString (std::string const &typeString)
	get the correct XLCfType from the OOXML cfRule type attribute string
OPENXLSX_EXPORT std::string	XLCfTypeToString (XLCfType cfType)
	inverse of XLCfTypeFromString
OPENXLSX_EXPORT XLCfOperator	XLCfOperatorFromString (std::string const &operatorString)
	get the correct XLCfOperator from the OOXML cfRule operator attribute string
OPENXLSX_EXPORT std::string	XLCfOperatorToString (XLCfOperator cfOperator)
	inverse of XLCfOperatorFromString
OPENXLSX_EXPORT XLCfTimePeriod	XLCfTimePeriodFromString (std::string const &timePeriodString)
	get the correct XLCfTimePeriod from the OOXML cfRule timePeriod attribute string
OPENXLSX_EXPORT std::string	XLCfTimePeriodToString (XLCfTimePeriod cfTimePeriod)
	inverse of XLCfTimePeriodFromString
OPENXLSX_EXPORT XLCfvoType	XLCfvoTypeFromString (std::string const &cfvoTypeString)
OPENXLSX_EXPORT std::string	XLCfvoTypeToString (XLCfvoType cfvoType)
OPENXLSX_EXPORT XLDataBarDirection	XLDataBarDirectionFromString (std::string const &directionString)
OPENXLSX_EXPORT std::string	XLDataBarDirectionToString (XLDataBarDirection direction)
OPENXLSX_EXPORT XLDataBarAxisPosition	XLDataBarAxisPositionFromString (std::string const &positionString)
OPENXLSX_EXPORT std::string	XLDataBarAxisPositionToString (XLDataBarAxisPosition position)
OPENXLSX_EXPORT XLCfRule	XLColorScaleRule (const XLColor &minColor, const XLColor &maxColor)
OPENXLSX_EXPORT XLCfRule	XLColorScaleRule (const XLColor &minColor, const XLColor &midColor, const XLColor &maxColor)
OPENXLSX_EXPORT XLCfRule	XLDataBarRule (const XLColor &color, bool showValue=true)
OPENXLSX_EXPORT XLCfRule	XLCellIsRule (XLCfOperator op, const std::string &value)
OPENXLSX_EXPORT XLCfRule	XLCellIsRule (const std::string &op, const std::string &value)
OPENXLSX_EXPORT XLCfRule	XLFormulaRule (const std::string &formula)
OPENXLSX_EXPORT XLCfRule	XLIconSetRule (const std::string &iconSetName="3TrafficLights1", bool showValue=true, bool reverse=false)
OPENXLSX_EXPORT XLCfRule	XLTop10Rule (uint16_t rank=10, bool percent=false, bool bottom=false)
OPENXLSX_EXPORT XLCfRule	XLAboveAverageRule (bool aboveAverage=true, bool equalAverage=false, int16_t stdDev=0)
OPENXLSX_EXPORT XLCfRule	XLDuplicateValuesRule (bool unique=false)
OPENXLSX_EXPORT XLCfRule	XLContainsTextRule (const std::string &text)
OPENXLSX_EXPORT XLCfRule	XLNotContainsTextRule (const std::string &text)
OPENXLSX_EXPORT XLCfRule	XLContainsBlanksRule ()
OPENXLSX_EXPORT XLCfRule	XLNotContainsBlanksRule ()
OPENXLSX_EXPORT XLCfRule	XLContainsErrorsRule ()
OPENXLSX_EXPORT XLCfRule	XLNotContainsErrorsRule ()
XLRowIndex	operator""_row (unsigned long long v)
XLColIndex	operator""_col (unsigned long long v)
std::string	XLContentTypeToString (XLContentType type)
	utility function: determine the name of an XLContentType value
OPENXLSX_EXPORT bool	isEncryptedDocument (gsl::span< const uint8_t > data)
	Checks if a given byte stream represents an OLE CFB document.
OPENXLSX_EXPORT std::vector< uint8_t >	decryptDocument (gsl::span< const uint8_t > data, const std::string &password)
	High-level API to decrypt an entire document from a buffer.
OPENXLSX_EXPORT std::vector< uint8_t >	encryptDocument (gsl::span< const uint8_t > zipData, const std::string &password)
	High-level API to encrypt a ZIP package into a CFB container.
OPENXLSX_EXPORT std::string	BinaryAsHexString (gsl::span< const std::byte > data)
OPENXLSX_EXPORT uint16_t	ExcelPasswordHash (std::string_view password)
OPENXLSX_EXPORT std::string	ExcelPasswordHashAsString (std::string_view password)
std::string	getPathARelativeToPathB (std::string_view pathA, std::string_view pathB)
std::string	eliminateDotAndDotDotFromPath (std::string_view path)
OPENXLSX_EXPORT std::string	XLDynamicFilterTypeToString (XLDynamicFilterType type)
	Helper function to convert enum to string.
double	toDouble (const XLCellValue &v)
bool	isNumeric (const XLCellValue &v)
bool	isEmpty (const XLCellValue &v)
bool	isError (const XLCellValue &v)
std::string	toString (const XLCellValue &v)
XLCellValue	errValue ()
XLCellValue	errDiv0 ()
XLCellValue	errNA ()
XLCellValue	errNum ()
XLCellValue	errRef ()
XLCellValue	errName ()
std::string	strTrim (std::string s)
std::vector< double >	numerics (const std::vector< XLFormulaArg > &args)
std::vector< double >	numerics (const XLFormulaArg &arg)
void	UseRandomIDs ()
	Enable use of random (relationship) IDs.
void	UseSequentialIDs ()
	Disable use of random (relationship) IDs (default behavior)
uint64_t	Rand64 ()
	Return a 64 bit random value (by invoking Rand32 twice)
void	InitRandom (bool pseudoRandom=false)
	Initialize XLRand32 data source.
XLRichText	operator+ (XLRichText lhs, const XLRichText &rhs)
XLRichText	operator+ (XLRichText lhs, const std::string &rhs)
XLRichText	operator+ (XLRichText lhs, const XLRichTextRun &rhs)
bool	operator== (const XLRichTextRun &lhs, const XLRichTextRun &rhs)
bool	operator!= (const XLRichTextRun &lhs, const XLRichTextRun &rhs)
bool	operator== (const XLRichText &lhs, const XLRichText &rhs)
bool	operator!= (const XLRichText &lhs, const XLRichText &rhs)
OPENXLSX_EXPORT std::string	XLPaneStateToString (XLPaneState state)
	get the correct XLPaneState from the OOXML pane state attribute string
OPENXLSX_EXPORT XLPaneState	XLPaneStateFromString (std::string const &stateString)
	inverse of XLPaneStateToString
OPENXLSX_EXPORT std::string	XLPaneToString (XLPane pane)
	get the correct XLPane from the OOXML pane identifier attribute string
OPENXLSX_EXPORT XLPane	XLPaneFromString (std::string const &paneString)
	inverse of XLPaneToString
OPENXLSX_EXPORT void	setTabColor (const XMLDocument &xmlDocument, const XLColor &color)
	Function for setting tab color.
OPENXLSX_EXPORT void	setTabSelected (const XMLDocument &xmlDocument, bool selected)
	Set the tab selected property to desired value.
OPENXLSX_EXPORT bool	tabIsSelected (const XMLDocument &xmlDocument)
	Function for checking if the tab is selected.
bool	isCleanXmlString (std::string_view sv) noexcept
	Checks if a string contains only valid XML 1.0 characters.
std::string	sanitizeXmlString (std::string_view sv)
	Removes invalid XML 1.0 control characters from a string to prevent file corruption.
uint16_t	extractColumnFromCellRef (const char *cellRef) noexcept
	Lightweight function to extract column number from a cell reference string. This is a performance-optimized alternative to creating XLCellReference objects.
char *	columnToLetters (uint16_t colNo, char *buffer) noexcept
	Convert column number to column letter string (A, B, ..., Z, AA, AB, ..., XFD) Performance optimization: avoids creating full XLCellReference object.
char *	makeCellAddress (uint32_t row, uint16_t col, char *buffer) noexcept
	Generate cell address string directly without creating XLCellReference object. Performance optimization: for use in hot loops where address generation is frequent.
template<class T >
void	ignore (const T &)
	Get rid of compiler warnings about unused variables (-Wunused-variable) or unused parameters (-Wunusued-parameter)
std::string	XLValueTypeString (XLValueType t)
	Get a string representation of pugi::xml_node_type.
std::string	xml_node_type_string (pugi::xml_node_type t)
	Get a string representation of pugi::xml_node_type.
std::string	XLContentTypeString (OpenXLSX::XLContentType const &t)
	Get a string representation of OpenXLSX::XLContentType.
std::string	XLRelationshipTypeString (OpenXLSX::XLRelationshipType const &t)
	Get a string representation of OpenXLSX::XLRelationshipType.
XMLNode	getRowNode (XMLNode sheetDataNode, uint32_t rowNumber, uint32_t *hintRowNumber=nullptr, XMLNode *hintRowNode=nullptr)
std::vector< XLStyleIndex >	getColumnStyles (XMLNode rowNode, uint16_t count)
	get the style attribute s for the indicated column, if any is set
XLStyleIndex	getColumnStyle (XMLNode rowNode, uint16_t colNo)
void	setDefaultCellAttributes (XMLNode cellNode, const std::string &cellRef, XMLNode rowNode, uint16_t colNo, std::vector< XLStyleIndex > const &colStyles={})
	set the cell reference, and a default cell style attribute if and only if row or column style is != XLDefaultCellFormat
void	setDefaultCellAttributes (XMLNode cellNode, const char *cellRef, XMLNode rowNode, uint16_t colNo, std::vector< XLStyleIndex > const &colStyles={})
	Overload accepting const char* for cell reference - avoids std::string allocation Performance optimization: for use in hot loops where address generation is frequent.
XMLNode	getCellNode (XMLNode rowNode, uint16_t columnNumber, uint32_t rowNumber=0, std::vector< XLStyleIndex > const &colStyles={}, uint16_t *hintColNumber=nullptr, XMLNode *hintCellNode=nullptr)
	Retrieve the xml node representing the cell at the given row and column. If the node doesn't exist, it will be created.
int	findStringInVector (std::string const &nodeName, std::vector< std::string_view > const &nodeOrder)
void	copyLeadingWhitespaces (XMLNode &parent, XMLNode fromNode, XMLNode toNode)
	copy all leading pc_data nodes from fromNode to toNode
XMLNode	appendAndGetNode (XMLNode &parent, std::string const &nodeName, std::vector< std::string_view > const &nodeOrder={}, bool force_ns=false)
	ensure that node with nodeName exists in parent and return it
XMLAttribute	appendAndGetAttribute (XMLNode &node, std::string const &attrName, std::string const &attrDefaultVal)
XMLAttribute	appendAndSetAttribute (XMLNode &node, std::string const &attrName, std::string const &attrVal)
XMLAttribute	appendAndGetNodeAttribute (XMLNode &parent, std::string const &nodeName, std::string const &attrName, std::string const &attrDefaultVal, std::vector< std::string_view > const &nodeOrder={})
	ensure that node with nodeName exists in parent, has an attribute with attrName and return that attribute
XMLAttribute	appendAndSetNodeAttribute (XMLNode &parent, std::string const &nodeName, std::string const &attrName, std::string const &attrVal, bool removeAttributes=XLKeepAttributes, std::vector< std::string_view > const &nodeOrder={})
	ensure that node with nodeName exists in parent, has an attribute with attrName, set attribute value and return that attribute
bool	getBoolAttributeWhenOmittedMeansTrue (XMLNode &parent, std::string const &tagName, std::string const &attrName="val")
	special bool attribute getter function for tags that should have a val="true" or val="false" attribute, but when omitted shall default to "true"
std::pair< uint32_t, uint32_t >	getImageDimensions (const std::string &data)
	Extract image dimensions (width and height) from raw image data (PNG/JPEG)
bool	enable_xml_namespaces ()
	Set NO_XML_NS to false.
bool	disable_xml_namespaces ()
	Set NO_XML_NS to true.
void	reorderAttributes (XMLNode &node)
	Helper function to ensure attributes are in the correct OOXML order. Openpyxl order (which Excel likes): sqref, showDropDown, showInputMessage, showErrorMessage, allowBlank, errorTitle, error, promptTitle, prompt, type, operator, errorStyle.
bool	wouldBeDuplicateShapeType (XMLNode const &rootNode, XMLNode const &shapeTypeNode)
XMLNode	moveNode (XMLNode &rootNode, XMLNode &node, XMLNode const &insertAfter, bool withWhitespaces=true)
XLShapeTextVAlign	XLShapeTextVAlignFromString (std::string_view vAlignString)
std::string	XLShapeTextVAlignToString (XLShapeTextVAlign vAlign)
XLShapeTextHAlign	XLShapeTextHAlignFromString (std::string_view hAlignString)
std::string	XLShapeTextHAlignToString (XLShapeTextHAlign hAlign)
thread_local std::mt19937	Rand32 (0)
void	copyXMLNode (XMLNode &destination, const XMLNode &source)
std::string	xmlNodeFingerprint (const XMLNode &node)
	Compute a canonical, deterministic string fingerprint of a pugixml subtree.
template<typename E , size_t N>
constexpr E	EnumFromString (std::string_view str, const EnumStringMap< E >(&mapping)[N], E invalidVal)
template<typename E , size_t N>
constexpr const char *	EnumToString (E val, const EnumStringMap< E >(&mapping)[N], const char *invalidStr)
std::string	formatDoubleAsString (double val, int decimalPlaces=2)
	Format val as a string with decimalPlaces.
std::string	checkAndFormatDoubleAsString (double val, double min, double max, double absTolerance, int decimalPlaces=2)
	Check that a double value is within range, and format it as a string with decimalPlaces.
void	setTableAttribute (XMLNode &node, std::string_view name, std::string_view value)
	Helper to set table attributes in the correct physical order.
constexpr char	hexDigit (unsigned int value)
	Return a hexadecimal digit as character that is the equivalent of value.
std::vector< std::string >	disassemblePath (std::string_view path, bool eliminateDots=true)

Variables
constexpr const uint32_t	XLKeepCellStyle = 1
constexpr const uint32_t	XLKeepCellType = 2
constexpr const uint32_t	XLKeepCellValue = 4
constexpr const uint32_t	XLKeepCellFormula = 8
constexpr const uint16_t	XLPriorityNotSet = 0
constexpr const char *	XLDefaultCfRulePrefix = "\n\t\t"
constexpr const char *	XLDefaultConditionalFormattingPrefix = "\n\t"
constexpr uint16_t	MAX_COLS = 16'384
constexpr uint32_t	MAX_ROWS = 1'048'576
constexpr uint16_t	MAX_SHAPE_ANCHOR_COLUMN = 13067
constexpr uint32_t	MAX_SHAPE_ANCHOR_ROW = 852177
constexpr const unsigned int	pugi_parse_settings = pugi::parse_default | pugi::parse_ws_pcdata
constexpr const bool	XLForceOverwrite = true
constexpr const bool	XLDoNotOverwrite = false
const std::string_view	ShapeNodeName = "v:shape"
const std::string_view	ShapeTypeNodeName = "v:shapetype"
constexpr const XLShapeTextVAlign	XLDefaultShapeTextVAlign = XLShapeTextVAlign::Top
constexpr const XLShapeTextHAlign	XLDefaultShapeTextHAlign = XLShapeTextHAlign::Left
constexpr bool	XLResetValue = true
constexpr bool	XLPreserveValue = false
constexpr const XLMergeIndex	XLMergeNotFound = -1
constexpr size_t	XLMaxMergeCells = (std::numeric_limits<XLMergeIndex>::max)()
thread_local std::mt19937	Rand32
	Return a 32 bit random value.
constexpr size_t	XLMaxSharedStrings = (std::numeric_limits<int32_t>::max)()
const XLSharedStrings	XLSharedStringsDefaulted {}
constexpr const bool	XLEmptyHiddenCells = true
constexpr const uint32_t	XLInvalidUInt16 = 0xffff
constexpr const uint32_t	XLInvalidUInt32 = 0xffffffff
constexpr const uint32_t	XLDeleteProperty = XLInvalidUInt32
constexpr const bool	XLPermitXfID = true
constexpr const bool	XLCreateIfMissing = true
constexpr const bool	XLDoNotCreate = false
constexpr const bool	XLForceFillType = true
constexpr const char *	XLDefaultStylesPrefix = "\n\t"
constexpr const char *	XLDefaultStyleEntriesPrefix = "\n\t\t"
constexpr const XLStyleIndex	XLDefaultCellFormat = 0
constexpr const XLStyleIndex	XLInvalidStyleIndex = XLInvalidUInt32
constexpr const uint32_t	XLDefaultFontSize = 12
constexpr const char *	XLDefaultFontColor = "ff000000"
constexpr const char *	XLDefaultFontColorTheme = ""
constexpr const char *	XLDefaultFontName = "Arial"
constexpr const uint32_t	XLDefaultFontFamily = 0
constexpr const uint32_t	XLDefaultFontCharset = 1
constexpr const char *	XLDefaultLineStyle = ""
constexpr const XLFillType	XLDefaultFillType = XLPatternFill
constexpr const XLPatternType	XLDefaultPatternType = XLPatternNone
constexpr const char *	XLDefaultPatternFgColor = "ffffffff"
constexpr const char *	XLDefaultPatternBgColor = "ff000000"
constexpr const bool	XLRemoveAttributes = true
constexpr const bool	XLKeepAttributes = false
constexpr const int	SORT_INDEX_NOT_FOUND = -1
	find the index of nodeName in nodeOrder
const std::vector< std::string_view >	XLWorksheetNodeOrder
const std::vector< std::string_view >	XLSheetViewNodeOrder
constexpr const bool	XLForceNamespace = true
thread_local bool	NO_XML_NS = true
constexpr const char *	XLXmlDefaultVersion = "1.0"
constexpr const char *	XLXmlDefaultEncoding = "UTF-8"
constexpr const bool	XLXmlStandalone = true
constexpr const bool	XLXmlNotStandalone = false
constexpr uint32_t	EMU_PER_PIXEL = 9525
constexpr uint32_t	DEFAULT_IMAGE_SIZE = 100
const std::vector< std::string_view >	ColumnNodeOrder = {"calculatedColumnFormula", "totalsRowFormula", "xmlColumnPr", "extLst"}
const std::vector< std::string_view >	TableNodeOrder = {"autoFilter", "sortState", "tableColumns", "tableStyleInfo", "extLst"}
	The TableNodeOrder vector defines the order of nodes in the table XML file.
const std::vector< std::string_view >	TableAttributeOrder
	The TableAttributeOrder defines the mandatory physical sequence of attributes in the.

Typedef Documentation

FlatHashMap

template<typename Key , typename Value >

using OpenXLSX::FlatHashMap = typedef ankerl::unordered_dense::map<Key, Value, StringViewHash, std::equal_to<> >

XLCellResolver

using OpenXLSX::XLCellResolver = typedef std::function<XLCellValue(std::string_view ref)>

Callback type: resolves a cell reference string to a cell value.

The string is the raw reference text, e.g. "A1", "$B$2", "Sheet1!C3", or "A1:B10" for a range (the engine calls this once per distinct ref). Return XLCellValue{} (empty) for unknown or out-of-range cells.

Range refs are passed as-is. The engine detects the colon in the text and will call the resolver with each individual cell in the range when it needs to expand the range. The resolver only needs to handle single-cell refs; range expansion is done internally.

XLDiffCellFormat

using OpenXLSX::XLDiffCellFormat = typedef XLDxf

Backward compatibility alias.

XLDiffCellFormats

using OpenXLSX::XLDiffCellFormats = typedef XLDxfs

Backward compatibility alias.

XLMergeIndex

typedef int32_t OpenXLSX::XLMergeIndex

XLSharedStringsRef

typedef std::reference_wrapper<const XLSharedStrings> OpenXLSX::XLSharedStringsRef

XLStyleIndex

using OpenXLSX::XLStyleIndex = typedef size_t

XLTables

using OpenXLSX::XLTables = typedef XLTableCollection

XMLAttribute

using OpenXLSX::XMLAttribute = typedef pugi::xml_attribute

XMLDocument

using OpenXLSX::XMLDocument = typedef OpenXLSX_xml_document

XMLNode

using OpenXLSX::XMLNode = typedef OpenXLSX_xml_node

Enumeration Type Documentation

XLAlignmentStyle

enum OpenXLSX::XLAlignmentStyle : uint8_t

Enumerator
XLAlignGeneral
XLAlignLeft
XLAlignRight
XLAlignCenter
XLAlignTop
XLAlignBottom
XLAlignFill
XLAlignJustify
XLAlignCenterContinuous
XLAlignDistributed
XLAlignInvalid

XLAxisCrosses

enum class OpenXLSX::XLAxisCrosses

strong

Enumerator
AutoZero
Min
Max

XLAxisOrientation

enum class OpenXLSX::XLAxisOrientation

strong

Enumerator
MinMax
MaxMin

XLCfOperator

enum class OpenXLSX::XLCfOperator : uint8_t

strong

Enumerator
LessThan
LessThanOrEqual
Equal
NotEqual
GreaterThanOrEqual
GreaterThan
Between
NotBetween
ContainsText
NotContains
BeginsWith
EndsWith
Invalid

XLCfTimePeriod

enum class OpenXLSX::XLCfTimePeriod : uint8_t

strong

Enumerator
Today
Yesterday
Tomorrow
Last7Days
ThisMonth
LastMonth
NextMonth
ThisWeek
LastWeek
NextWeek
Invalid

XLCfType

enum class OpenXLSX::XLCfType : uint8_t

strong

Enumerator
Expression
CellIs
ColorScale
DataBar
IconSet
Top10
UniqueValues
DuplicateValues
ContainsText
NotContainsText
BeginsWith
EndsWith
ContainsBlanks
NotContainsBlanks
ContainsErrors
NotContainsErrors
TimePeriod
AboveAverage
Invalid

XLCfvoType

enum class OpenXLSX::XLCfvoType : uint8_t

strong

Enumerator
Min
Max
Number
Percent
Formula
Percentile
Invalid

XLChartType

enum class OpenXLSX::XLChartType

strong

Enumerator
Bar
BarStacked
BarPercentStacked
Bar3D
Bar3DStacked
Bar3DPercentStacked
Column
ColumnStacked
ColumnPercentStacked
Column3D
Column3DStacked
Column3DPercentStacked
Line
LineStacked
LinePercentStacked
Line3D
Pie
Pie3D
Scatter
ScatterLine	Scatter with straight lines, no markers.
ScatterLineMarker	Scatter with straight lines and markers.
ScatterSmooth	Scatter with smooth lines, no markers.
ScatterSmoothMarker	Scatter with smooth lines and markers.
ScatterMarker	Scatter with markers only, no lines.
Bubble	Bubble chart (needs addBubbleSeries)
StockHLC
StockOHLC
Surface
Surface3D
SurfaceWireframe
Surface3DWireframe
Area
AreaStacked
AreaPercentStacked
Area3D
Area3DStacked
Area3DPercentStacked
Doughnut
Radar
RadarFilled
RadarMarkers

XLCommandType

enum class OpenXLSX::XLCommandType : uint8_t

strong

Enumerator
SetSheetName
SetSheetVisibility
SetSheetIndex
SetSheetActive
ResetCalcChain
SetFullCalcOnLoad
CheckAndFixCoreProperties
CheckAndFixExtendedProperties
CheckAndFixCustomProperties
AddSharedStrings
AddWorksheet
AddChartsheet
DeleteSheet
CloneSheet
AddStyles

XLContentType

enum class OpenXLSX::XLContentType : uint8_t

strong

Enumerator
Workbook
Relationships
WorkbookMacroEnabled
Worksheet
Chartsheet
ExternalLink
Theme
Styles
SharedStrings
Drawing
Chart
ChartStyle
ChartColorStyle
ControlProperties
CalculationChain
VBAProject
CoreProperties
ExtendedProperties
CustomProperties
Comments
Table
VMLDrawing
Hyperlink
Unknown
PivotTable
Slicer
SlicerCache
PivotCacheDefinition
PivotCacheRecords
ThreadedComments
Persons

XLDataBarAxisPosition

enum class OpenXLSX::XLDataBarAxisPosition : uint8_t

strong

Enumerator
Automatic
Middle
None

XLDataBarDirection

enum class OpenXLSX::XLDataBarDirection : uint8_t

strong

Enumerator
Context
LeftToRight
RightToLeft

XLDataValidationErrorStyle

enum class OpenXLSX::XLDataValidationErrorStyle

strong

Enumerator
Stop
Warning
Information

XLDataValidationOperator

enum class OpenXLSX::XLDataValidationOperator

strong

Enumerator
Between
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
NotBetween
NotEqual

XLDataValidationType

enum class OpenXLSX::XLDataValidationType

strong

Enumerator
None
Custom
Date
Decimal
List
TextLength
Time
Whole

XLDynamicFilterType

enum class OpenXLSX::XLDynamicFilterType

strong

Enum defining all valid dynamic filter types according to ECMA-376 18.18.25.

Enumerator
Null
AboveAverage
BelowAverage
Tomorrow
Today
Yesterday
NextWeek
ThisWeek
LastWeek
NextMonth
ThisMonth
LastMonth
NextQuarter
ThisQuarter
LastQuarter
NextYear
ThisYear
LastYear
YearToDate
Q1
Q2
Q3
Q4
M1
M2
M3
M4
M5
M6
M7
M8
M9
M10
M11
M12

XLErrorBarDirection

enum class OpenXLSX::XLErrorBarDirection

strong

Enumerator
X
Y

XLErrorBarType

enum class OpenXLSX::XLErrorBarType

strong

Enumerator
Both
Minus
Plus

XLErrorBarValueType

enum class OpenXLSX::XLErrorBarValueType

strong

Enumerator
Custom
FixedValue
Percentage
StandardDeviation
StandardError

XLFillType

enum OpenXLSX::XLFillType : uint8_t

Enumerator
XLGradientFill
XLPatternFill
XLFillTypeInvalid

XLFilterLogic

enum class OpenXLSX::XLFilterLogic

strong

Enum class defining the logical operator for custom filters.

Enumerator
And
Or

XLFontSchemeStyle

enum OpenXLSX::XLFontSchemeStyle : uint8_t

Enumerator
XLFontSchemeNone
XLFontSchemeMajor
XLFontSchemeMinor
XLFontSchemeInvalid

XLGradientType

enum OpenXLSX::XLGradientType : uint8_t

Enumerator
XLGradientLinear
XLGradientPath
XLGradientTypeInvalid

XLImagePositioning

enum class OpenXLSX::XLImagePositioning

strong

Determines how an image behaves when cells are resized or inserted/deleted.

Enumerator
OneCell	Image moves with the top-left cell but does not resize.
TwoCell	Image stretches and moves with both top-left and bottom-right cells.
Absolute	Image stays exactly at a fixed absolute coordinate on the sheet.

XLIMEMode

enum class OpenXLSX::XLIMEMode

strong

IME (Input Method Editor) mode for data validation.

Enumerator
NoControl
Off
On
Disabled
Hiragana
FullKatakana
HalfKatakana
FullAlpha
HalfAlpha
FullHangul
HalfHangul

XLIteratorDirection

enum class OpenXLSX::XLIteratorDirection

strong

Enumerator
Forward
Reverse

XLIteratorLocation

enum class OpenXLSX::XLIteratorLocation

strong

Enumerator
Begin
End

XLLegendPosition

enum class OpenXLSX::XLLegendPosition

strong

Enumerator
Bottom
Left
Right
Top
TopRight
Hidden

XLLineStyle

enum OpenXLSX::XLLineStyle : uint8_t

Enumerator
XLLineStyleNone
XLLineStyleThin
XLLineStyleMedium
XLLineStyleDashed
XLLineStyleDotted
XLLineStyleThick
XLLineStyleDouble
XLLineStyleHair
XLLineStyleMediumDashed
XLLineStyleDashDot
XLLineStyleMediumDashDot
XLLineStyleDashDotDot
XLLineStyleMediumDashDotDot
XLLineStyleSlantDashDot
XLLineStyleInvalid

XLLineType

enum OpenXLSX::XLLineType : uint8_t

Enumerator
XLLineLeft
XLLineRight
XLLineTop
XLLineBottom
XLLineDiagonal
XLLineVertical
XLLineHorizontal
XLLineInvalid

XLMarkerStyle

enum class OpenXLSX::XLMarkerStyle

strong

Enumerator
None
Circle
Dash
Diamond
Dot
Picture
Plus
Square
Star
Triangle
X
Default

XLNodeKind

enum class OpenXLSX::XLNodeKind : uint8_t

strong

Kind discriminator for AST nodes.

Enumerator
Number
StringLit
BoolLit
CellRef	e.g. "A1" or "Sheet1!A1"
Range	e.g. "A1:B10" – evaluated lazily by the resolver
BinOp
UnaryOp
FuncCall
ErrorLit	#NAME?, etc. – propagated as-is

XLPageOrientation

enum class OpenXLSX::XLPageOrientation

strong

Enum defining page orientation.

Enumerator
Default
Portrait
Landscape

XLPane

enum class OpenXLSX::XLPane : uint8_t

strong

The XLPane is an enumeration of the possible pane identifiers.

Enumerator
BottomRight
TopRight
BottomLeft
TopLeft

XLPaneState

enum class OpenXLSX::XLPaneState : uint8_t

strong

The XLPaneState is an enumeration of the possible states of a pane, e.g. Frozen or Split.

Enumerator
Split
Frozen
FrozenSplit

XLPatternType

enum OpenXLSX::XLPatternType : uint8_t

Enumerator
XLPatternNone
XLPatternSolid
XLPatternMediumGray
XLPatternDarkGray
XLPatternLightGray
XLPatternDarkHorizontal
XLPatternDarkVertical
XLPatternDarkDown
XLPatternDarkUp
XLPatternDarkGrid
XLPatternDarkTrellis
XLPatternLightHorizontal
XLPatternLightVertical
XLPatternLightDown
XLPatternLightUp
XLPatternLightGrid
XLPatternLightTrellis
XLPatternGray125
XLPatternGray0625
XLPatternTypeInvalid

XLPivotSubtotal

enum class OpenXLSX::XLPivotSubtotal

strong

Enumerator
Sum
Average
Count
Max
Min
Product

XLProperty

enum class OpenXLSX::XLProperty

strong

The XLDocumentProperties class is an enumeration of the possible properties (metadata) that can be set for a XLDocument object (and .xlsx file)

Enumerator
Title
Subject
Creator
Keywords
Description
LastModifiedBy
LastPrinted
CreationDate
ModificationDate
Category
Application
DocSecurity
ScaleCrop
Manager
Company
LinksUpToDate
SharedDoc
HyperlinkBase
HyperlinksChanged
AppVersion

XLQueryType

enum class OpenXLSX::XLQueryType : uint8_t

strong

Enumerator
QuerySheetName
QuerySheetIndex
QuerySheetVisibility
QuerySheetIsActive
QuerySheetType
QuerySheetID
QuerySheetRelsID
QuerySheetRelsTarget
QuerySharedStrings
QueryXmlData

XLReadingOrder

enum OpenXLSX::XLReadingOrder : uint32_t

Enumerator
XLReadingOrderContextual
XLReadingOrderLeftToRight
XLReadingOrderRightToLeft

XLRelationshipType

enum class OpenXLSX::XLRelationshipType

strong

An enum of the possible relationship (or XML document) types used in relationship (.rels) XML files.

Enumerator
CoreProperties
ExtendedProperties
CustomProperties
Workbook
Worksheet
Chartsheet
Dialogsheet
Macrosheet
CalculationChain
ExternalLink
ExternalLinkPath
Theme
Styles
Chart
ChartStyle
ChartColorStyle
Image
Drawing
VMLDrawing
SharedStrings
PrinterSettings
VBAProject
ControlProperties
Comments
Table
Hyperlink
Unknown
PivotTable
Slicer
SlicerCache
PivotCacheDefinition
PivotCacheRecords
ThreadedComments
Person

XLShapeTextHAlign

enum class OpenXLSX::XLShapeTextHAlign : uint8_t

strong

Enumerator
Left
Right
Center
Invalid

XLShapeTextVAlign

enum class OpenXLSX::XLShapeTextVAlign : uint8_t

strong

Enumerator
Center
Top
Bottom
Invalid

XLSheetState

enum class OpenXLSX::XLSheetState : uint8_t

strong

The XLSheetState is an enumeration of the possible (visibility) states, e.g. Visible or Hidden.

Enumerator
Visible
Hidden
VeryHidden

XLSheetType

enum class OpenXLSX::XLSheetType

strong

Enumeration of the different types of sheets.

Enumerator
Worksheet
Chartsheet
Dialogsheet
Macrosheet

XLSparklineType

enum class OpenXLSX::XLSparklineType

strong

The XLSparklineType enum represents the type of a sparkline.

Enumerator
Line
Column
Stacked

XLTokenKind

enum class OpenXLSX::XLTokenKind : uint8_t

strong

Kinds of tokens produced by the lexer.

Enumerator
Number	Numeric literal (integer or float)
String	Quoted string literal "hello".
Bool	TRUE or FALSE keyword.
CellRef	Cell reference A1, $B$2, Sheet1!C3.
Ident	Function name or named range.
Plus
Minus
Star
Slash	/
Caret	^ (power)
Percent	%
Amp	& (string concat)
Eq	=
NEq	<>
Lt	<
Le	<=
Gt	‍
Ge	>=
LParen	(
RParen	)
Comma	,
Semicolon	; (alternative argument separator in some locales)
Colon	: (used inside range references parsed by lexer)
End	Sentinel – end of input.
Error	Unrecognised character.

XLTotalsRowFunction

enum class OpenXLSX::XLTotalsRowFunction

strong

Enum class defining the possible functions for a table's totals row.

Enumerator
None
Sum
Min
Max
Average
Count
CountNums
StdDev
Var
Custom

XLTrendlineType

enum class OpenXLSX::XLTrendlineType

strong

Enumerator
Linear
Exponential
Logarithmic
Polynomial
Power
MovingAverage

XLUnderlineStyle

enum OpenXLSX::XLUnderlineStyle : uint8_t

Enumerator
XLUnderlineNone
XLUnderlineSingle
XLUnderlineDouble
XLUnderlineSingleAccounting
XLUnderlineDoubleAccounting
XLUnderlineInvalid

XLValueType

enum class OpenXLSX::XLValueType

strong

Enum defining the valid value types for a an Excel spreadsheet cell.

Enumerator
Empty
Boolean
Integer
Float
Error
String
RichText

XLVectorShapeType

enum class OpenXLSX::XLVectorShapeType

strong

An encapsulation of a drawing item (e.g. an image)

Enumerator
Rectangle
Ellipse
Line
Triangle
RightTriangle
Arrow
Diamond
Parallelogram
Hexagon
Star4
Star5
Star16
Star24
Heart
SmileyFace
Cloud
Donut
Ribbon
Sun
Moon
LightningBolt
FlowChartProcess
FlowChartDecision
FlowChartDocument
FlowChartData

XLVerticalAlignRunStyle

enum OpenXLSX::XLVerticalAlignRunStyle : uint8_t

Enumerator
XLBaseline
XLSubscript
XLSuperscript
XLVerticalAlignRunInvalid

Function Documentation

appendAndGetAttribute()

XMLAttribute OpenXLSX::appendAndGetAttribute ( XMLNode &  node, std::string const &  attrName, std::string const &  attrDefaultVal  )

inline

appendAndGetNode()

XMLNode OpenXLSX::appendAndGetNode ( XMLNode &  parent, std::string const &  nodeName, std::vector< std::string_view > const &  nodeOrder = {}, bool  force_ns = false  )

inline

ensure that node with nodeName exists in parent and return it

Parameters

parent	parent node that can perform sibling insertions
nodename	name of the node to be (created &) returned
nodeOrder	optional vector of a predefined element node sequence required by MS Office
force_ns	optional force nodeName namespace

Returns

the requested XMLNode or an empty node if the insert operation failed

Note

2024-12-19: appendAndGetNode will attempt to perform an ordered insert per nodeOrder if provided Once sufficiently tested, this functionality might be generalized (e.g. in XLXmlParser OpenXLSX_xml_node)

appendAndGetNodeAttribute()

XMLAttribute OpenXLSX::appendAndGetNodeAttribute ( XMLNode &  parent, std::string const &  nodeName, std::string const &  attrName, std::string const &  attrDefaultVal, std::vector< std::string_view > const &  nodeOrder = {}  )

inline

ensure that node with nodeName exists in parent, has an attribute with attrName and return that attribute

Parameters

parent	parent node that can perform sibling insertions
nodename	name of the node under which attribute attrName shall exist
attrName	name of the attribute to get for node nodeName
attrDefaultVal	value to assign to the attribute if it has to be created
nodeOrder	optional vector of a predefined element node sequence required by MS Office, passed through to appendAndGetNode

Returns

the requested XMLAttribute or an empty node if the operation failed

appendAndSetAttribute()

XMLAttribute OpenXLSX::appendAndSetAttribute ( XMLNode &  node, std::string const &  attrName, std::string const &  attrVal  )

inline

appendAndSetNodeAttribute()

XMLAttribute OpenXLSX::appendAndSetNodeAttribute ( XMLNode &  parent, std::string const &  nodeName, std::string const &  attrName, std::string const &  attrVal, bool  removeAttributes = XLKeepAttributes, std::vector< std::string_view > const &  nodeOrder = {}  )

inline

ensure that node with nodeName exists in parent, has an attribute with attrName, set attribute value and return that attribute

Parameters

parent	parent node that can perform sibling insertions
nodename	name of the node under which attribute attrName shall exist
attrName	name of the attribute to set for node nodeName
attrVal	value to assign to the attribute
removeAttributes	if true, all other attributes of the node with nodeName will be deleted
nodeOrder	optional vector of a predefined element node sequence required by MS Office, passed through to appendAndGetNode

Returns

the XMLAttribute that was modified or an empty node if the operation failed

BinaryAsHexString()

std::string OpenXLSX::BinaryAsHexString

(

gsl::span< const std::byte >

data

)

Converts raw byte arrays into hex-encoded strings, required for constructing valid OOXML password hashes.

checkAndFormatDoubleAsString()

std::string OpenXLSX::checkAndFormatDoubleAsString ( double  val, double  min, double  max, double  absTolerance, int  decimalPlaces = 2  )

inline

Check that a double value is within range, and format it as a string with decimalPlaces.

columnToLetters()

char * OpenXLSX::columnToLetters ( uint16_t  colNo, char *  buffer  )

inlinenoexcept

Convert column number to column letter string (A, B, ..., Z, AA, AB, ..., XFD) Performance optimization: avoids creating full XLCellReference object.

Parameters

colNo	Column number (1-indexed)
buffer	Output buffer (must be at least 4 bytes for "XFD" + null)

Returns

Pointer to the buffer

copyLeadingWhitespaces()

void OpenXLSX::copyLeadingWhitespaces ( XMLNode &  parent, XMLNode  fromNode, XMLNode  toNode  )

inline

copy all leading pc_data nodes from fromNode to toNode

Parameters

parent	parent node that can perform sibling insertions
fromNode	node whose preceeding whitespaces shall be duplicated
toNode	node before which the duplicated whitespaces shall be inserted

Returns

N/A

copyXMLNode()

void OpenXLSX::copyXMLNode ( XMLNode &  destination, const XMLNode &  source  )

inline

decryptDocument()

std::vector< uint8_t > OpenXLSX::decryptDocument	(	gsl::span< const uint8_t >	data,
		const std::string &	password
	)

High-level API to decrypt an entire document from a buffer.

Parameters

data	The CFB file data.
password	The user password.

Returns

The decrypted ZIP package.

disable_xml_namespaces()

bool OpenXLSX::disable_xml_namespaces

(

)

Set NO_XML_NS to true.

Returns

true if PUGI_AUGMENTED is defined (success), false if PUGI_AUGMENTED is not in use (function would be pointless)

Note

CAUTION: this setting should be established before any other OpenXLSX function is used

disassemblePath()

std::vector< std::string > OpenXLSX::disassemblePath	(	std::string_view	path,
		bool	eliminateDots = true
	)

Split a path into its constituent entries (directories and file). Rationale: Standard path decomposition used for relative path calculation. Uses std::string_view for zero-copy parsing.

eliminateDotAndDotDotFromPath()

std::string OpenXLSX::eliminateDotAndDotDotFromPath

(

std::string_view

path

)

Standardize path by resolving '.' and '..' segments. Rationale: Normalizes paths to ensure consistent internal ZIP archive lookups.

enable_xml_namespaces()

bool OpenXLSX::enable_xml_namespaces

(

)

Set NO_XML_NS to false.

Returns

true if PUGI_AUGMENTED is defined (success), false if PUGI_AUGMENTED is not in use (function would be pointless)

Note

CAUTION: this setting should be established before any other OpenXLSX function is used

encryptDocument()

std::vector< uint8_t > OpenXLSX::encryptDocument	(	gsl::span< const uint8_t >	zipData,
		const std::string &	password
	)

High-level API to encrypt a ZIP package into a CFB container.

Parameters

zipData	The raw ZIP data.
password	The user password.

Returns

The encrypted CFB OLE container.

EnumFromString()

template<typename E , size_t N>

constexpr E OpenXLSX::EnumFromString ( std::string_view  str, const EnumStringMap< E >(&)  mapping[N], E  invalidVal  )

constexpr

EnumToString()

template<typename E , size_t N>

constexpr const char * OpenXLSX::EnumToString ( E  val, const EnumStringMap< E >(&)  mapping[N], const char *  invalidStr  )

constexpr

errDiv0()

XLCellValue OpenXLSX::errDiv0

(

)

errNA()

XLCellValue OpenXLSX::errNA

(

)

errName()

XLCellValue OpenXLSX::errName

(

)

errNum()

XLCellValue OpenXLSX::errNum

(

)

errRef()

XLCellValue OpenXLSX::errRef

(

)

errValue()

XLCellValue OpenXLSX::errValue

(

)

ExcelPasswordHash()

uint16_t OpenXLSX::ExcelPasswordHash

(

std::string_view

password

)

Implements the legacy Excel hash algorithm to verify or secure sheet protection features.

ExcelPasswordHashAsString()

std::string OpenXLSX::ExcelPasswordHashAsString

(

std::string_view

password

)

Bridges the legacy integer hash to the required XML string format, simplifying integration with the DOM attributes.

extractColumnFromCellRef()

uint16_t OpenXLSX::extractColumnFromCellRef ( const char *  cellRef )

inlinenoexcept

Lightweight function to extract column number from a cell reference string. This is a performance-optimized alternative to creating XLCellReference objects.

Parameters

cellRef

The cell reference string (e.g., "A1", "BC42", "XFD1048576")

Returns

The column number (1-based), or 0 if the string is empty or invalid

Note

This function only parses the column part (letters) and ignores the row part. It assumes the input is a valid cell reference with uppercase letters.

findCellNode()

XMLNode OpenXLSX::findCellNode	(	XMLNode	rowNode,
		uint16_t	columnNumber
	)

locate the XML cell node within rownode for the cell at columnNumber

Returns

the XMLNode pointing to the cell, or an empty XMLNode if the cell does not exist

findRowNode()

XMLNode OpenXLSX::findRowNode	(	XMLNode	sheetDataNode,
		uint32_t	rowNumber
	)

locate the XML row node within sheetDataNode for the row at rowNumber

Returns

the XMLNode pointing to the row, or an empty XMLNode if the row does not exist

findStringInVector()

int OpenXLSX::findStringInVector ( std::string const &  nodeName, std::vector< std::string_view > const &  nodeOrder  )

inline

formatDoubleAsString()

std::string OpenXLSX::formatDoubleAsString ( double  val, int  decimalPlaces = 2  )

inline

Format val as a string with decimalPlaces.

getBoolAttributeWhenOmittedMeansTrue()

bool OpenXLSX::getBoolAttributeWhenOmittedMeansTrue ( XMLNode &  parent, std::string const &  tagName, std::string const &  attrName = "val"  )

inline

special bool attribute getter function for tags that should have a val="true" or val="false" attribute, but when omitted shall default to "true"

Parameters

parent	node under which tagName shall be found
tagName	name of the boolean tag to evaluate
attrName	(default: "val") name of boolean attribute that shall default to true

Returns

true if parent & tagName exist, and attribute with attrName is either omitted or as_bool() returns true. Otherwise return false

Note

this will create and explicitly set attrName if omitted

getCellNode()

XMLNode OpenXLSX::getCellNode ( XMLNode  rowNode, uint16_t  columnNumber, uint32_t  rowNumber = 0, std::vector< XLStyleIndex > const &  colStyles = {}, uint16_t *  hintColNumber = nullptr, XMLNode *  hintCellNode = nullptr  )

inline

Retrieve the xml node representing the cell at the given row and column. If the node doesn't exist, it will be created.

Parameters

rowNode	The row node under which to find the cell.
columnNumber	The column at which to find the cell.
rowNumber	(optional) row number of the row node, if already known, defaults to 0
colStyles	an optional std::vector<XLStyleIndex> that contains all pre-evaluated column styles, and can be used to avoid performance impact from lookup

Returns

The xml node representing the requested cell.

getColumnStyle()

XLStyleIndex OpenXLSX::getColumnStyle ( XMLNode  rowNode, uint16_t  colNo  )

inline

getColumnStyles()

std::vector< XLStyleIndex > OpenXLSX::getColumnStyles ( XMLNode  rowNode, uint16_t  count  )

inline

get the style attribute s for the indicated column, if any is set

Parameters

rowNode	the row node from which to obtain the parent that should hold the <cols> node
colNo	the column for which to obtain the style

Returns

the XLStyleIndex stored for the column, or XLDefaultCellFormat if none

Pre-compute all column styles for a row up to a given column count to avoid O(N) DOM lookups

Parameters

rowNode	the row node
count	the maximum column number to fetch styles for

Returns

a vector where index 0 is column 1's style, index 1 is column 2's style, etc.

getImageDimensions()

std::pair< uint32_t, uint32_t > OpenXLSX::getImageDimensions ( const std::string &  data )

inline

Extract image dimensions (width and height) from raw image data (PNG/JPEG)

Parameters

data	Raw binary image data

Returns

A pair containing {width, height} in pixels. Returns {0, 0} if parsing fails.

getPathARelativeToPathB()

std::string OpenXLSX::getPathARelativeToPathB	(	std::string_view	pathA,
		std::string_view	pathB
	)

Calculate the relative path from B to A. Rationale: Resolves internal OOXML relationship paths, which are often stored relative to the source part's directory.

getRowNode()

XMLNode OpenXLSX::getRowNode ( XMLNode  sheetDataNode, uint32_t  rowNumber, uint32_t *  hintRowNumber = nullptr, XMLNode *  hintRowNode = nullptr  )

inline

hexDigit()

constexpr char OpenXLSX::hexDigit ( unsigned int  value )

constexpr

Return a hexadecimal digit as character that is the equivalent of value.

ignore()

template<class T >

void OpenXLSX::ignore

(

const T &

)

Get rid of compiler warnings about unused variables (-Wunused-variable) or unused parameters (-Wunusued-parameter)

Parameters

(unnamed)

the variable / parameter which is intentionally unused (e.g. for function stubs)

InitRandom()

void OpenXLSX::InitRandom

(

bool

pseudoRandom = false

)

Initialize XLRand32 data source.

Parameters

pseudoRandom

If true, sequence will be reproducible with a constant seed

Initialize the module's random functions

isCleanXmlString()

bool OpenXLSX::isCleanXmlString ( std::string_view  sv )

inlinenoexcept

Checks if a string contains only valid XML 1.0 characters.

Parameters

sv	The string view to check

Returns

true if string is clean, false if it contains invalid control characters

isEmpty()

bool OpenXLSX::isEmpty

(

const XLCellValue &

v

)

isEncryptedDocument()

bool OpenXLSX::isEncryptedDocument

(

gsl::span< const uint8_t >

data

)

Checks if a given byte stream represents an OLE CFB document.

Parameters

data	The file data.

Returns

true if it is an encrypted/OLE document.

isError()

bool OpenXLSX::isError

(

const XLCellValue &

v

)

isNumeric()

bool OpenXLSX::isNumeric

(

const XLCellValue &

v

)

makeCellAddress()

char * OpenXLSX::makeCellAddress ( uint32_t  row, uint16_t  col, char *  buffer  )

inlinenoexcept

Generate cell address string directly without creating XLCellReference object. Performance optimization: for use in hot loops where address generation is frequent.

Parameters

row	Row number (1-indexed)
col	Column number (1-indexed)
buffer	Output buffer (must be at least 16 bytes)

Returns

Pointer to the buffer

moveNode()

XMLNode OpenXLSX::moveNode	(	XMLNode &	rootNode,
		XMLNode &	node,
		XMLNode const &	insertAfter,
		bool	withWhitespaces = true
	)

numerics() [1/2]

std::vector< double > OpenXLSX::numerics

(

const std::vector< XLFormulaArg > &

args

)

numerics() [2/2]

std::vector< double > OpenXLSX::numerics

(

const XLFormulaArg &

arg

)

operator!=() [1/4]

bool OpenXLSX::operator!= ( const XLCell &  lhs, const XLCell &  rhs  )

inline

Parameters

lhs
rhs

Returns

operator!=() [2/4]

bool OpenXLSX::operator!= ( const XLCellReference &  lhs, const XLCellReference &  rhs  )

inlinenoexcept

Detects coordinate divergence, effectively identical to !(lhs == rhs).

operator!=() [3/4]

bool OpenXLSX::operator!= ( const XLRichText &  lhs, const XLRichText &  rhs  )

inline

operator!=() [4/4]

bool OpenXLSX::operator!= ( const XLRichTextRun &  lhs, const XLRichTextRun &  rhs  )

inline

operator+() [1/3]

XLRichText OpenXLSX::operator+ ( XLRichText  lhs, const std::string &  rhs  )

inline

operator+() [2/3]

XLRichText OpenXLSX::operator+ ( XLRichText  lhs, const XLRichText &  rhs  )

inline

operator+() [3/3]

XLRichText OpenXLSX::operator+ ( XLRichText  lhs, const XLRichTextRun &  rhs  )

inline

operator<()

bool OpenXLSX::operator< ( const XLCellReference &  lhs, const XLCellReference &  rhs  )

inlinenoexcept

Evaluates precedence primarily by row, then by column, allowing cell ranges to be sorted efficiently and sequentially from left-to-right, top-to-bottom.

operator<<() [1/3]

std::ostream & OpenXLSX::operator<< ( std::ostream &  os, const XLCell &  c  )

inline

ostream output of XLCell content

Parameters

os	the ostream destination
c	the cell to output to the stream

Returns

operator<<() [2/3]

std::ostream & OpenXLSX::operator<< ( std::ostream &  os, const XLCellAssignable &  c  )

inline

ostream output of XLCellAssignable content

Parameters

os	the ostream destination
c	the cell to output to the stream

Returns

operator<<() [3/3]

std::ostream & OpenXLSX::operator<< ( std::ostream &  os, const XLCellIterator &  it  )

inline

operator<=()

bool OpenXLSX::operator<= ( const XLCellReference &  lhs, const XLCellReference &  rhs  )

inlinenoexcept

Asserts whether a cell sequentially precedes or occupies the exact same coordinate as another.

operator==() [1/4]

bool OpenXLSX::operator== ( const XLCell &  lhs, const XLCell &  rhs  )

inline

Parameters

lhs
rhs

Returns

operator==() [2/4]

bool OpenXLSX::operator== ( const XLCellReference &  lhs, const XLCellReference &  rhs  )

inlinenoexcept

Determines exact coordinate identity, allowing comparisons without resolving their DOM node equivalence.

operator==() [3/4]

bool OpenXLSX::operator== ( const XLRichText &  lhs, const XLRichText &  rhs  )

inline

operator==() [4/4]

bool OpenXLSX::operator== ( const XLRichTextRun &  lhs, const XLRichTextRun &  rhs  )

inline

operator>()

bool OpenXLSX::operator> ( const XLCellReference &  lhs, const XLCellReference &  rhs  )

inlinenoexcept

Inverts the less-than operator logic to verify strict left-to-right, top-to-bottom traversal dominance.

operator>=()

bool OpenXLSX::operator>= ( const XLCellReference &  lhs, const XLCellReference &  rhs  )

inlinenoexcept

Asserts whether a cell sequentially follows or occupies the exact same coordinate as another.

Rand32()

thread_local std::mt19937 OpenXLSX::Rand32

(

0

)

Use the std::mt19937 default return on operator()

Rand64()

uint64_t OpenXLSX::Rand64

(

)

Return a 64 bit random value (by invoking Rand32 twice)

Returns

A 64 bit random value

Combine values from two subsequent invocations of Rand32()

reorderAttributes()

void OpenXLSX::reorderAttributes

(

XMLNode &

node

)

Helper function to ensure attributes are in the correct OOXML order. Openpyxl order (which Excel likes): sqref, showDropDown, showInputMessage, showErrorMessage, allowBlank, errorTitle, error, promptTitle, prompt, type, operator, errorStyle.

sanitizeXmlString()

std::string OpenXLSX::sanitizeXmlString ( std::string_view  sv )

inline

Removes invalid XML 1.0 control characters from a string to prevent file corruption.

Parameters

sv	The string view to sanitize

Returns

A new std::string containing only valid XML 1.0 characters

setDefaultCellAttributes() [1/2]

void OpenXLSX::setDefaultCellAttributes ( XMLNode  cellNode, const char *  cellRef, XMLNode  rowNode, uint16_t  colNo, std::vector< XLStyleIndex > const &  colStyles = {}  )

inline

Overload accepting const char* for cell reference - avoids std::string allocation Performance optimization: for use in hot loops where address generation is frequent.

setDefaultCellAttributes() [2/2]

void OpenXLSX::setDefaultCellAttributes ( XMLNode  cellNode, const std::string &  cellRef, XMLNode  rowNode, uint16_t  colNo, std::vector< XLStyleIndex > const &  colStyles = {}  )

inline

set the cell reference, and a default cell style attribute if and only if row or column style is != XLDefaultCellFormat

Note

row style takes precedence over column style

Parameters

cellNode	the cell XML node
cellRef	the cell reference (attribute r) to set
rowNode	the row node for the cell
colNo	the column number for this cell (to try and fetch a column style)
colStyles	an optional std::vector<XLStyleIndex> that contains all pre-evaluated column styles, and can be used to avoid performance impact from lookup

setTabColor()

void OpenXLSX::setTabColor	(	const XMLDocument &	xmlDocument,
		const XLColor &	color
	)

Function for setting tab color.

Parameters

xmlDocument	XMLDocument object
color	Thr color to set

setTableAttribute()

void OpenXLSX::setTableAttribute	(	XMLNode &	node,
		std::string_view	name,
		std::string_view	value
	)

Helper to set table attributes in the correct physical order.

setTabSelected()

void OpenXLSX::setTabSelected	(	const XMLDocument &	xmlDocument,
		bool	selected
	)

Set the tab selected property to desired value.

Parameters

xmlDocument
selected

strTrim()

std::string OpenXLSX::strTrim

(

std::string

s

)

tabIsSelected()

bool OpenXLSX::tabIsSelected

(

const XMLDocument &

xmlDocument

)

Function for checking if the tab is selected.

Parameters

xmlDocument

Returns

toDouble()

double OpenXLSX::toDouble

(

const XLCellValue &

v

)

toString()

std::string OpenXLSX::toString

(

const XLCellValue &

v

)

UseRandomIDs()

void OpenXLSX::UseRandomIDs

(

)

Enable use of random (relationship) IDs.

Set the module-local status variable RandomIDs to true

UseSequentialIDs()

void OpenXLSX::UseSequentialIDs

(

)

Disable use of random (relationship) IDs (default behavior)

Set the module-local status variable RandomIDs to false

wouldBeDuplicateShapeType()

bool OpenXLSX::wouldBeDuplicateShapeType	(	XMLNode const &	rootNode,
		XMLNode const &	shapeTypeNode
	)

XLAboveAverageRule()

XLCfRule OpenXLSX::XLAboveAverageRule	(	bool	aboveAverage = true,
		bool	equalAverage = false,
		int16_t	stdDev = 0
	)

XLCellIsRule() [1/2]

XLCfRule OpenXLSX::XLCellIsRule	(	const std::string &	op,
		const std::string &	value
	)

XLCellIsRule() [2/2]

XLCfRule OpenXLSX::XLCellIsRule	(	XLCfOperator	op,
		const std::string &	value
	)

XLCfOperatorFromString()

XLCfOperator OpenXLSX::XLCfOperatorFromString

(

std::string const &

operatorString

)

get the correct XLCfOperator from the OOXML cfRule operator attribute string

Parameters

operatorString

the string as used in the OOXML

Returns

the corresponding XLCfOperator enum value

XLCfOperatorToString()

std::string OpenXLSX::XLCfOperatorToString

(

XLCfOperator

cfOperator

)

inverse of XLCfOperatorFromString

Parameters

cfOperator

the XLCfOperator for which to get the OOXML string

XLCfTimePeriodFromString()

XLCfTimePeriod OpenXLSX::XLCfTimePeriodFromString

(

std::string const &

timePeriodString

)

get the correct XLCfTimePeriod from the OOXML cfRule timePeriod attribute string

Parameters

timePeriodString

the string as used in the OOXML

Returns

the corresponding XLCfTimePeriod enum value

XLCfTimePeriodToString()

std::string OpenXLSX::XLCfTimePeriodToString

(

XLCfTimePeriod

cfTimePeriod

)

inverse of XLCfTimePeriodFromString

Parameters

cfTimePeriod

the XLCfTimePeriod for which to get the OOXML string

XLCfTypeFromString()

XLCfType OpenXLSX::XLCfTypeFromString

(

std::string const &

typeString

)

get the correct XLCfType from the OOXML cfRule type attribute string

Parameters

typeString

the string as used in the OOXML

Returns

the corresponding XLCfType enum value

XLCfTypeToString()

std::string OpenXLSX::XLCfTypeToString

(

XLCfType

cfType

)

inverse of XLCfTypeFromString

Parameters

cfType

the type for which to get the OOXML string

XLCfvoTypeFromString()

XLCfvoType OpenXLSX::XLCfvoTypeFromString

(

std::string const &

cfvoTypeString

)

XLCfvoTypeToString()

std::string OpenXLSX::XLCfvoTypeToString

(

XLCfvoType

cfvoType

)

XLColorScaleRule() [1/2]

XLCfRule OpenXLSX::XLColorScaleRule	(	const XLColor &	minColor,
		const XLColor &	maxColor
	)

XLColorScaleRule() [2/2]

XLCfRule OpenXLSX::XLColorScaleRule	(	const XLColor &	minColor,
		const XLColor &	midColor,
		const XLColor &	maxColor
	)

XLContainsBlanksRule()

XLCfRule OpenXLSX::XLContainsBlanksRule

(

)

XLContainsErrorsRule()

XLCfRule OpenXLSX::XLContainsErrorsRule

(

)

XLContainsTextRule()

XLCfRule OpenXLSX::XLContainsTextRule

(

const std::string &

text

)

XLContentTypeString()

std::string OpenXLSX::XLContentTypeString ( OpenXLSX::XLContentType const &  t )

inline

Get a string representation of OpenXLSX::XLContentType.

Parameters

t	an OpenXLSX::XLContentType value

Returns

a std::string containing the descriptive name of the content type

XLContentTypeToString()

std::string OpenXLSX::XLContentTypeToString

(

XLContentType

type

)

utility function: determine the name of an XLContentType value

Parameters

type	the XLContentType to get a name for

Returns

a string with the name of type

XLDataBarAxisPositionFromString()

XLDataBarAxisPosition OpenXLSX::XLDataBarAxisPositionFromString

(

std::string const &

positionString

)

XLDataBarAxisPositionToString()

std::string OpenXLSX::XLDataBarAxisPositionToString

(

XLDataBarAxisPosition

position

)

XLDataBarDirectionFromString()

XLDataBarDirection OpenXLSX::XLDataBarDirectionFromString

(

std::string const &

directionString

)

XLDataBarDirectionToString()

std::string OpenXLSX::XLDataBarDirectionToString

(

XLDataBarDirection

direction

)

XLDataBarRule()

XLCfRule OpenXLSX::XLDataBarRule	(	const XLColor &	color,
		bool	showValue = true
	)

XLDuplicateValuesRule()

XLCfRule OpenXLSX::XLDuplicateValuesRule

(

bool

unique = false

)

XLDynamicFilterTypeToString()

std::string OpenXLSX::XLDynamicFilterTypeToString

(

XLDynamicFilterType

type

)

Helper function to convert enum to string.

XLFormulaRule()

XLCfRule OpenXLSX::XLFormulaRule

(

const std::string &

formula

)

XLIconSetRule()

XLCfRule OpenXLSX::XLIconSetRule	(	const std::string &	iconSetName = "3TrafficLights1",
		bool	showValue = true,
		bool	reverse = false
	)

XLNotContainsBlanksRule()

XLCfRule OpenXLSX::XLNotContainsBlanksRule

(

)

XLNotContainsErrorsRule()

XLCfRule OpenXLSX::XLNotContainsErrorsRule

(

)

XLNotContainsTextRule()

XLCfRule OpenXLSX::XLNotContainsTextRule

(

const std::string &

text

)

XLPaneFromString()

XLPane OpenXLSX::XLPaneFromString

(

std::string const &

paneString

)

inverse of XLPaneToString

Parameters

paneString

the string for which to get the XLPane

XLPaneStateFromString()

XLPaneState OpenXLSX::XLPaneStateFromString

(

std::string const &

stateString

)

inverse of XLPaneStateToString

Parameters

stateString

the string for which to get the XLPaneState

XLPaneStateToString()

std::string OpenXLSX::XLPaneStateToString

(

XLPaneState

state

)

get the correct XLPaneState from the OOXML pane state attribute string

Parameters

stateString

the string as used in the OOXML

Returns

the corresponding XLPaneState enum value

XLPaneToString()

std::string OpenXLSX::XLPaneToString

(

XLPane

pane

)

get the correct XLPane from the OOXML pane identifier attribute string

Parameters

paneString

the string as used in the OOXML

Returns

the corresponding XLPane enum value

XLRelationshipTypeString()

std::string OpenXLSX::XLRelationshipTypeString ( OpenXLSX::XLRelationshipType const &  t )

inline

Get a string representation of OpenXLSX::XLRelationshipType.

Parameters

t	an OpenXLSX::XLRelationshipType value

Returns

std::string containing the descriptive name of the relationship type

XLShapeTextHAlignFromString()

XLShapeTextHAlign OpenXLSX::XLShapeTextHAlignFromString

(

std::string_view

hAlignString

)

XLShapeTextHAlignToString()

std::string OpenXLSX::XLShapeTextHAlignToString

(

XLShapeTextHAlign

hAlign

)

XLShapeTextVAlignFromString()

XLShapeTextVAlign OpenXLSX::XLShapeTextVAlignFromString

(

std::string_view

vAlignString

)

XLShapeTextVAlignToString()

std::string OpenXLSX::XLShapeTextVAlignToString

(

XLShapeTextVAlign

vAlign

)

XLTop10Rule()

XLCfRule OpenXLSX::XLTop10Rule	(	uint16_t	rank = 10,
		bool	percent = false,
		bool	bottom = false
	)

XLValueTypeString()

std::string OpenXLSX::XLValueTypeString ( XLValueType  t )

inline

Get a string representation of pugi::xml_node_type.

Parameters

t	the pugi::xml_node_type of a node

Returns

a std::string containing the descriptive name of the node type

xml_node_type_string()

std::string OpenXLSX::xml_node_type_string ( pugi::xml_node_type  t )

inline

Get a string representation of pugi::xml_node_type.

Parameters

t	the pugi::xml_node_type of a node

Returns

a std::string containing the descriptive name of the node type

xmlNodeFingerprint()

std::string OpenXLSX::xmlNodeFingerprint ( const XMLNode &  node )

inline

Compute a canonical, deterministic string fingerprint of a pugixml subtree.

Walks attributes (in document order) and element children recursively. Whitespace-only pcdata nodes are skipped so that XML indentation differences do not create false mismatches. The resulting string is suitable as a key in std::unordered_map for O(1) style deduplication lookups.

Variable Documentation

ColumnNodeOrder

const std::vector<std::string_view> OpenXLSX::ColumnNodeOrder = {"calculatedColumnFormula", "totalsRowFormula", "xmlColumnPr", "extLst"}

DEFAULT_IMAGE_SIZE

constexpr uint32_t OpenXLSX::DEFAULT_IMAGE_SIZE = 100

constexpr

EMU_PER_PIXEL

constexpr uint32_t OpenXLSX::EMU_PER_PIXEL = 9525

constexpr

MAX_COLS

constexpr uint16_t OpenXLSX::MAX_COLS = 16'384

inlineconstexpr

MAX_ROWS

constexpr uint32_t OpenXLSX::MAX_ROWS = 1'048'576

inlineconstexpr

MAX_SHAPE_ANCHOR_COLUMN

constexpr uint16_t OpenXLSX::MAX_SHAPE_ANCHOR_COLUMN = 13067

inlineconstexpr

MAX_SHAPE_ANCHOR_ROW

constexpr uint32_t OpenXLSX::MAX_SHAPE_ANCHOR_ROW = 852177

inlineconstexpr

NO_XML_NS

thread_local bool OpenXLSX::NO_XML_NS = true

With namespace support: where OpenXLSX already addresses nodes by their namespace, doubling the namespace in a node name upon node create can be avoided by passing the optional parameter XLForceNamespace - this will use the node name passed to the insertion function "as-is". Affected XMLNode methods: ::set_name, ::append_child, ::prepend_child, ::insert_child_after, ::insert_child_before

pugi_parse_settings

constexpr const unsigned int OpenXLSX::pugi_parse_settings = pugi::parse_default | pugi::parse_ws_pcdata

constexpr

Rand32

thread_local std::mt19937 OpenXLSX::Rand32

extern

Return a 32 bit random value.

Returns

A 32 bit random value

ShapeNodeName

constexpr std::string_view OpenXLSX::ShapeNodeName = "v:shape"

constexpr

ShapeTypeNodeName

constexpr std::string_view OpenXLSX::ShapeTypeNodeName = "v:shapetype"

constexpr

SORT_INDEX_NOT_FOUND

constexpr const int OpenXLSX::SORT_INDEX_NOT_FOUND = -1

constexpr

find the index of nodeName in nodeOrder

Parameters

nodeName	search this
nodeOrder	in this

Returns

index of nodeName in nodeOrder

-1 if nodeName is not an element of nodeOrder

Note

this function uses a vector of std::string_view because std::string is not constexpr-capable, and in a future c++20 build, a std::span could be used to have the node order in any OpenXLSX class be a constexpr

TableAttributeOrder

const std::vector<std::string_view> OpenXLSX::TableAttributeOrder

Initial value:

= {"id",
                                                               "name",
                                                               "displayName",
                                                               "ref",
                                                               "tableType",
                                                               "headerRowDxfId",
                                                               "dataDxfId",
                                                               "headerRowCount",
                                                               "insertRow",
                                                               "insertRowShift",
                                                               "totalsRowCount",
                                                               "totalsRowShown",
                                                               "published",
                                                               "comment"}

The TableAttributeOrder defines the mandatory physical sequence of attributes in the.

.

TableNodeOrder

const std::vector<std::string_view> OpenXLSX::TableNodeOrder = {"autoFilter", "sortState", "tableColumns", "tableStyleInfo", "extLst"}

The TableNodeOrder vector defines the order of nodes in the table XML file.

XLCreateIfMissing

constexpr const bool OpenXLSX::XLCreateIfMissing = true

constexpr

XLDefaultCellFormat

constexpr const XLStyleIndex OpenXLSX::XLDefaultCellFormat = 0

constexpr

XLDefaultCfRulePrefix

constexpr const char* OpenXLSX::XLDefaultCfRulePrefix = "\n\t\t"

constexpr

XLDefaultConditionalFormattingPrefix

constexpr const char* OpenXLSX::XLDefaultConditionalFormattingPrefix = "\n\t"

constexpr

XLDefaultFillType

constexpr const XLFillType OpenXLSX::XLDefaultFillType = XLPatternFill

constexpr

XLDefaultFontCharset

constexpr const uint32_t OpenXLSX::XLDefaultFontCharset = 1

constexpr

XLDefaultFontColor

constexpr const char* OpenXLSX::XLDefaultFontColor = "ff000000"

constexpr

XLDefaultFontColorTheme

constexpr const char* OpenXLSX::XLDefaultFontColorTheme = ""

constexpr

XLDefaultFontFamily

constexpr const uint32_t OpenXLSX::XLDefaultFontFamily = 0

constexpr

XLDefaultFontName

constexpr const char* OpenXLSX::XLDefaultFontName = "Arial"

constexpr

XLDefaultFontSize

constexpr const uint32_t OpenXLSX::XLDefaultFontSize = 12

constexpr

XLDefaultLineStyle

constexpr const char* OpenXLSX::XLDefaultLineStyle = ""

constexpr

XLDefaultPatternBgColor

constexpr const char* OpenXLSX::XLDefaultPatternBgColor = "ff000000"

constexpr

XLDefaultPatternFgColor

constexpr const char* OpenXLSX::XLDefaultPatternFgColor = "ffffffff"

constexpr

XLDefaultPatternType

constexpr const XLPatternType OpenXLSX::XLDefaultPatternType = XLPatternNone

constexpr

XLDefaultShapeTextHAlign

constexpr const XLShapeTextHAlign OpenXLSX::XLDefaultShapeTextHAlign = XLShapeTextHAlign::Left

constexpr

XLDefaultShapeTextVAlign

constexpr const XLShapeTextVAlign OpenXLSX::XLDefaultShapeTextVAlign = XLShapeTextVAlign::Top

constexpr

XLDefaultStyleEntriesPrefix

constexpr const char* OpenXLSX::XLDefaultStyleEntriesPrefix = "\n\t\t"

constexpr

XLDefaultStylesPrefix

constexpr const char* OpenXLSX::XLDefaultStylesPrefix = "\n\t"

constexpr

XLDeleteProperty

constexpr const uint32_t OpenXLSX::XLDeleteProperty = XLInvalidUInt32

constexpr

XLDoNotCreate

constexpr const bool OpenXLSX::XLDoNotCreate = false

constexpr

XLDoNotOverwrite

constexpr const bool OpenXLSX::XLDoNotOverwrite = false

constexpr

XLEmptyHiddenCells

constexpr const bool OpenXLSX::XLEmptyHiddenCells = true

constexpr

XLForceFillType

constexpr const bool OpenXLSX::XLForceFillType = true

constexpr

XLForceNamespace

constexpr const bool OpenXLSX::XLForceNamespace = true

constexpr

XLForceOverwrite

constexpr const bool OpenXLSX::XLForceOverwrite = true

constexpr

XLInvalidStyleIndex

constexpr const XLStyleIndex OpenXLSX::XLInvalidStyleIndex = XLInvalidUInt32

constexpr

XLInvalidUInt16

constexpr const uint32_t OpenXLSX::XLInvalidUInt16 = 0xffff

constexpr

XLInvalidUInt32

constexpr const uint32_t OpenXLSX::XLInvalidUInt32 = 0xffffffff

constexpr

XLKeepAttributes

constexpr const bool OpenXLSX::XLKeepAttributes = false

constexpr

XLKeepCellFormula

constexpr const uint32_t OpenXLSX::XLKeepCellFormula = 8

constexpr

XLKeepCellStyle

constexpr const uint32_t OpenXLSX::XLKeepCellStyle = 1

constexpr

XLKeepCellType

constexpr const uint32_t OpenXLSX::XLKeepCellType = 2

constexpr

XLKeepCellValue

constexpr const uint32_t OpenXLSX::XLKeepCellValue = 4

constexpr

XLMaxMergeCells

constexpr size_t OpenXLSX::XLMaxMergeCells = (std::numeric_limits<XLMergeIndex>::max)()

constexpr

XLMaxSharedStrings

constexpr size_t OpenXLSX::XLMaxSharedStrings = (std::numeric_limits<int32_t>::max)()

constexpr

XLMergeNotFound

constexpr const XLMergeIndex OpenXLSX::XLMergeNotFound = -1

constexpr

XLPermitXfID

constexpr const bool OpenXLSX::XLPermitXfID = true

constexpr

XLPreserveValue

constexpr bool OpenXLSX::XLPreserveValue = false

constexpr

XLPriorityNotSet

constexpr const uint16_t OpenXLSX::XLPriorityNotSet = 0

constexpr

XLRemoveAttributes

constexpr const bool OpenXLSX::XLRemoveAttributes = true

constexpr

XLResetValue

constexpr bool OpenXLSX::XLResetValue = true

constexpr

XLSharedStringsDefaulted

const XLSharedStrings OpenXLSX::XLSharedStringsDefaulted {}

XLSheetViewNodeOrder

const std::vector<std::string_view> OpenXLSX::XLSheetViewNodeOrder

Initial value:

= {    
        "pane",
        "selection",
        "pivotSelection",
        "extLst"}

XLWorksheetNodeOrder

const std::vector<std::string_view> OpenXLSX::XLWorksheetNodeOrder

XLXmlDefaultEncoding

constexpr const char* OpenXLSX::XLXmlDefaultEncoding = "UTF-8"

constexpr

XLXmlDefaultVersion

constexpr const char* OpenXLSX::XLXmlDefaultVersion = "1.0"

constexpr

XLXmlNotStandalone

constexpr const bool OpenXLSX::XLXmlNotStandalone = false

constexpr

XLXmlStandalone

constexpr const bool OpenXLSX::XLXmlStandalone = true

constexpr