Class to plot graphs of time series values and/or regions. More...

#include <creativity/data/graph/Series.hpp>

Public Types
enum	LegendPosition { LegendPosition::None, LegendPosition::Inside, LegendPosition::Right, LegendPosition::Left, LegendPosition::Top, LegendPosition::Bottom }
	The possible general positions of the legend. More...

enum	TickEnds { TickEnds::Add, TickEnds::Replace, TickEnds::None }
	Different modes for what to do with the tmin/tmax/ymin/ymax graph end points given during construction. More...

using	LegendPainterCallback_t = std::function< void(Cairo::RefPtr< Cairo::Context >, const Cairo::Matrix &)>
	Alias for the function callback for custom legend support.

Public Member Functions
	Series ()=delete
	No default constructor.

	Series (Target &target, int tmin, int tmax, double ymin, double ymax, std::string title="", std::string x_label="", std::string y_label="")
	Constructs a new series plot that plots to the given Cairo context. More...

virtual	~Series ()
	Destructor; calls finishPage()

void	finishPage ()
	Writes everything added to the graph to the current page. More...

void	newPage ()
	Writes the current graph to disk by calling finishPage(), if necessary, and begins a new graph. More...

void	addLine (const std::map< int, double > &points, const LineStyle &style=default_line_style)
	Plots the pairs of coordinates in the given map to the plot. More...

void	addRegion (const std::map< int, std::pair< double, double >> &intervals, const FillStyle &style=default_region_style)
	Takes a map of time value to double pairs and plots the region between the pair values. More...

void	addLegendItem (std::string markup, const FillStyle &lower, bool preserve=true, const RectangleStyle &style=default_legend_box_style)
	Adds a simple legend item. More...

void	addLegendItem (std::string name, const LegendPainterCallback_t &legend_painter, bool preserve=true)
	Adds a legend item with custom box drawing. More...

void	addLegendItem (std::string name, LegendPainterCallback_t &&legend_painter, bool preserve=true)
	Same as above, but takes an rvalue callback object.

void	recalcTicks (unsigned xmax=10, unsigned ymax=8, TickEnds end_mode=TickEnds::None)
	Calculates where tick marks and grid lines should go. More...

void	recalcTicksT (unsigned max=10, TickEnds end_mode=TickEnds::None)
	Recalculates just the t tick marks and grid lines on the graph, leaving y ticks unchanged. More...

void	recalcTicksY (unsigned max=8, TickEnds end_mode=TickEnds::None)
	Recalculates just the y tick marks and grid lines on the graph, leaving t ticks unchanged. More...

void	setExtents (int tmin, int tmax, double ymin, double ymax, bool retick=true)
	Updates the t and y graph extents. More...

void	updateFonts (const Pango::FontDescription &new_font)
	Changes the font description of all fonts in the graph to any values set in the given font description. More...

void	updateFontFamily (const std::string &new_font_family)
	Updates the font family of all fonts used in the graph, without changing the other attributes (such as size or font weight). More...

Static Public Member Functions
static void	drawRectangle (Cairo::RefPtr< Cairo::Context > ctx, double width, double height, const RectangleStyle &style, bool clip=false)
	Draws a rectangle border, fill the rectangle interior, and (optionally) clip to the rectangle interior. More...

Public Attributes
RGBA	background_colour {White}
	The background colour of the page.

LineStyle	tick_style {Black, 0.5, 3}
	The line style (including length) of tick marks. More...

double	tick_label_space {2.0}
	The space between the tick line and the corresponding tick value text. More...

LineStyle	tick_grid_style {Transparent, 0.5}
	The line style to draw for ticks grid lines on the graph itself (not the tick marks themselves, which show up outside the graph area). More...

