Models the title of a chart. More...

#include <shark/Core/Chart.h>

Collaboration diagram for shark::Chart::Title:

Public Member Functions
	Title ()
	Default c'tor. More...

boost::property_tree::ptree &	properties ()
	Accesses the properties of the title. More...

const boost::property_tree::ptree &	properties () const
	Accesses the properties of the title. More...

template<typename Archive >
void	serialize (Archive &a, const unsigned int version)
	(De-)Serializes the title, its attributes and properties. More...

Public Attributes
std::string	m_text
	The title text of the chart. More...

HorizontalAlignment	m_horizontalAlignment
	The horizontal alignment of the title text, default value: CENTER. More...

VerticalAlignment	m_verticalAlignment
	The vertical alignment of the title text, default value: MIDDLE. More...

boost::property_tree::ptree	m_properties
	Renderer specific properties of the title, modelled as kez/value pairs. More...

Detailed Description

Models the title of a chart.

Definition at line 190 of file Chart.h.

Constructor & Destructor Documentation

shark::Chart::Title::Title ( )

inline

Default c'tor.

Definition at line 200 of file Chart.h.

Member Function Documentation

boost::property_tree::ptree& shark::Chart::Title::properties ( )

inline

Accesses the properties of the title.

In addition to the attributes that are explicitly modelled arbitrary key/value pairs can be associated with the axis. These key/value-pairs might be used by renderers to further customize the output.

Returns: A mutable reference to the properties, allows for l-value semantics.

Definition at line 213 of file Chart.h.

References m_properties.

const boost::property_tree::ptree& shark::Chart::Title::properties ( ) const

inline

Accesses the properties of the title.

In addition to the attributes that are explicitly modelled arbitrary key/value pairs can be associated with the axis. These key/value-pairs might be used by renderers to further customize the output.

Returns: An immutable reference to the properties.

Definition at line 227 of file Chart.h.

References m_properties.

template<typename Archive >

void shark::Chart::Title::serialize	(	Archive &	a,
		const unsigned int	version
	)

inline

(De-)Serializes the title, its attributes and properties.

Template Parameters

Archive The type of the archive.

Parameters

[in,out]	a	The archive to read from/write to.
[in]	version	Currently unused.

Definition at line 239 of file Chart.h.

References m_horizontalAlignment, m_properties, m_text, and m_verticalAlignment.

Member Data Documentation

HorizontalAlignment shark::Chart::Title::m_horizontalAlignment

The horizontal alignment of the title text, default value: CENTER.

Definition at line 192 of file Chart.h.

Referenced by serialize().

boost::property_tree::ptree shark::Chart::Title::m_properties

Renderer specific properties of the title, modelled as kez/value pairs.

Definition at line 195 of file Chart.h.

Referenced by properties(), and serialize().

std::string shark::Chart::Title::m_text

The title text of the chart.

Definition at line 191 of file Chart.h.

Referenced by shark::HighchartRenderer< Stream >::render(), and serialize().

VerticalAlignment shark::Chart::Title::m_verticalAlignment

The vertical alignment of the title text, default value: MIDDLE.

Definition at line 193 of file Chart.h.

Referenced by serialize().

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

include/shark/Core/Chart.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation