Histogram class. Inheritance from class Proportional. More...

#include <histogram.hpp>

Inheritance diagram for Histogram:

Public Member Functions
void	setBinCount (const unsigned int binCount)
	Set the bin count for e.g. histogram.

void	setData (const std::vector< double > &data1D)
	Set 1D data.

Public Member Functions inherited from Proportional
void	setWxPlotType (const WXPLOT_TYPE wxPlotType)
	Set the plot type selection.

void	setFontSize (const unsigned int fontSize)
	Set the size of the fonts.

void	setTitle (const wxString &title)
	Set the title of the plot.

void	setXlabel (const wxString &xLabel)
	Set the name of the X-label.

void	setYlabel (const wxString &yLabel)
	Set the name of the Y-label.

void	setTicks (const unsigned int ticks)
	Set the number of ticks at the figure in all axis.

void	gridOn (const bool useGrid)
	Enable grid on the figure.

void	setPlotStartWidth (const wxCoord plotStartWidth)
	Set the left upper corner in X-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setPlotStartHeight (const wxCoord plotStartHeight)
	Set the left upper corner in Y-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setPlotEndWidth (const wxCoord plotEndWidth)
	Set the right upper corner in X-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setPlotEndHeight (const wxCoord plotEndHeight)
	Set the right bottom corner in Y-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setData (const std::vector< std::vector< double > > &data2D)
	Set 2D data.

void	setData (const std::vector< double > &data1D)
	Set 1D data.

void	legendOn (const bool useLegend)
	Activate the legend.

void	setLegend (const std::vector< wxString > &legend, const PLACEMENT legendPosition=PLACEMENT_NORTH_EAST)
	Set the labels and placement for the legend.

void	setYlim (const double minY, const double maxY)
	Set the plot zoom limit in Y-axis.

wxCoord	getPlotStartWidth () const
	Get the recalculated start width X-axis value. This value is recalculated after the figure is drawn.

wxCoord	getPlotEndWidth () const
	Get the recalculated end width X-axis value. This value is recalculated after the figure is drawn.

wxCoord	getPlotStartHeight () const
	Get the recalculated start height Y-axis value. This value is recalculated after the figure is drawn.

wxCoord	getPlotEndHeight () const
	Get the recalculated end height Y-axis value. This value is recalculated after the figure is drawn.

void	drawFigure (wxDC &dc)
	This function will do the following:

void	drawGrid (wxDC &dc)
	This function will draw the grid. Call this function after you have drawn the plot type.

void	drawTicks (wxDC &dc)
	This function will draw the ticks. Call this function after you have drawn the plot type.

void	drawLegend (wxDC &dc)
	This function will draw the legend. Call this function after you have drawn the plot type.

Additional Inherited Members
Protected Attributes inherited from Proportional
wxCoord	plotEndWidth = 0
	Location of right upper corner in X-axis.

wxCoord	plotEndHeight = 0
	Location of right bottom corner in Y-axis.

wxCoord	plotStartWidth = 0
	Location of left upper corner in X-axis.

wxCoord	plotStartHeight = 0
	Location of left upper corner in Y-axis.

double	minX = 0
	Minimum value of data in X-axis.

double	maxX = 0
	Maximum value of data in X-axis.

double	minY = 0
	Minimum value of data in Y-axis.

double	maxY = 0
	Maximum value of data in Y-axis.

unsigned int	fontSize = 0
	The size of the all fonts.

unsigned int	ticks = 0
	The number of ticks at the figure in all axis.

bool	useGrid = false
	Flag for using grid or not.

bool	useLegend = false
	Flag for using legend or not.

wxString	title
	Title of the plot type.

wxString	xLabel
	Label under the plot type.

wxString	yLabel
	Label on the left side of the plot type.

std::vector< wxString >	legend
	Vector of labels for the legend.

PLACEMENT	legendPosition = PLACEMENT_NORTH_WEST
	Location of the legend.

WXPLOT_TYPE	wxPlotType = WXPLOT_TYPE_LINE
	Plot type selection.

Detailed Description

Histogram class. Inheritance from class Proportional.

Member Function Documentation

◆ setBinCount()

void Histogram::setBinCount ( const unsigned int binCount )

Set the bin count for e.g. histogram.

Parameters

binCount Bin count is total columns inside a e.g historam chart.

◆ setData()

void Histogram::setData ( const std::vector< double > & data1D )

Set 1D data.

Parameters

data1D 1D data in form of 1D vector.

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

C:/Users/danie/Documents/GitHub/wxPlot/wxPlot/src/plots/plotfigures/2D/histogram/histogram.hpp
C:/Users/danie/Documents/GitHub/wxPlot/wxPlot/src/plots/plotfigures/2D/histogram/histogram.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ setBinCount()

◆ setData()