tsa::pane_proxy Class Reference

Proxy class for class chart::pane. To be used for setting pane properties. An instance of this class is returned by chart::get_pane(size_t). More...

#include <TSCWrapper.h>

Public Member Functions
	~pane_proxy (void)
	Destructor.
void	background (const color &bg_color)
	Sets the background color to bg_color.
void	dashed_h_lines (bool enable_flag=true)
	Set enable_flag to make horizontal grid lines display in 'dashed' form.
void	dashed_v_lines (bool enable_flag=true)
	Set enable_flag to make vertical grid lines display in 'dashed' form.
void	h_line (double y_value, const color &clr=color::white, size_t weight=1)
	Adds a horizonal line to the pane, at given y_value, with given clr and weight.
void	h_lines (bool enable_flag)
	Set enable_flag to enable or disable horizontal grid lines.
void	header_bg (const color &bg_color)
	Sets the pane header bg_color.
void	height (size_t height_)
	Sets the pane height_.
size_t	height (void) const
	Returns the pane height.
void	line (const tsa::date_time &start_timestamp, double start_y_value, const tsa::date_time &end_timestamp, double end_y_value, const color &clr=color::white, size_t weight=1)
	Adds a 'trend' line to the pane. More...
void	plot_bg (const color &bg_color)
	Sets the plot background color to bg_color.
void	show_header (bool show_flag=true)
	If show_flag is true, the pane will have a header.
void	title (const tsa::string &title)
	Sets the pane title.
std::string	title (void) const
	Returns the pane title.
void	v_lines (bool enable_flag)
	Set enable_flag to enable or disable vertical grid lines.
void	x_axis_legend (bool show_flag)
	If show_flag is true, will show x-axis legend.
void	x_axis_legend (const color &clr)
	Sets the x-axis legend color.
void	y_axis_legend (const color &clr)
	Sets the y-axis legend color.
void	y_max (double max)
	Sets the pane maximum y-value to at least max.
void	y_min (double)
	Sets the pane minimum y-value to at at most min.

Detailed Description

Proxy class for class chart::pane. To be used for setting pane properties. An instance of this class is returned by chart::get_pane(size_t).

Member Function Documentation

void tsa::pane_proxy::line	(	const tsa::date_time &	start_timestamp,
		double	start_y_value,
		const tsa::date_time &	end_timestamp,
		double	end_y_value,
		const color &	clr = color::white,
		size_t	weight = 1
	)

Adds a 'trend' line to the pane.

Parameters

start_timestamp	Timestamp of start of line
start_y_value	Starting y-value (e.g. price).
end_timestamp	Timestamp of end of line.
end_y_value	End y-value (e.g. price).
clr	Line color
weight	Weight / width of line.