scatter::Legend Class Reference

[brief description] More...

#include <Legend.hpp>

Classes
struct	Entry
	[brief description] More...

Public Types
enum class	Symbol { LINE , BAR , ARROW , ELLIPSE }
	[brief description] More...

Public Member Functions
	Legend (const LegendOptions *const options, const TextOptions *const text_options)
	constructor
virtual	~Legend ()
	destructor
void	add (const Entry &entry)
	add an entry to the Legend
void	render (Renderer &renderer, const Transform &transform)
	render the Legend using the given Renderer

Protected Attributes
const LegendOptions *const	options_
	pointer to LegendOptions (coming from Plot)
const TextOptions *const	text_options_
	pointer to TextOptions (coming from Plot)

Detailed Description

[brief description]

private class, not meant to be used by the user

Member Enumeration Documentation

Symbol

enum class scatter::Legend::Symbol

strong

[brief description]

[long description]

Constructor & Destructor Documentation

Legend()

scatter::Legend::Legend	(	const LegendOptions *const	options,
		const TextOptions *const	text_options )

constructor

this class is instantiated within Plot

Parameters

options	pointer to LegendOptions (coming from Plot)
text_options	pointer to TextOptions (coming from Plot)

~Legend()

virtual scatter::Legend::~Legend ( )

virtual

destructor

[long description]

Member Function Documentation

add()

void scatter::Legend::add

(

const Entry &

entry

)

add an entry to the Legend

[long description]

Parameters

entry

Entry (created by a class inheriting from PlotBase)

render()

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

render the Legend using the given Renderer

[long description]

Parameters

renderer	Renderer (base class)
transform	Transform to convert from data to canvas coordinates

---

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

• Legend.hpp