OpenXLSX 1.10.0
Loading...
Searching...
No Matches
OpenXLSX::XLSlicerCollection Class Reference

#include <XLSlicerCollection.hpp>

Data Structures

class  ConstIterator
 
class  Iterator
 

Public Member Functions

 XLSlicerCollection ()=default
 
 XLSlicerCollection (XLWorksheet *worksheet)
 
size_t count () const
 
bool empty () const
 
bool contains (std::string_view name) const
 
XLSlicer find (std::string_view name) const
 Returns a valid XLSlicer if found, or an invalid one (!valid()) if not.
 
XLSliceroperator[] (size_t index)
 
XLSliceroperator[] (std::string_view name)
 
const XLSliceroperator[] (size_t index) const
 
Iterator begin ()
 
Iterator end ()
 
ConstIterator begin () const
 
ConstIterator end () const
 
size_t size () const
 
bool valid () const
 
XLSlicerBuilder add (std::string_view cellRef, const XLTable &table, std::string_view columnName)
 Add a slicer filtering a table column.
 
XLSlicerBuilder add (std::string_view cellRef, const XLPivotTable &pivotTable, std::string_view fieldName)
 Add a slicer filtering a pivot table field.
 
void remove (std::string_view name)
 
void remove (size_t index)
 
void reload ()
 

Constructor & Destructor Documentation

◆ XLSlicerCollection() [1/2]

OpenXLSX::XLSlicerCollection::XLSlicerCollection ( )
default

◆ XLSlicerCollection() [2/2]

XLSlicerCollection::XLSlicerCollection ( XLWorksheet worksheet)
explicit

Member Function Documentation

◆ add() [1/2]

XLSlicerBuilder XLSlicerCollection::add ( std::string_view  cellRef,
const XLPivotTable pivotTable,
std::string_view  fieldName 
)

Add a slicer filtering a pivot table field.

◆ add() [2/2]

XLSlicerBuilder XLSlicerCollection::add ( std::string_view  cellRef,
const XLTable table,
std::string_view  columnName 
)

Add a slicer filtering a table column.

◆ begin() [1/2]

XLSlicerCollection::Iterator XLSlicerCollection::begin ( )

◆ begin() [2/2]

XLSlicerCollection::ConstIterator XLSlicerCollection::begin ( ) const

◆ contains()

bool XLSlicerCollection::contains ( std::string_view  name) const

◆ count()

size_t XLSlicerCollection::count ( ) const

◆ empty()

bool XLSlicerCollection::empty ( ) const

◆ end() [1/2]

XLSlicerCollection::Iterator XLSlicerCollection::end ( )

◆ end() [2/2]

XLSlicerCollection::ConstIterator XLSlicerCollection::end ( ) const

◆ find()

XLSlicer XLSlicerCollection::find ( std::string_view  name) const

Returns a valid XLSlicer if found, or an invalid one (!valid()) if not.

◆ operator[]() [1/3]

XLSlicer & XLSlicerCollection::operator[] ( size_t  index)

◆ operator[]() [2/3]

const XLSlicer & XLSlicerCollection::operator[] ( size_t  index) const

◆ operator[]() [3/3]

XLSlicer & XLSlicerCollection::operator[] ( std::string_view  name)

◆ reload()

void XLSlicerCollection::reload ( )

◆ remove() [1/2]

void XLSlicerCollection::remove ( size_t  index)

◆ remove() [2/2]

void XLSlicerCollection::remove ( std::string_view  name)

◆ size()

size_t OpenXLSX::XLSlicerCollection::size ( ) const
inline

◆ valid()

bool OpenXLSX::XLSlicerCollection::valid ( ) const
inline

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