OpenXLSX::XLPivotCacheDefinition Class Reference

#include <XLPivotTable.hpp>

Inheritance diagram for OpenXLSX::XLPivotCacheDefinition:

Public Member Functions
class XLRelationships	relationships ()
	XLPivotCacheDefinition ()
	XLPivotCacheDefinition (XLXmlData *xmlData)
	~XLPivotCacheDefinition ()=default
	XLPivotCacheDefinition (const XLPivotCacheDefinition &other)=default
	XLPivotCacheDefinition (XLPivotCacheDefinition &&other) noexcept=default
XLPivotCacheDefinition &	operator= (const XLPivotCacheDefinition &other)=default
XLPivotCacheDefinition &	operator= (XLPivotCacheDefinition &&other) noexcept=default
std::string	sourceRange () const
	Get the data source range (e.g., "Sheet1!A1:D100").
void	changeSourceRange (std::string_view newRange)
	Change the data source range for the pivot cache.
Public Member Functions inherited from OpenXLSX::XLXmlFile
	XLXmlFile ()=default
	Default constructor.
std::string	xmlData (XLXmlSavingDeclaration savingDeclaration=XLXmlSavingDeclaration{}) const
	Method for getting the XML data represented by the object.
	XLXmlFile (XLXmlData *xmlData)
	Constructor. Creates an object based on the xmlData input.
	XLXmlFile (const XLXmlFile &other)=default
	Copy constructor. Default implementation used.
	XLXmlFile (XLXmlFile &&other) noexcept=default
	Move constructor. Default implementation used.
	~XLXmlFile ()=default
	Destructor. Default implementation used.
bool	valid () const
	check whether class is linked to a valid XML file
XLXmlFile &	operator= (const XLXmlFile &other)=default
	The copy assignment operator. The default implementation has been used.
XLXmlFile &	operator= (XLXmlFile &&other) noexcept=default
	The move assignment operator. The default implementation has been used.
XLDocument &	parentDoc ()
	This function provides access to the parent XLDocument object.
const XLDocument &	parentDoc () const
	This function provides access to the parent XLDocument object.
XMLDocument &	xmlDocument ()
	This function provides access to the underlying XMLDocument object.
const XMLDocument &	xmlDocument () const
	This function provides access to the underlying XMLDocument object.
std::string	getXmlPath () const
	Retrieve the path of the XML data in the .xlsx zip archive via m_xmlData->getXmlPath.

Additional Inherited Members
Protected Member Functions inherited from OpenXLSX::XLXmlFile
void	setXmlData (std::string_view xmlData)
	Provide the XML data represented by the object.
std::string	relationshipID () const
	This function returns the relationship ID (the ID used in the XLRelationships objects) for the object.
Protected Attributes inherited from OpenXLSX::XLXmlFile
XLXmlData *	m_xmlData {nullptr}

Constructor & Destructor Documentation

XLPivotCacheDefinition() [1/4]

OpenXLSX::XLPivotCacheDefinition::XLPivotCacheDefinition ( )

inline

XLPivotCacheDefinition() [2/4]

OpenXLSX::XLPivotCacheDefinition::XLPivotCacheDefinition ( XLXmlData *  xmlData )

explicit

~XLPivotCacheDefinition()

OpenXLSX::XLPivotCacheDefinition::~XLPivotCacheDefinition ( )

default

XLPivotCacheDefinition() [3/4]

OpenXLSX::XLPivotCacheDefinition::XLPivotCacheDefinition ( const XLPivotCacheDefinition &  other )

default

XLPivotCacheDefinition() [4/4]

OpenXLSX::XLPivotCacheDefinition::XLPivotCacheDefinition ( XLPivotCacheDefinition &&  other )

defaultnoexcept

Member Function Documentation

changeSourceRange()

void OpenXLSX::XLPivotCacheDefinition::changeSourceRange

(

std::string_view

newRange

)

Change the data source range for the pivot cache.

Parameters

newRange

The new source range (e.g., "Sheet1!A1:E200").

operator=() [1/2]

XLPivotCacheDefinition & OpenXLSX::XLPivotCacheDefinition::operator= ( const XLPivotCacheDefinition &  other )

default

operator=() [2/2]

XLPivotCacheDefinition & OpenXLSX::XLPivotCacheDefinition::operator= ( XLPivotCacheDefinition &&  other )

defaultnoexcept

relationships()

XLRelationships OpenXLSX::XLPivotCacheDefinition::relationships

(

)

sourceRange()

std::string OpenXLSX::XLPivotCacheDefinition::sourceRange

(

)

const

Get the data source range (e.g., "Sheet1!A1:D100").

---

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

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