openpine::seriesgraph::PlotArrow Class Reference

Represents a plotarrow output. More...

#include <plot_arrow.hpp>

Public Member Functions
	PlotArrow (const ffi::PlotArrow *p)
std::optional< std::string_view >	title () const
	Gets the title.
std::optional< double >	value (uintptr_t idx) const
	Gets the series value at the specified index.
std::optional< uint32_t >	upColor (uintptr_t idx) const
	Gets the up color at the specified index.
std::optional< uint32_t >	downColor (uintptr_t idx) const
	Gets the down color at the specified index.
int32_t	offset () const
	Gets the bar index offset.
uintptr_t	minHeight () const
	Gets the minimum arrow height.
uintptr_t	maxHeight () const
	Gets the maximum arrow height.
bool	editable () const
	Returns whether the plot-arrow is editable.
std::optional< uintptr_t >	showLast () const
	Gets the show_last value, if set.
Display	display () const
	Gets the display bitmask.
std::optional< std::string_view >	format () const
	Gets the optional formatting hint.
std::optional< int32_t >	precision () const
	Gets the optional decimal precision.
bool	forceOverlay () const
	Gets whether the plot-arrow is forced to render as overlay.

Detailed Description

Represents a plotarrow output.

Definition at line 27 of file plot_arrow.hpp.

Constructor & Destructor Documentation

PlotArrow()

openpine::seriesgraph::PlotArrow::PlotArrow ( const ffi::PlotArrow * p )

inline

Definition at line 32 of file plot_arrow.hpp.

Member Function Documentation

display()

Display openpine::seriesgraph::PlotArrow::display ( ) const

inline

Gets the display bitmask.

Definition at line 118 of file plot_arrow.hpp.

downColor()

std::optional< uint32_t > openpine::seriesgraph::PlotArrow::downColor ( uintptr_t idx ) const

inline

Gets the down color at the specified index.

Definition at line 74 of file plot_arrow.hpp.

editable()

bool openpine::seriesgraph::PlotArrow::editable ( ) const

inline

Returns whether the plot-arrow is editable.

Definition at line 101 of file plot_arrow.hpp.

forceOverlay()

bool openpine::seriesgraph::PlotArrow::forceOverlay ( ) const

inline

Gets whether the plot-arrow is forced to render as overlay.

Definition at line 147 of file plot_arrow.hpp.

format()

std::optional< std::string_view > openpine::seriesgraph::PlotArrow::format ( ) const

inline

Gets the optional formatting hint.

Definition at line 123 of file plot_arrow.hpp.

References openpine::detail::refToView().

maxHeight()

uintptr_t openpine::seriesgraph::PlotArrow::maxHeight ( ) const

inline

Gets the maximum arrow height.

Definition at line 96 of file plot_arrow.hpp.

minHeight()

uintptr_t openpine::seriesgraph::PlotArrow::minHeight ( ) const

inline

Gets the minimum arrow height.

Definition at line 91 of file plot_arrow.hpp.

offset()

int32_t openpine::seriesgraph::PlotArrow::offset ( ) const

inline

Gets the bar index offset.

Definition at line 86 of file plot_arrow.hpp.

precision()

std::optional< int32_t > openpine::seriesgraph::PlotArrow::precision ( ) const

inline

Gets the optional decimal precision.

Definition at line 135 of file plot_arrow.hpp.

showLast()

std::optional< uintptr_t > openpine::seriesgraph::PlotArrow::showLast ( ) const

inline

Gets the show_last value, if set.

Definition at line 106 of file plot_arrow.hpp.

title()

std::optional< std::string_view > openpine::seriesgraph::PlotArrow::title ( ) const

inline

Gets the title.

Returns

The title if available, otherwise std::nullopt.

Definition at line 38 of file plot_arrow.hpp.

References openpine::detail::refToView().

upColor()

std::optional< uint32_t > openpine::seriesgraph::PlotArrow::upColor ( uintptr_t idx ) const

inline

Gets the up color at the specified index.

Definition at line 62 of file plot_arrow.hpp.

value()

std::optional< double > openpine::seriesgraph::PlotArrow::value ( uintptr_t idx ) const

inline

Gets the series value at the specified index.

Definition at line 50 of file plot_arrow.hpp.

---

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

• cpp/include/visuals/plot_arrow.hpp