openpine::graph::Box Class Reference

Represents a box graph. More...

#include <box.hpp>

Public Member Functions
	Box (const ffi::Box *p)
int64_t	left () const
	Gets the left x-coordinate.
double	top () const
	Gets the top y-coordinate.
int64_t	right () const
	Gets the right x-coordinate.
double	bottom () const
	Gets the bottom y-coordinate.
std::optional< uint32_t >	borderColor () const
	Gets the optional border color.
int32_t	borderWidth () const
	Gets the border width.
LineStyle	borderStyle () const
	Gets the border style.
Extend	extend () const
	Gets the extend mode.
XLocation	xloc () const
	Gets the X-axis coordinate system used by left()/right().
std::optional< uint32_t >	backgroundColor () const
	Gets the optional background fill color.
std::string_view	text () const
	Gets the text inside the box.
uint32_t	textSize () const
	Gets the text size.
std::optional< uint32_t >	textColor () const
	Gets the optional text color.
HorizontalAlign	textHalign () const
	Gets the text horizontal alignment.
VerticalAlign	textValign () const
	Gets the text vertical alignment.
TextWrap	textWrap () const
	Gets the text wrapping mode.
FontFamily	textFontFamily () const
	Gets the font family.
TextFormatting	textFormatting () const
	Gets the text formatting (bold/italic).
bool	forceOverlay () const
	Gets whether the box is forced to render as overlay.

Detailed Description

Represents a box graph.

Definition at line 27 of file box.hpp.

Constructor & Destructor Documentation

Box()

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

inline

Definition at line 32 of file box.hpp.

Member Function Documentation

backgroundColor()

std::optional< uint32_t > openpine::graph::Box::backgroundColor ( ) const

inline

Gets the optional background fill color.

Definition at line 89 of file box.hpp.

borderColor()

std::optional< uint32_t > openpine::graph::Box::borderColor ( ) const

inline

Gets the optional border color.

Definition at line 57 of file box.hpp.

borderStyle()

LineStyle openpine::graph::Box::borderStyle ( ) const

inline

Gets the border style.

Definition at line 74 of file box.hpp.

borderWidth()

int32_t openpine::graph::Box::borderWidth ( ) const

inline

Gets the border width.

Definition at line 69 of file box.hpp.

bottom()

double openpine::graph::Box::bottom ( ) const

inline

Gets the bottom y-coordinate.

Definition at line 52 of file box.hpp.

extend()

Extend openpine::graph::Box::extend ( ) const

inline

Gets the extend mode.

Definition at line 79 of file box.hpp.

forceOverlay()

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

inline

Gets whether the box is forced to render as overlay.

Definition at line 152 of file box.hpp.

left()

int64_t openpine::graph::Box::left ( ) const

inline

Gets the left x-coordinate.

Definition at line 37 of file box.hpp.

right()

int64_t openpine::graph::Box::right ( ) const

inline

Gets the right x-coordinate.

Definition at line 47 of file box.hpp.

text()

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

inline

Gets the text inside the box.

Definition at line 101 of file box.hpp.

References openpine::detail::refToView().

textColor()

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

inline

Gets the optional text color.

Definition at line 115 of file box.hpp.

textFontFamily()

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

inline

Gets the font family.

Definition at line 142 of file box.hpp.

textFormatting()

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

inline

Gets the text formatting (bold/italic).

Definition at line 147 of file box.hpp.

textHalign()

HorizontalAlign openpine::graph::Box::textHalign ( ) const

inline

Gets the text horizontal alignment.

Definition at line 127 of file box.hpp.

textSize()

uint32_t openpine::graph::Box::textSize ( ) const

inline

Gets the text size.

Definition at line 110 of file box.hpp.

textValign()

VerticalAlign openpine::graph::Box::textValign ( ) const

inline

Gets the text vertical alignment.

Definition at line 132 of file box.hpp.

textWrap()

TextWrap openpine::graph::Box::textWrap ( ) const

inline

Gets the text wrapping mode.

Definition at line 137 of file box.hpp.

top()

double openpine::graph::Box::top ( ) const

inline

Gets the top y-coordinate.

Definition at line 42 of file box.hpp.

xloc()

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

inline

Gets the X-axis coordinate system used by left()/right().

Definition at line 84 of file box.hpp.

---

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

• cpp/include/visuals/box.hpp