openpine::graph::Label Class Reference

Represents a label graph. More...

#include <label.hpp>

Public Member Functions
	Label (const ffi::Label *p)
int64_t	x () const
	Gets the label X position.
double	y () const
	Gets the label Y position.
std::string_view	text () const
	Gets the label text.
XLocation	xloc () const
	Gets the X-axis coordinate system used by x().
YLocation	yloc () const
	Gets the Y-axis coordinate system used by y().
std::optional< uint32_t >	color () const
	Gets the optional label background color.
LabelStyle	style () const
	Gets the label shape/style.
std::optional< uint32_t >	textColor () const
	Gets the optional label text color.
uint32_t	size () const
	Gets the label text size.
HorizontalAlign	textAlign () const
	Gets the horizontal text alignment.
std::optional< std::string_view >	tooltip () const
	Gets the optional tooltip.
FontFamily	textFontFamily () const
	Gets the font family.
TextFormatting	textFormatting () const
	Gets the text formatting (bold/italic).
bool	forceOverlay () const
	Gets whether the label is forced to render as overlay.

Detailed Description

Represents a label graph.

Definition at line 27 of file label.hpp.

Constructor & Destructor Documentation

Label()

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

inline

Definition at line 32 of file label.hpp.

Member Function Documentation

color()

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

inline

Gets the optional label background color.

Definition at line 66 of file label.hpp.

forceOverlay()

bool openpine::graph::Label::forceOverlay ( ) const

inline

Gets whether the label is forced to render as overlay.

Definition at line 127 of file label.hpp.

size()

uint32_t openpine::graph::Label::size ( ) const

inline

Gets the label text size.

Definition at line 95 of file label.hpp.

style()

LabelStyle openpine::graph::Label::style ( ) const

inline

Gets the label shape/style.

Definition at line 78 of file label.hpp.

text()

std::string_view openpine::graph::Label::text ( ) const

inline

Gets the label text.

Definition at line 47 of file label.hpp.

References openpine::detail::refToView().

textAlign()

HorizontalAlign openpine::graph::Label::textAlign ( ) const

inline

Gets the horizontal text alignment.

Definition at line 100 of file label.hpp.

textColor()

std::optional< uint32_t > openpine::graph::Label::textColor ( ) const

inline

Gets the optional label text color.

Definition at line 83 of file label.hpp.

textFontFamily()

FontFamily openpine::graph::Label::textFontFamily ( ) const

inline

Gets the font family.

Definition at line 117 of file label.hpp.

textFormatting()

TextFormatting openpine::graph::Label::textFormatting ( ) const

inline

Gets the text formatting (bold/italic).

Definition at line 122 of file label.hpp.

tooltip()

std::optional< std::string_view > openpine::graph::Label::tooltip ( ) const

inline

Gets the optional tooltip.

Definition at line 105 of file label.hpp.

References openpine::detail::refToView().

x()

int64_t openpine::graph::Label::x ( ) const

inline

Gets the label X position.

Definition at line 37 of file label.hpp.

xloc()

XLocation openpine::graph::Label::xloc ( ) const

inline

Gets the X-axis coordinate system used by x().

Definition at line 56 of file label.hpp.

y()

double openpine::graph::Label::y ( ) const

inline

Gets the label Y position.

Definition at line 42 of file label.hpp.

yloc()

YLocation openpine::graph::Label::yloc ( ) const

inline

Gets the Y-axis coordinate system used by y().

Definition at line 61 of file label.hpp.

---

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

• cpp/include/visuals/label.hpp