bridges::datastructure::BarChart Class Reference

#include <BarChart.h>

Inheritance diagram for bridges::datastructure::BarChart:

Public Member Functions
	BarChart ()
virtual const string	getDStype () const override
	Get the data type. More...
void	setTitle (std::string t)
	Title of the plot. More...
std::string	getTitle () const
	Title of the plot. More...
void	setSubTitle (std::string s)
	Subtitle of the plot. More...
std::string	getSubTitle () const
	Subtitle of the plot. More...
void	setSeriesLabel (std::string yaxisName)
	Change the label for the Y-axis. More...
std::string	getSeriesLabel () const
	Returns the label for the Y-axis. More...
void	setBinsLabel (std::string xaxisName)
	Change the label for the X-axis. More...
std::string	getBinsLabel () const
	Returns the label for the Y-axis. More...
void	setBarAlignment (std::string align)
std::string	getBarAlignment () const
void	setTooltipSuffix (std::string suffix)
std::string	getTooltipSuffix () const
void	setSeriesBins (std::vector< std::string > bins)
void	addDataSeries (std::string seriesName, std::vector< double > data)
	Add a series (or update it) More...
virtual const std::string	getDataStructureRepresentation () const override
Public Member Functions inherited from bridges::datastructure::DataStructure
virtual	~DataStructure ()=default

Constructor & Destructor Documentation

BarChart()

bridges::datastructure::BarChart::BarChart ( )

inline

Member Function Documentation

addDataSeries()

void bridges::datastructure::BarChart::addDataSeries ( std::string  seriesName, std::vector< double >  data  )

inline

Add a series (or update it)

Parameters

seriesName	indicates the series to add (or change)
xdata	the X data in the series
ydata	the Y data in the series

getBarAlignment()

std::string bridges::datastructure::BarChart::getBarAlignment ( ) const

inline

getBinsLabel()

std::string bridges::datastructure::BarChart::getBinsLabel ( ) const

inline

Returns the label for the Y-axis.

Returns

label shown for the Y-axis

getDataStructureRepresentation()

virtual const std::string bridges::datastructure::BarChart::getDataStructureRepresentation ( ) const

inlineoverridevirtual

Ease of use function for the deletion of an entire datastructure. Overrides should call delete on itself and each linked data structure

Warning

Only call if all these data structures were all dynamicaly allocated(aka: using new) Gets the JSON representation of this DataStructure's nodes and links

Returns

The JSON representation of the data structure: A pair holding the nodes and links JSON strings respectively

Implements bridges::datastructure::DataStructure.

getDStype()

virtual const string bridges::datastructure::BarChart::getDStype ( ) const

inlineoverridevirtual

Get the data type.

Returns

name of the data type (used internally)

Implements bridges::datastructure::DataStructure.

getSeriesLabel()

std::string bridges::datastructure::BarChart::getSeriesLabel ( ) const

inline

Returns the label for the Y-axis.

Returns

label shown for the Y-axis

getSubTitle()

std::string bridges::datastructure::BarChart::getSubTitle ( ) const

inline

Subtitle of the plot.

Returns

the subtitle to be shown

getTitle()

std::string bridges::datastructure::BarChart::getTitle ( ) const

inline

Title of the plot.

Returns

the title to be shown

getTooltipSuffix()

std::string bridges::datastructure::BarChart::getTooltipSuffix ( ) const

inline

setBarAlignment()

void bridges::datastructure::BarChart::setBarAlignment ( std::string  align )

inline

setBinsLabel()

void bridges::datastructure::BarChart::setBinsLabel ( std::string  xaxisName )

inline

Change the label for the X-axis.

Parameters

xaxisName

label to use for the X-axis

setSeriesBins()

void bridges::datastructure::BarChart::setSeriesBins ( std::vector< std::string >  bins )

inline

setSeriesLabel()

void bridges::datastructure::BarChart::setSeriesLabel ( std::string  yaxisName )

inline

Change the label for the Y-axis.

Parameters

yaxisName

label to show for the Y-axis

setSubTitle()

void bridges::datastructure::BarChart::setSubTitle ( std::string  s )

inline

Subtitle of the plot.

Parameters

s	the subtitle to be shown

setTitle()

void bridges::datastructure::BarChart::setTitle ( std::string  t )

inline

Title of the plot.

Parameters

t	the title to be shown

setTooltipSuffix()

void bridges::datastructure::BarChart::setTooltipSuffix ( std::string  suffix )

inline

---

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

• /home/erik/work/bridges/bridges-cxx/src/BarChart.h