OpenXLSX::XLPivotTable Class Reference

#include <XLPivotTable.hpp>

Inheritance diagram for OpenXLSX::XLPivotTable:

Public Member Functions
class XLRelationships	relationships ()
	XLPivotTable ()
	XLPivotTable (XLXmlData *xmlData)
	~XLPivotTable ()=default
	XLPivotTable (const XLPivotTable &other)=default
	XLPivotTable (XLPivotTable &&other) noexcept=default
XLPivotTable &	operator= (const XLPivotTable &other)=default
XLPivotTable &	operator= (XLPivotTable &&other) noexcept=default
void	setName (std::string_view name)
void	setRefreshOnLoad (bool refresh=true)
	Tell Excel to refresh this pivot table when the file is opened.
std::string	name () const
	Get the name of the pivot table.
std::string	targetCell () const
	Get the target location (e.g., "A3") of the pivot table in the worksheet.
std::string	sourceRange () const
	Get the data source range (e.g., "Sheet1!A1:D100").
class XLPivotCacheDefinition	cacheDefinition () const
	Get the pivot cache definition object.
void	changeSourceRange (std::string_view newRange)
	Change the data source range for the pivot table.
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

XLPivotTable() [1/4]

OpenXLSX::XLPivotTable::XLPivotTable ( )

inline

XLPivotTable() [2/4]

OpenXLSX::XLPivotTable::XLPivotTable ( XLXmlData *  xmlData )

explicit

~XLPivotTable()

OpenXLSX::XLPivotTable::~XLPivotTable ( )

default

XLPivotTable() [3/4]

OpenXLSX::XLPivotTable::XLPivotTable ( const XLPivotTable &  other )

default

XLPivotTable() [4/4]

OpenXLSX::XLPivotTable::XLPivotTable ( XLPivotTable &&  other )

defaultnoexcept

Member Function Documentation

cacheDefinition()

XLPivotCacheDefinition OpenXLSX::XLPivotTable::cacheDefinition

(

)

const

Get the pivot cache definition object.

changeSourceRange()

void OpenXLSX::XLPivotTable::changeSourceRange

(

std::string_view

newRange

)

Change the data source range for the pivot table.

Parameters

newRange

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

name()

std::string OpenXLSX::XLPivotTable::name

(

)

const

Get the name of the pivot table.

operator=() [1/2]

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

default

operator=() [2/2]

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

defaultnoexcept

relationships()

XLRelationships OpenXLSX::XLPivotTable::relationships

(

)

setName()

void OpenXLSX::XLPivotTable::setName

(

std::string_view

name

)

setRefreshOnLoad()

void OpenXLSX::XLPivotTable::setRefreshOnLoad

(

bool

refresh = true

)

Tell Excel to refresh this pivot table when the file is opened.

sourceRange()

std::string OpenXLSX::XLPivotTable::sourceRange

(

)

const

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

targetCell()

std::string OpenXLSX::XLPivotTable::targetCell

(

)

const

Get the target location (e.g., "A3") of the pivot table in the worksheet.

---

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