Show series of data or functions using a line chart. More...

#include <LineChart.h>

Inheritance diagram for bridges::datastructure::LineChart:

Public Member Functions
	LineChart ()

virtual const string	getDStype () const override
	Get the data type.

void	toggleMouseTrack (bool val)
	Enables or disables mouse tracking.

void	toggleSeriesLabel (bool val)
	Enables or disables series labels.

void	toggleLogarithmicX (bool val)
	Change the X-axis scale to logarithmic.

void	toggleLogarithmicY (bool val)
	Change the Y-axis scale to logarithmic.

void	setTitle (string t)
	Title of the plot.

string	getTitle () const
	Title of the plot.

void	setSubTitle (string s)
	Subtitle of the plot.

string	getSubTitle () const
	Subtitle of the plot.

void	setYLabel (string yaxisName)
	Change the label for the Y-axis.

string	getYLabel () const
	Returns the label for the Y-axis.

void	setXLabel (string xaxisName)
	Change the label for the X-axis.

string	getXLabel () const
	Returns the label for the Y-axis.

void	setLineWidth (string series, int w)
	width of line segments in the plot

int	getLineWidth (string series)
	Title of the plot.

void	setDataSeries (string seriesName, vector< double > xdata, vector< double > ydata)
	Add a series (or update it)

void	setXData (string series, vector< double > xdata)
	Changes the X data for a series.

vector< double >	getXData (string series)
	Returns the X data for a series.

void	setYData (string series, vector< double > ydata)
	Changes the Y data for a series.

vector< double >	getYData (string series)
	Returns the Y data for a series.

virtual const string	getDataStructureRepresentation () const override

Public Member Functions inherited from bridges::datastructure::DataStructure
virtual	~DataStructure ()=default

Detailed Description

Show series of data or functions using a line chart.

