openpine::seriesgraph::Fill Class Reference

Represents a fill between two anchors. More...

#include <fill.hpp>

Public Member Functions
	Fill (const ffi::Fill *p)
FillAnchorType	fromType () const
	Gets the kind of the "from" anchor.
std::optional< int64_t >	fromPlotId () const
	Gets the plot id of the "from" anchor, if it is a plot.
std::optional< int64_t >	fromHlineId () const
	Gets the hline id of the "from" anchor, if it is a hline.
FillAnchorType	toType () const
	Gets the kind of the "to" anchor.
std::optional< int64_t >	toPlotId () const
	Gets the plot id of the "to" anchor, if it is a plot.
std::optional< int64_t >	toHlineId () const
	Gets the hline id of the "to" anchor, if it is a hline.
std::optional< std::string_view >	title () const
	Gets the fill title, if set.
bool	editable () const
	Returns whether the fill is user-editable.
std::optional< uintptr_t >	showLast () const
	Gets the show_last value, if set.
bool	fillGaps () const
	Returns whether the fill is drawn across gaps.
Display	display () const
	Gets the display bitmask.
std::optional< FillColorType >	colorType (uintptr_t idx) const
	Gets the fill color kind at the specified index.
std::optional< uint32_t >	solidColor (uintptr_t idx) const
	Gets the solid fill color at the specified index.
std::optional< FillGradient >	gradient (uintptr_t idx) const
	Gets the gradient fill definition at the specified index.

Detailed Description

Represents a fill between two anchors.

Definition at line 28 of file fill.hpp.

Constructor & Destructor Documentation

Fill()

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

inline

Definition at line 33 of file fill.hpp.

Member Function Documentation

colorType()

std::optional< FillColorType > openpine::seriesgraph::Fill::colorType ( uintptr_t idx ) const

inline

Gets the fill color kind at the specified index.

Definition at line 135 of file fill.hpp.

display()

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

inline

Gets the display bitmask.

Definition at line 130 of file fill.hpp.

editable()

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

inline

Returns whether the fill is user-editable.

Definition at line 108 of file fill.hpp.

fillGaps()

bool openpine::seriesgraph::Fill::fillGaps ( ) const

inline

Returns whether the fill is drawn across gaps.

Definition at line 125 of file fill.hpp.

fromHlineId()

std::optional< int64_t > openpine::seriesgraph::Fill::fromHlineId ( ) const

inline

Gets the hline id of the "from" anchor, if it is a hline.

Definition at line 55 of file fill.hpp.

fromPlotId()

std::optional< int64_t > openpine::seriesgraph::Fill::fromPlotId ( ) const

inline

Gets the plot id of the "from" anchor, if it is a plot.

Definition at line 43 of file fill.hpp.

fromType()

FillAnchorType openpine::seriesgraph::Fill::fromType ( ) const

inline

Gets the kind of the "from" anchor.

Definition at line 38 of file fill.hpp.

gradient()

std::optional< FillGradient > openpine::seriesgraph::Fill::gradient ( uintptr_t idx ) const

inline

Gets the gradient fill definition at the specified index.

Definition at line 159 of file fill.hpp.

showLast()

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

inline

Gets the show_last value, if set.

Definition at line 113 of file fill.hpp.

solidColor()

std::optional< uint32_t > openpine::seriesgraph::Fill::solidColor ( uintptr_t idx ) const

inline

Gets the solid fill color at the specified index.

Definition at line 147 of file fill.hpp.

title()

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

inline

Gets the fill title, if set.

Definition at line 96 of file fill.hpp.

References openpine::detail::refToView().

toHlineId()

std::optional< int64_t > openpine::seriesgraph::Fill::toHlineId ( ) const

inline

Gets the hline id of the "to" anchor, if it is a hline.

Definition at line 84 of file fill.hpp.

toPlotId()

std::optional< int64_t > openpine::seriesgraph::Fill::toPlotId ( ) const

inline

Gets the plot id of the "to" anchor, if it is a plot.

Definition at line 72 of file fill.hpp.

toType()

FillAnchorType openpine::seriesgraph::Fill::toType ( ) const

inline

Gets the kind of the "to" anchor.

Definition at line 67 of file fill.hpp.

---

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

• cpp/include/visuals/fill.hpp