OpenXLSX::XLPivotTableOptions Class Reference

#include <XLPivotTable.hpp>

Public Member Functions
	XLPivotTableOptions (std::string name, std::string sourceRange, std::string targetCell)
	Construct fully initialized Pivot Table options.
XLPivotTableOptions &	addRowField (std::string fieldName)
XLPivotTableOptions &	addColumnField (std::string fieldName)
XLPivotTableOptions &	addDataField (std::string fieldName, std::string customName="", XLPivotSubtotal subtotal=XLPivotSubtotal::Sum, uint32_t numFmtId=0)
XLPivotTableOptions &	addFilterField (std::string fieldName)
XLPivotTableOptions &	setPivotTableStyle (std::string styleName)
XLPivotTableOptions &	setDataOnRows (bool value)
XLPivotTableOptions &	setRowGrandTotals (bool value)
XLPivotTableOptions &	setColGrandTotals (bool value)
XLPivotTableOptions &	setShowDrill (bool value)
XLPivotTableOptions &	setUseAutoFormatting (bool value)
XLPivotTableOptions &	setPageOverThenDown (bool value)
XLPivotTableOptions &	setMergeItem (bool value)
XLPivotTableOptions &	setCompactData (bool value)
XLPivotTableOptions &	setShowError (bool value)
XLPivotTableOptions &	setShowRowHeaders (bool value)
XLPivotTableOptions &	setShowColHeaders (bool value)
XLPivotTableOptions &	setShowRowStripes (bool value)
XLPivotTableOptions &	setShowColStripes (bool value)
XLPivotTableOptions &	setShowLastColumn (bool value)
const std::string &	name () const
const std::string &	sourceRange () const
const std::string &	targetCell () const
const std::vector< XLPivotField > &	rows () const
const std::vector< XLPivotField > &	columns () const
const std::vector< XLPivotField > &	data () const
const std::vector< XLPivotField > &	filters () const
const std::string &	pivotTableStyleName () const
bool	dataOnRows () const
bool	rowGrandTotals () const
bool	colGrandTotals () const
bool	showDrill () const
bool	useAutoFormatting () const
bool	pageOverThenDown () const
bool	mergeItem () const
bool	compactData () const
bool	showError () const
bool	showRowHeaders () const
bool	showColHeaders () const
bool	showRowStripes () const
bool	showColStripes () const
bool	showLastColumn () const

Constructor & Destructor Documentation

XLPivotTableOptions()

OpenXLSX::XLPivotTableOptions::XLPivotTableOptions ( std::string  name, std::string  sourceRange, std::string  targetCell  )

inline

Construct fully initialized Pivot Table options.

Parameters

name	The unique name for the pivot table (e.g., "PivotTable1").
sourceRange	The data source range (e.g., "Sheet1!A1:D100").
targetCell	The cell to anchor the pivot table (e.g., "A3").

Member Function Documentation

addColumnField()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::addColumnField ( std::string  fieldName )

inline

addDataField()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::addDataField ( std::string  fieldName, std::string  customName = "", XLPivotSubtotal  subtotal = XLPivotSubtotal::Sum, uint32_t  numFmtId = 0  )

inline

addFilterField()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::addFilterField ( std::string  fieldName )

inline

addRowField()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::addRowField ( std::string  fieldName )

inline

colGrandTotals()

bool OpenXLSX::XLPivotTableOptions::colGrandTotals ( ) const

inline

columns()

const std::vector< XLPivotField > & OpenXLSX::XLPivotTableOptions::columns ( ) const

inline

compactData()

bool OpenXLSX::XLPivotTableOptions::compactData ( ) const

inline

data()

const std::vector< XLPivotField > & OpenXLSX::XLPivotTableOptions::data ( ) const

inline

dataOnRows()

bool OpenXLSX::XLPivotTableOptions::dataOnRows ( ) const

inline

filters()

const std::vector< XLPivotField > & OpenXLSX::XLPivotTableOptions::filters ( ) const

inline

mergeItem()

bool OpenXLSX::XLPivotTableOptions::mergeItem ( ) const

inline

name()

const std::string & OpenXLSX::XLPivotTableOptions::name ( ) const

inline

pageOverThenDown()

bool OpenXLSX::XLPivotTableOptions::pageOverThenDown ( ) const

inline

pivotTableStyleName()

const std::string & OpenXLSX::XLPivotTableOptions::pivotTableStyleName ( ) const

inline

rowGrandTotals()

bool OpenXLSX::XLPivotTableOptions::rowGrandTotals ( ) const

inline

rows()

const std::vector< XLPivotField > & OpenXLSX::XLPivotTableOptions::rows ( ) const

inline

setColGrandTotals()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setColGrandTotals ( bool  value )

inline

setCompactData()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setCompactData ( bool  value )

inline

setDataOnRows()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setDataOnRows ( bool  value )

inline

setMergeItem()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setMergeItem ( bool  value )

inline

setPageOverThenDown()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setPageOverThenDown ( bool  value )

inline

setPivotTableStyle()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setPivotTableStyle ( std::string  styleName )

inline

setRowGrandTotals()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setRowGrandTotals ( bool  value )

inline

setShowColHeaders()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setShowColHeaders ( bool  value )

inline

setShowColStripes()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setShowColStripes ( bool  value )

inline

setShowDrill()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setShowDrill ( bool  value )

inline

setShowError()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setShowError ( bool  value )

inline

setShowLastColumn()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setShowLastColumn ( bool  value )

inline

setShowRowHeaders()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setShowRowHeaders ( bool  value )

inline

setShowRowStripes()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setShowRowStripes ( bool  value )

inline

setUseAutoFormatting()

XLPivotTableOptions & OpenXLSX::XLPivotTableOptions::setUseAutoFormatting ( bool  value )

inline

showColHeaders()

bool OpenXLSX::XLPivotTableOptions::showColHeaders ( ) const

inline

showColStripes()

bool OpenXLSX::XLPivotTableOptions::showColStripes ( ) const

inline

showDrill()

bool OpenXLSX::XLPivotTableOptions::showDrill ( ) const

inline

showError()

bool OpenXLSX::XLPivotTableOptions::showError ( ) const

inline

showLastColumn()

bool OpenXLSX::XLPivotTableOptions::showLastColumn ( ) const

inline

showRowHeaders()

bool OpenXLSX::XLPivotTableOptions::showRowHeaders ( ) const

inline

showRowStripes()

bool OpenXLSX::XLPivotTableOptions::showRowStripes ( ) const

inline

sourceRange()

const std::string & OpenXLSX::XLPivotTableOptions::sourceRange ( ) const

inline

targetCell()

const std::string & OpenXLSX::XLPivotTableOptions::targetCell ( ) const

inline

useAutoFormatting()

bool OpenXLSX::XLPivotTableOptions::useAutoFormatting ( ) const

inline

---

The documentation for this class was generated from the following file:

• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/headers/XLPivotTable.hpp