Line charts (https://en.wikipedia.org/wiki/Line_chart) are used to represent graphically functions such as f(x) = 3*x+1, or data such as temperature of a liquid on a stove as time passes. A individual function or a set of data is called "series".

A series is represented by two arrays xdata and ydata such that there is a point at (xdata[0], ydata[0]), an other at (xdata[1], ydata[1]), ... One can add a series by passing the two arrays using setDataSeries() or add the arrays individually using setXData() and setYData().

The different series have a label associated with them by default which can be disabled (see toggleSeriesLabel()).

The line width of the plot (if lines are used) is indexed by a pixel size (int) size of 0 means no lines

The data is typically shown with axes that use a linear scale. However, the scale can be changed to logarithmic for each axis individually (see toggleLogarithmicX() and toggleLogarithmic()).

The LineChart can have a title (see getTitle() and setTitle()) and a subtitle (see setSubTitle() and getSubTitle()).

Author: Erik Saule, Kalpathi Subramanian

Date: 7/16/19

Constructor & Destructor Documentation

◆ LineChart()

bridges::datastructure::LineChart::LineChart ( )

inline

Member Function Documentation

◆ getDataStructureRepresentation()

virtual const string bridges::datastructure::LineChart::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::LineChart::getDStype ( ) const

inlineoverridevirtual

Get the data type.

Returns: name of the data type (used internally)

Implements bridges::datastructure::DataStructure.

◆ getLineWidth()

int bridges::datastructure::LineChart::getLineWidth ( string series )

inline

Title of the plot.

Returns: the title to be shown

◆ getSubTitle()

string bridges::datastructure::LineChart::getSubTitle ( ) const

inline

Subtitle of the plot.

Returns: the subtitle to be shown

◆ getTitle()

string bridges::datastructure::LineChart::getTitle ( ) const

inline

Title of the plot.

Returns: the title to be shown

◆ getXData()

vector< double > bridges::datastructure::LineChart::getXData ( string series )

inline

Returns the X data for a series.

Parameters

series indicate the series to get

Returns: the X data of series or null if the series is not in there

◆ getXLabel()

string bridges::datastructure::LineChart::getXLabel ( ) const

inline

Returns the label for the Y-axis.

Returns: label shown for the Y-axis

◆ getYData()

vector< double > bridges::datastructure::LineChart::getYData ( string series )

inline

Returns the Y data for a series.

Parameters

series indicate the series to get

Returns: the Y data of series or null if the data is not in there

◆ getYLabel()

string bridges::datastructure::LineChart::getYLabel ( ) const

inline

Returns the label for the Y-axis.

Returns: label shown for the Y-axis

◆ setDataSeries()

void bridges::datastructure::LineChart::setDataSeries	(	string	seriesName,
		vector< double >	xdata,
		vector< double >	ydata
	)

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

◆ setLineWidth()

void bridges::datastructure::LineChart::setLineWidth	(	string	series,
		int	w
	)

inline

width of line segments in the plot

Parameters

w	pixel size

◆ setSubTitle()

void bridges::datastructure::LineChart::setSubTitle ( string s )

inline

Subtitle of the plot.

Parameters

s	the subtitle to be shown

◆ setTitle()

void bridges::datastructure::LineChart::setTitle ( string t )

inline

Title of the plot.

Parameters

t	the title to be shown

◆ setXData()

void bridges::datastructure::LineChart::setXData	(	string	series,
		vector< double >	xdata
	)

inline

Changes the X data for a series.

Parameters

series	indicates the series to get
xdata	the X data in the series

◆ setXLabel()

void bridges::datastructure::LineChart::setXLabel ( string xaxisName )

inline

Change the label for the X-axis.

Parameters

xaxisName label to use for the X-axis

◆ setYData()

void bridges::datastructure::LineChart::setYData	(	string	series,
		vector< double >	ydata
	)

inline

Changes the Y data for a series.

Parameters

series	indicates the series to get
ydata	the Y data in the series

◆ setYLabel()

void bridges::datastructure::LineChart::setYLabel ( string yaxisName )

inline

Change the label for the Y-axis.

Parameters

yaxisName label to show for the Y-axis

◆ toggleLogarithmicX()

void bridges::datastructure::LineChart::toggleLogarithmicX ( bool val )

inline

Change the X-axis scale to logarithmic.

When enabled, the X-axis scale becomes logarithmic (as opposed to linear).

Parameters

val	Should the X-axis use a logarithmic scale?

◆ toggleLogarithmicY()

void bridges::datastructure::LineChart::toggleLogarithmicY ( bool val )

inline

Change the Y-axis scale to logarithmic.

When enabled, the Y-axis scale becomes logarithmic (as opposed to linear).

Parameters

val	Should the Y-axis use a logarithmic scale?

◆ toggleMouseTrack()

void bridges::datastructure::LineChart::toggleMouseTrack ( bool val )

inline

Enables or disables mouse tracking.

Mouse tracking show the value of a data point when the mouse hovers on a data point.

Parameters

val	Should mouse tracking be activated or not.

◆ toggleSeriesLabel()

void bridges::datastructure::LineChart::toggleSeriesLabel ( bool val )

inline

Enables or disables series labels.

When enabled, the name of the series will be shown on the line chart.

Parameters

val	Should series be labeled or not

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

/home/erik/work/bridges/bridges-cxx/src/LineChart.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LineChart()

Member Function Documentation

◆ getDataStructureRepresentation()

◆ getDStype()

◆ getLineWidth()

◆ getSubTitle()

◆ getTitle()

◆ getXData()

◆ getXLabel()

◆ getYData()

◆ getYLabel()

◆ setDataSeries()

◆ setLineWidth()

◆ setSubTitle()

◆ setTitle()

◆ setXData()

◆ setXLabel()

◆ setYData()

◆ setYLabel()

◆ toggleLogarithmicX()

◆ toggleLogarithmicY()

◆ toggleMouseTrack()

◆ toggleSeriesLabel()