scatter 0.1.0
scatter::BarPlot Class Reference

[brief description] More...

#include <BarPlot.hpp>

Inheritance diagram for scatter::BarPlot:
scatter::PlotBase

Classes

class  Options
 [brief description] More...
 

Public Types

typedef std::unique_ptr< BarPlotPtr
 convenience typedef
 

Public Member Functions

 BarPlot (const std::string &label, const std::vector< Point > &points, const Options &options)
 [brief description]
 
 BarPlot (const std::string &label, const std::vector< Point > &points)
 [brief description]
 
 BarPlot (const std::vector< Point > &points, const Options &options)
 constructor
 
virtual ~BarPlot ()
 destructor
 
Legend::Entry getLegendEntry ()
 create LegendEntry
 
void render (Renderer &renderer, const Transform &transform)
 render the BarPlot
 
Optionsoptions ()
 [brief description]
 
double getYmax ()
 [brief description]
 
- Public Member Functions inherited from scatter::PlotBase
 PlotBase (const std::string &label)
 [brief description]
 
virtual ~PlotBase ()=default
 [brief description]
 
void setLabel (const std::string &label)
 [brief description]
 
void setColour (const Colour &colour)
 [brief description]
 
const std::string & getLabel () const
 [brief description]
 
const ColourgetColour () const
 [brief description]
 

Detailed Description

[brief description]

[long description]

Constructor & Destructor Documentation

◆ BarPlot() [1/3]

scatter::BarPlot::BarPlot ( const std::string & label,
const std::vector< Point > & points,
const Options & options )

[brief description]

[long description]

Parameters
label[description]
points[description]
options[description]

◆ BarPlot() [2/3]

scatter::BarPlot::BarPlot ( const std::string & label,
const std::vector< Point > & points )

[brief description]

[long description]

Parameters
label[description]
points[description]

◆ BarPlot() [3/3]

scatter::BarPlot::BarPlot ( const std::vector< Point > & points,
const Options & options )

constructor

[long description]

Parameters
pointsarray of Point
optionsOptions

◆ ~BarPlot()

virtual scatter::BarPlot::~BarPlot ( )
virtual

destructor

[long description]

Member Function Documentation

◆ getLegendEntry()

Legend::Entry scatter::BarPlot::getLegendEntry ( )
virtual

create LegendEntry

defines symbol, label, colour

Returns
LegendEntry

Implements scatter::PlotBase.

◆ getYmax()

double scatter::BarPlot::getYmax ( )
virtual

[brief description]

[long description]

Returns
[description]

Reimplemented from scatter::PlotBase.

◆ options()

Options * scatter::BarPlot::options ( )

[brief description]

[long description]

Returns
[description]

◆ render()

void scatter::BarPlot::render ( Renderer & renderer,
const Transform & transform )
virtual

render the BarPlot

[long description]

Parameters
rendererRenderer (base class)
transformTransform

Implements scatter::PlotBase.


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