openpine::graph::Hline Class Reference

Represents a horizontal-line (hline) graph. More...

#include <hline.hpp>

Public Member Functions
	Hline (const ffi::Hline *p)
double	value () const
	Gets the Y-axis value of the horizontal line.
std::optional< uint32_t >	color () const
	Gets the optional line color.
std::optional< std::string_view >	title () const
	Gets the optional title/label.
HlineStyle	lineStyle () const
	Gets the stroke style.
int32_t	lineWidth () const
	Gets the stroke width.
bool	editable () const
	Gets whether the line is user-editable.
Display	display () const
	Gets the display mask for the hline.

Detailed Description

Represents a horizontal-line (hline) graph.

Definition at line 28 of file hline.hpp.

Constructor & Destructor Documentation

Hline()

openpine::graph::Hline::Hline ( const ffi::Hline * p )

inline

Definition at line 33 of file hline.hpp.

Member Function Documentation

color()

std::optional< uint32_t > openpine::graph::Hline::color ( ) const

inline

Gets the optional line color.

Definition at line 43 of file hline.hpp.

display()

Display openpine::graph::Hline::display ( ) const

inline

Gets the display mask for the hline.

Definition at line 82 of file hline.hpp.

editable()

bool openpine::graph::Hline::editable ( ) const

inline

Gets whether the line is user-editable.

Definition at line 77 of file hline.hpp.

lineStyle()

HlineStyle openpine::graph::Hline::lineStyle ( ) const

inline

Gets the stroke style.

Definition at line 67 of file hline.hpp.

lineWidth()

int32_t openpine::graph::Hline::lineWidth ( ) const

inline

Gets the stroke width.

Definition at line 72 of file hline.hpp.

title()

std::optional< std::string_view > openpine::graph::Hline::title ( ) const

inline

Gets the optional title/label.

Definition at line 55 of file hline.hpp.

References openpine::detail::refToView().

value()

double openpine::graph::Hline::value ( ) const

inline

Gets the Y-axis value of the horizontal line.

Definition at line 38 of file hline.hpp.

---

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

• cpp/include/visuals/hline.hpp