LineStyle	tick_grid_extra_style {RGBA{0.75}, 0.5}
	The line style to use for extra grid lines (those set manually into `t_grid_extra` and `y_grid_extra`. More...

RGBA	tick_font_colour {Black}
	The font colour for tick values. More...

Pango::FontDescription	tick_font {"serif 6"}
	The font for tick values.

RectangleStyle	graph_style {White, LineStyle(Black, 1)}
	The graph area background and border. More...

LegendPosition	legend_position {LegendPosition::Right}
	The general position of the legend. More...

double	legend_rel_x {0.5}
	The relative x location of the legend. More...

double	legend_rel_y {0.5}
	The relative y location of the legend. More...

double	legend_graph_space {5.0}
	The size of the gap between the legend box and the graph box. More...

double	legend_box_width {15.0}
	The width of the legend image box, in surface units.

double	legend_box_height {15.0}
	The height of the legend box, in surface units.

double	legend_box_text_gap {5.0}
	The gap between the legend box and legend text region, in surface units.

RectangleStyle	legend_style {White, Black}
	The style for a box encompassing the entire legend area. More...

double	legend_text_max_width {60.0}
	The maximum width of legend text, in surface units. More...

double	legend_text_max_height {40.0}
	The maximum height of the box that legend text may occupy (beyond which text is ellipsized), in surface units. More...

double	legend_spacing {3.0}
	The vertical space to put between legend items.

Pango::FontDescription	legend_font {"Latin Modern, DejaVu Serif, serif oblique 6"}
	The font to use for legend text. More...

std::string	title
	The graph title text, which may contain pango markup. More...

Pango::FontDescription	title_font {"Latin Modern, DejaVu Serif, serif bold 12"}
	The font to use for the title.

std::string	x_label
	The x axis label, which may contain pango markup. More...

std::string	y_label
	The y axis label, which may contain pango markup. More...

bool	y_label_rotated = true
	If true (the default) the y label is rotated 90 degrees; if false, the text is drawn horizontally.

Pango::FontDescription	axis_label_font {"Latin Modern, DejaVu Serif, serif oblique 8"}
	The font for the axis labels.

double	title_padding {2.0}
	The space between the bottom of the title and the top of the graph, in surface units. More...

double	axis_label_padding {2.0}
	The space between the axis labels and the axis tick values (or ticks or graph border, depending on what is displayed).

double	stray_thickness {1.0}
	The thickness of the region drawn for "stray" region observations, that is, observations that are neither preceeded nor followed by another finite region observation.

std::set< int >	t_ticks
	X-axis (t) tick mark locations, calculated during construction. More...

std::set< double >	y_ticks
	Y-axis tick mark locations, calculated during construction. More...

bool	y_axis_left = true
	If true (the default), draw ticks and the y-axis label on the left-hand side of the graph; if false, draws them on the right-hand side.

std::set< int >	t_grid
	X-axis (t) grid mark locations, calculated during construction. More...

std::set< int >	t_grid_extra
	Extra x-axis grid marks to draw. More...

std::set< double >	y_grid
	Y-axis grid mark locations, calculated during construction. More...

std::set< double >	y_grid_extra
	Like t_grid_extra, but for y axis values. More...


double	graph_padding_left {0.0}

double	graph_padding_right {0.0}

double	graph_padding_top {2.0}

double	graph_padding_bottom {2.0}


double	margin_top {5.0}

double	margin_right {5.0}

double	margin_bottom {5.0}

double	margin_left {5.0}


double	legend_padding_left {3.0}

double	legend_padding_right {3.0}

double	legend_padding_top {3.0}

double	legend_padding_bottom {3.0}

Static Public Attributes
static const LineStyle	default_line_style
	The default line style for addLine(): a 1-unit wide, solid black line.

static const FillStyle	default_region_style
	The default fill style for a region added with addRegion(): a 1/4 opacity solid blue background, with no border.

static const RectangleStyle	default_legend_box_style
	The default legend box background and/or border style: white background with a 0.5-unit wide, solid black border.

Static Protected Member Functions
static void	boundRegion (Cairo::RefPtr< Cairo::Context > ctx, std::map< int, std::pair< double, double >>::const_iterator first, std::map< int, std::pair< double, double >>::const_iterator last, std::map< int, std::pair< double, double >> &strays)
	Helper method called by addRegion: takes an iterator to the first and final elements of a contiguous set, draws a region empassing the min/max values, and closes it so that a subsequent fill will fill it in. More...

Detailed Description

Class to plot graphs of time series values and/or regions.

Member Enumeration Documentation

§ LegendPosition

enum creativity::data::graph::Series::LegendPosition

strong

The possible general positions of the legend.

This value, combined with the legend_rel_x and legend_rel_y variables, determines the legend position.

See also: legend_rel_x; legend_rel_y

Enumerator
None	The legend is suppressed entirely.
Inside	The legend is placed inside the graph.
Right	The legend goes to the right of the graph.
Left	The legend goes to the left of the graph.
Top	The legend goes above the graph.
Bottom	The legend goes below the graph.

§ TickEnds

enum creativity::data::graph::Series::TickEnds

strong

Different modes for what to do with the tmin/tmax/ymin/ymax graph end points given during construction.

Enumerator

Add

If an end point isn't equal to or very close to a calculated tick mark, add it.

This can result in up to two more than the requested maximum number of ticks. Very close is considered to be within one-quarter of a tick from the first or last calculated tick.

For example, if the end points result in calculated tick marks are 5 10 15 20 25 30 35, with TickEnds::Add an extra tick would be added to the beginning for a minimum value in (0, 3.75], and would be added to the end for a maximum value in [36.25, 40); ticks are not added for end points within 1.25 (1/4 of a tick) of the calculated minimum/maximum ticks.

Replace

The first and last calculated tick marks are removed and replaced with the min/max graph axis values.

None

Don't do anything with tick end values. Value range ends will only show up if the ends happen to coincide with multiple of the tick increments.

Constructor & Destructor Documentation

§ Series()

creativity::data::graph::Series::Series	(	Target &	target,
		int	tmin,
		int	tmax,
		double	ymin,
		double	ymax,
		std::string	title = `""`,
		std::string	x_label = `""`,
		std::string	y_label = `""`
	)

Constructs a new series plot that plots to the given Cairo context.

Parameters

target	the Target object to which the graph should be drawn
tmin	the left-hand-side t value
tmax	the right-hand-side t value
ymin	the minimum y value at the bottom of the plot region
ymax	the maximum y value at the top of the plot region
title	the title of the graph (which may contain pango markup)
x_label	the x axis label (which may contain pango markup)
y_label	the y axis label (which may contain pango markup)

Member Function Documentation

§ addLegendItem() [1/2]

void creativity::data::graph::Series::addLegendItem	(	std::string	markup,
		const FillStyle &	lower,
		bool	preserve = `true`,
		const RectangleStyle &	style = `default_legend_box_style`
	)

Adds a simple legend item.

The legend box has two main drawing components; each can be transparent to suppress the element. If the page has not yet been initialized and the preserve value is true, the legend item will not be drawn immediately but rather will wait until the current page is initialized. Otherwise, the legend item will be drawn immediately, initializing the page first if required.

Parameters

markup	the text (with pango markup) to display for the legend item
lower	fill style for the bottom half of the box. The border component of the fill style is drawn across the middle of the box. To specify just a line across the middle, simple provide a LineStyle for this argument (the implicit conversion results in a transparent fill and the given line style).
preserve	whether this legend item should be automatically added to new pages when newPage() is called.
style	the fill and border style for the legend box. Defaults to a transparent background with a 1-unit-wide black border. Note that the background fill is always contained entirely within the border, even if the border is transparent.

The background fill and border is drawn first, followed by the lower area.

§ addLegendItem() [2/2]

void creativity::data::graph::Series::addLegendItem	(	std::string	name,
		const LegendPainterCallback_t &	legend_painter,
		bool	preserve = `true`
	)

Adds a legend item with custom box drawing.

The custom callback function is called with a Cairo::Context object to allow the caller to draw the box as desired. If the current page is uninitialized and preserve is true, the legend item drawing will be delayed until page initialization; otherwise the legend item is drawn immediately, initializing the page if required.

The legend_painter callback is called with the Cairo::Context object with an applied clip region that allows drawing only in the legend box and legend text spaces. Two matrices are also supplied: one that translated [0,1]x[0,1] coordinates into the region where the legend box should be drawn, and the other that translates [0,1]x[0,1] coordinates into the legend text rectangular area. Note that (0,0) and (1,1) correspond to the upper-left and lower-right corners of the respective regions (so larger y values are down the page, in the usual graphical toolkit drawing convention).

Parameters

name	the legend name
legend_painter	a callable function object that receives a Cairo::Context to draw to and a Cairo::Matrix object mapping [0,1]x[0,1] coordinates into the (clipped) legend box.
preserve	if true (the default), this legend item will be automatically re-added to the graph whenever newPage() is called to start a new graph. If false, the legend item is only added to the current page.

§ addLine()

void creativity::data::graph::Series::addLine	(	const std::map< int, double > &	points,
		const LineStyle &	style = `default_line_style`
	)

Plots the pairs of coordinates in the given map to the plot.

Keys should be the t values. If any sequential t values are missing or have non-finite values, the line will be broken around the missing values.

Parameters

points	the map of time to value coordinates to plot
style	the LineStyle; defaults to a 1-unit-wide black line.

§ addRegion()

void creativity::data::graph::Series::addRegion	(	const std::map< int, std::pair< double, double >> &	intervals,
		const FillStyle &	style = `default_region_style`
	)

Takes a map of time value to double pairs and plots the region between the pair values.

If any t values are missing or have one or more non-finite pair values, the region is broken at that t value.

Parameters

intervals	the map of time to region boundaries. The order of the pair values does not matter.
style	FillStyle the fill style of the region. The border of the fill style will be used only for the top and bottom border of the region (i.e. the sides will have no border). Defaults to a 1/3 opacity blue fill with no (i.e. fully transparent) border.

§ boundRegion()

static void creativity::data::graph::Series::boundRegion	(	Cairo::RefPtr< Cairo::Context >	ctx,
		std::map< int, std::pair< double, double >>::const_iterator	first,
		std::map< int, std::pair< double, double >>::const_iterator	last,
		std::map< int, std::pair< double, double >> &	strays
	)

staticprotected

Helper method called by addRegion: takes an iterator to the first and final elements of a contiguous set, draws a region empassing the min/max values, and closes it so that a subsequent fill will fill it in.

If the region consists of only a single point (that is, first == last), the point is copied into strays to be later drawn as vertical lines by addRegion().

Parameters

ctx	the Cairo::Context, which should have a transformation applied so that data points correspond to the graph region.
first	the iterator to the first element in the group
last	the iterator to the last element in the group (NOT the past-the-end iterator)
strays	a map to store a "stray" (that is, single-time-period) observation in (only when first == last).

§ drawRectangle()

static void creativity::data::graph::Series::drawRectangle	(	Cairo::RefPtr< Cairo::Context >	ctx,
		double	width,
		double	height,
		const RectangleStyle &	style,
		bool	clip = `false`
	)

static

Draws a rectangle border, fill the rectangle interior, and (optionally) clip to the rectangle interior.

Parameters

ctx	a Cairo::Context positioned at the top-left corner of the desired rectangle
width	the desired width (including the border) of the rectangle
height	the desired height (including the border) of the rectangle
style	a RectangleStyle from which to read the border style and background fill colour
clip	if true, clip the context to the interior of the rectangle before returning

§ finishPage()

void creativity::data::graph::Series::finishPage ( )

Writes everything added to the graph to the current page.

Once this method is called, no more graph elements may be added until newPage() is called to begin a new graph.

This method is called implicitly by newPage() and by the destructor; as such it is rarely required to call it directly.

§ newPage()

void creativity::data::graph::Series::newPage ( )

Writes the current graph to disk by calling finishPage(), if necessary, and begins a new graph.

If a multi-page surface format, this will be a new page in the output file; otherwise it will be a new file.

§ recalcTicks()

void creativity::data::graph::Series::recalcTicks	(	unsigned	xmax = `10`,
		unsigned	ymax = `8`,
		TickEnds	end_mode = `TickEnds::None`
	)

Calculates where tick marks and grid lines should go.

This will be applied the next time the graph is drawn, and so has to be called before adding any graph elements to have an effect on the current page.

This method simply calls recalcTicksT() and recalcTicksY().

Parameters

xmax	the maximum number of tick marks on the x axis. Defaults to 10
ymax	the maximum number of tick marks on the y axis. Defaults to 8
end_mode	what to do with the ends (i.e. tmin, tmax, ymin, ymax given during construction). The default is TickEnds::None. Grid lines are not affected by this option.

§ recalcTicksT()

void creativity::data::graph::Series::recalcTicksT	(	unsigned	max = `10`,
		TickEnds	end_mode = `TickEnds::None`
	)

Recalculates just the t tick marks and grid lines on the graph, leaving y ticks unchanged.

The tick marks are calculated to have a round increment which is the smallest of 1, 2, 4, 5, 10, 20, 25, 40, 50, 100, 200, 250, 400, 500, ... such that no more than max ticks are needed to cover the range of t data.

Parameters

max	the maximum number of tick marks on the t/x axis. Defaults to 10.
end_mode	what to do with the ends (i.e. tmin, tmax) for tick marks. The default is TickEnds::None. Grid lines are not affected by this option.

§ recalcTicksY()

void creativity::data::graph::Series::recalcTicksY	(	unsigned	max = `8`,
		TickEnds	end_mode = `TickEnds::None`
	)

Recalculates just the y tick marks and grid lines on the graph, leaving t ticks unchanged.

The space between tick marks is calculated to be smallest value of (1, 2, 2.5, 4, 5) times a power of ten that results in no more than max ticks to cover the span of the data given during construction.

Parameters

max	the maximum number of tick marks on the y axis. Defaults to 8.
end_mode	what to do with the ends (i.e. ymin, ymax). The default is TickEnds::None. Grid lines are not affected by this option.

§ setExtents()

void creativity::data::graph::Series::setExtents	(	int	tmin,
		int	tmax,
		double	ymin,
		double	ymax,
		bool	retick = `true`
	)

Updates the t and y graph extents.

This must be called before the current page is initialized–that is, either after construction, or after a newPage() call before any items have been added to the graph.

Parameters

tmin	the new minimum t value
tmax	the new maximum t value
ymin	the new minimum y value
ymax	the new maximum y value
retick	if true or omitted, call recalcTicks() after updating the extents (with its default arguments). Set to false if using custom tick calculations.

Exceptions

std::logic_error	if called after the current page has been initialized
std::invalid_argument	if called with invalid extents (tmin not less than tmax, or ymin not less than ymax).

§ updateFontFamily()

void creativity::data::graph::Series::updateFontFamily ( const std::string & new_font_family )

Updates the font family of all fonts used in the graph, without changing the other attributes (such as size or font weight).

The font family may optionally be a comma-separated list of multiple font families.

§ updateFonts()

void creativity::data::graph::Series::updateFonts ( const Pango::FontDescription & new_font )

Changes the font description of all fonts in the graph to any values set in the given font description.

Values that have not been explicitly set in the given FontDescription are not copied. For example, if the FontDescription specifies a font family but no font size, only the font family will be updated but sizes will be preserved.

Parameters

new_font the font description to apply to the graph's fonts.

Member Data Documentation

§ graph_padding_bottom

double creativity::data::graph::Series::graph_padding_bottom {2.0}

The graph padding inside the border, in surface units.

§ graph_padding_left

double creativity::data::graph::Series::graph_padding_left {0.0}

The graph padding inside the border, in surface units.

§ graph_padding_right

double creativity::data::graph::Series::graph_padding_right {0.0}

The graph padding inside the border, in surface units.

§ graph_padding_top

double creativity::data::graph::Series::graph_padding_top {2.0}

The graph padding inside the border, in surface units.

§ graph_style

RectangleStyle creativity::data::graph::Series::graph_style {White, LineStyle(Black, 1)}

The graph area background and border.

Note that even if the border is transparent, the width is still taken into account when determining the graph area.

§ legend_font

Pango::FontDescription creativity::data::graph::Series::legend_font {"Latin Modern, DejaVu Serif, serif oblique 6"}

The font to use for legend text.

§ legend_graph_space

double creativity::data::graph::Series::legend_graph_space {5.0}

The size of the gap between the legend box and the graph box.

If 0, graph and legend borders will be adjacent; if negative, the legend will overlap the graph border (and so specifying the graph/legend border size here results in a border-collapse result).

See also: legend_position; legend_rel_x; legend_rel_y

§ legend_padding_bottom

double creativity::data::graph::Series::legend_padding_bottom {3.0}

The legend box area padding inside the border, in surface units.

§ legend_padding_left

double creativity::data::graph::Series::legend_padding_left {3.0}

The legend box area padding inside the border, in surface units.

§ legend_padding_right

double creativity::data::graph::Series::legend_padding_right {3.0}

The legend box area padding inside the border, in surface units.

§ legend_padding_top

double creativity::data::graph::Series::legend_padding_top {3.0}

The legend box area padding inside the border, in surface units.

§ legend_position

LegendPosition creativity::data::graph::Series::legend_position {LegendPosition::Right}

The general position of the legend.

See also: legend_rel_x; legend_rel_y

§ legend_rel_x

double creativity::data::graph::Series::legend_rel_x {0.5}

The relative x location of the legend.

The specific meaning depends on the value of legend_position:

LegendPosition::Inside - 0 corresponds to the left edge of legend box being exactly legend_graph_space units away from the inside edge of the left graph border, and 1 corresponds to the right edge of the legend box being exactly legend_graph_space units away from the inside edge of the right graph border.
LegendPosition::Top, LegendPosition::Bottom - 0 corresponds to the left outer edge of the legend box lining up with the outer left edge of the graph box, and 1 corresponds to the right outer edge lining up with the right outer edge of the graph box.
LegendPosition::Right, LegendPosition::Left, LegendPosition::None - this value is not used.

The default value is 0.5 (middle horizontal alignment)–but note that the value is not used with the default legend_position value.

§ legend_rel_y

double creativity::data::graph::Series::legend_rel_y {0.5}

The relative y location of the legend.

The specific meaning depends on the value of legend_position:

LegendPosition::Inside - 0 corresponds to the top edge of legend box being exactly legend_graph_space units away from the inside edge of the top graph border, and 1 corresponds to the bottom edge of the legend box being exactly legend_graph_space units away from the inside edge of the bottom graph border.
LegendPosition::Right, LegendPosition::Left - 0 corresponds to the top outer edge of the legend box lining up with the top outer edge of the graph box, and 1 corresponds to the bottom outer edge lining up with the bottom outer edge of the graph box.
LegendPosition::Top, LegendPosition::Bottom, LegendPosition::None - this value is not used.

The default value is 0.5 (midle vertical alignment).

§ legend_style

RectangleStyle creativity::data::graph::Series::legend_style {White, Black}

The style for a box encompassing the entire legend area.

Default is a white background and 1-unit wide black border.

§ legend_text_max_height

double creativity::data::graph::Series::legend_text_max_height {40.0}

The maximum height of the box that legend text may occupy (beyond which text is ellipsized), in surface units.

The text will be aligned with the middle of the legend box, and the total legend item height will be the larger of the legend box or text region. Note that a legend will always contain at least one line of text, and so it is possible for a legend item to exceed this size if this is set smaller than the required height for a line of text.

§ legend_text_max_width

double creativity::data::graph::Series::legend_text_max_width {60.0}

The maximum width of legend text, in surface units.

The actual width can be less than this, depending on the size of the text and taking into account any wrapping. If text is too wide (for example, one unwrappable line exceeds this value) it will be cut off; if the text is too long overall, it will be ellipsized.

§ margin_bottom

double creativity::data::graph::Series::margin_bottom {5.0}

The minimum margin between components of the page and the edge of the page on each side.

§ margin_left

double creativity::data::graph::Series::margin_left {5.0}

The minimum margin between components of the page and the edge of the page on each side.

§ margin_right

double creativity::data::graph::Series::margin_right {5.0}

The minimum margin between components of the page and the edge of the page on each side.

§ margin_top

double creativity::data::graph::Series::margin_top {5.0}

The minimum margin between components of the page and the edge of the page on each side.

§ t_grid

std::set<int> creativity::data::graph::Series::t_grid

X-axis (t) grid mark locations, calculated during construction.

Can be recalculated by calling recalcTicks(). If cleared, no vertical grid lines are drawn.

This will, by default, be equal to t_ticks if recalcTicks() is called with TickEnds::Add; for the other end modes, the grid end points can differ.

§ t_grid_extra

std::set<int> creativity::data::graph::Series::t_grid_extra

Extra x-axis grid marks to draw.

This can be used to mark special values in addition to (and styled differently) than the regular t_grid lines.

The defaults to empty.

§ t_ticks

std::set<int> creativity::data::graph::Series::t_ticks

X-axis (t) tick mark locations, calculated during construction.

Can be recalculated by calling recalcTicks(). If cleared, no horizontal axis ticks are displayed.

§ tick_font_colour

RGBA creativity::data::graph::Series::tick_font_colour {Black}

The font colour for tick values.

If completely transparent, tick values are not drawn.

§ tick_grid_extra_style

LineStyle creativity::data::graph::Series::tick_grid_extra_style {RGBA{0.75}, 0.5}

The line style to use for extra grid lines (those set manually into t_grid_extra and y_grid_extra.

Defaults to a medium gray line of width 0.5.

§ tick_grid_style

LineStyle creativity::data::graph::Series::tick_grid_style {Transparent, 0.5}

The line style to draw for ticks grid lines on the graph itself (not the tick marks themselves, which show up outside the graph area).

Defaults to transparent (i.e. no grid lines).

§ tick_label_space

double creativity::data::graph::Series::tick_label_space {2.0}

The space between the tick line and the corresponding tick value text.

Only applies when both are visible (i.e. non-zero tick_style width and length, and non-transparent tick_font_colour).

§ tick_style

LineStyle creativity::data::graph::Series::tick_style {Black, 0.5, 3}

The line style (including length) of tick marks.

Defaults to a black, 0.5-width, 3-length line. The length parameter of the style controls the length of tick marks; if 0, tick marks are suppressed.

§ title

std::string creativity::data::graph::Series::title

The graph title text, which may contain pango markup.

Will be drawn in opaque black, but markup in the string can be used to change this.

§ title_padding

double creativity::data::graph::Series::title_padding {2.0}

The space between the bottom of the title and the top of the graph, in surface units.

Only applies when title is not an empty string. To adjust the space between the title and the top of the page, adjust margin_top.

§ x_label

std::string creativity::data::graph::Series::x_label

The x axis label, which may contain pango markup.

Will be drawn in opaque black, but markup in the string can be used to change this.

§ y_grid

std::set<double> creativity::data::graph::Series::y_grid

Y-axis grid mark locations, calculated during construction.

Can be recalculated by calling recalcTicks(). If cleared, no horizontal grid lines are drawn.

This will, by default, be equal to y_ticks if recalcTicks() is called with TickEnds::None; for the other end modes, the grid end points can differ.

§ y_grid_extra

std::set<double> creativity::data::graph::Series::y_grid_extra

Like t_grid_extra, but for y axis values.

§ y_label

std::string creativity::data::graph::Series::y_label

The y axis label, which may contain pango markup.

Will be drawn in opaque black, but markup in the string can be used to change this.

§ y_ticks

std::set<double> creativity::data::graph::Series::y_ticks

Y-axis tick mark locations, calculated during construction.

Can be recalculated by calling recalcTicks(). If cleared, no vertical axis ticks are displayed. The tick marks are displayed on the left-hand-side of the graph.

Collaboration diagram for creativity::data::graph::Series:

[legend]

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

creativity/data/graph/Series.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Member Functions

Detailed Description

Member Enumeration Documentation

§ LegendPosition

§ TickEnds

Constructor & Destructor Documentation

§ Series()

Member Function Documentation

§ addLegendItem() [1/2]

§ addLegendItem() [2/2]

§ addLine()

§ addRegion()

§ boundRegion()

§ drawRectangle()

§ finishPage()

§ newPage()

§ recalcTicks()

§ recalcTicksT()

§ recalcTicksY()

§ setExtents()

§ updateFontFamily()

§ updateFonts()

Member Data Documentation

§ graph_padding_bottom

§ graph_padding_left

§ graph_padding_right

§ graph_padding_top

§ graph_style

§ legend_font

§ legend_graph_space

§ legend_padding_bottom

§ legend_padding_left

§ legend_padding_right

§ legend_padding_top

§ legend_position

§ legend_rel_x

§ legend_rel_y

§ legend_style

§ legend_text_max_height

§ legend_text_max_width

§ margin_bottom

§ margin_left

§ margin_right

§ margin_top

§ t_grid

§ t_grid_extra

§ t_ticks

§ tick_font_colour

§ tick_grid_extra_style

§ tick_grid_style

§ tick_label_space

§ tick_style

§ title

§ title_padding

§ x_label

§ y_grid

§ y_grid_extra

§ y_label

§ y_ticks