openpine::seriesgraph::PlotCandle Class Reference

Represents a plotcandle output. More...

#include <plot_candle.hpp>

Public Member Functions
	PlotCandle (const ffi::PlotCandle *p)
std::optional< std::string_view >	title () const
	Gets the title.
std::optional< ffi::Bar >	value (uintptr_t idx) const
	Gets the OHLC bar at the specified index.
std::optional< uint32_t >	color (uintptr_t idx) const
	Gets the body color at the specified index.
std::optional< uint32_t >	wickColor (uintptr_t idx) const
	Gets the wick color at the specified index.
std::optional< uint32_t >	borderColor (uintptr_t idx) const
	Gets the border color at the specified index.
bool	editable () const
	Returns whether the plot-candle 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-candle is forced to render as overlay.

Detailed Description

Represents a plotcandle output.

Definition at line 27 of file plot_candle.hpp.

Constructor & Destructor Documentation

PlotCandle()

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

inline

Definition at line 32 of file plot_candle.hpp.

Member Function Documentation

borderColor()

std::optional< uint32_t > openpine::seriesgraph::PlotCandle::borderColor ( uintptr_t idx ) const

inline

Gets the border color at the specified index.

Definition at line 86 of file plot_candle.hpp.

color()

std::optional< uint32_t > openpine::seriesgraph::PlotCandle::color ( uintptr_t idx ) const

inline

Gets the body color at the specified index.

Definition at line 62 of file plot_candle.hpp.

display()

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

inline

Gets the display bitmask.

Definition at line 115 of file plot_candle.hpp.

editable()

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

inline

Returns whether the plot-candle is editable.

Definition at line 98 of file plot_candle.hpp.

forceOverlay()

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

inline

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

Definition at line 144 of file plot_candle.hpp.

format()

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

inline

Gets the optional formatting hint.

Definition at line 120 of file plot_candle.hpp.

References openpine::detail::refToView().

precision()

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

inline

Gets the optional decimal precision.

Definition at line 132 of file plot_candle.hpp.

showLast()

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

inline

Gets the show_last value, if set.

Definition at line 103 of file plot_candle.hpp.

title()

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

inline

Gets the title.

Returns

The title if available, otherwise std::nullopt.

Definition at line 38 of file plot_candle.hpp.

References openpine::detail::refToView().

value()

std::optional< ffi::Bar > openpine::seriesgraph::PlotCandle::value ( uintptr_t idx ) const

inline

Gets the OHLC bar at the specified index.

Definition at line 50 of file plot_candle.hpp.

wickColor()

std::optional< uint32_t > openpine::seriesgraph::PlotCandle::wickColor ( uintptr_t idx ) const

inline

Gets the wick color at the specified index.

Definition at line 74 of file plot_candle.hpp.

---

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

• cpp/include/visuals/plot_candle.hpp