openpine::seriesgraph::BackgroundColors Class Reference

Represents background-colors settings in a chart. More...

#include <background_colors.hpp>

Public Member Functions
	BackgroundColors (const ffi::BackgroundColors *p)
int32_t	offset () const
	Returns the background-colors offset.
bool	editable () const
	Returns whether background-colors are editable.
std::optional< uintptr_t >	showLast () const
	Gets the show_last value, if set.
std::optional< std::string_view >	title () const
	Gets the title of the background-colors series.
Display	display () const
	Gets the display bitmask.
bool	forceOverlay () const
	Gets whether the background colors are forced to render as overlay.
std::optional< uint32_t >	color (uintptr_t idx) const
	Gets the background color at the specified index.

Detailed Description

Represents background-colors settings in a chart.

Definition at line 27 of file background_colors.hpp.

Constructor & Destructor Documentation

BackgroundColors()

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

inline

Definition at line 32 of file background_colors.hpp.

Member Function Documentation

color()

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

inline

Gets the background color at the specified index.

Parameters

idx	The bar index.

Returns

The color value (format defined by the ABI) if available, otherwise std::nullopt.

Definition at line 85 of file background_colors.hpp.

display()

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

inline

Gets the display bitmask.

Definition at line 72 of file background_colors.hpp.

editable()

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

inline

Returns whether background-colors are editable.

Definition at line 42 of file background_colors.hpp.

forceOverlay()

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

inline

Gets whether the background colors are forced to render as overlay.

Definition at line 77 of file background_colors.hpp.

offset()

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

inline

Returns the background-colors offset.

Definition at line 37 of file background_colors.hpp.

showLast()

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

inline

Gets the show_last value, if set.

Definition at line 47 of file background_colors.hpp.

title()

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

inline

Gets the title of the background-colors series.

Returns

The title if available, otherwise std::nullopt.

Definition at line 60 of file background_colors.hpp.

References openpine::detail::refToView().

---

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

• cpp/include/visuals/background_colors.hpp