OpenPine C++ API
C++ wrapper for the OpenPine Pine Script VM
Loading...
Searching...
No Matches
openpine::graph::Line Class Reference

Represents a line graph. More...

#include <line.hpp>

Public Member Functions

 Line (const ffi::Line *p)
int64_t x1 () const
 Gets the first X coordinate.
double y1 () const
 Gets the first Y coordinate.
int64_t x2 () const
 Gets the second X coordinate.
double y2 () const
 Gets the second Y coordinate.
XLocation xloc () const
 Gets the X-axis coordinate system used by x1()/x2().
Extend extend () const
 Gets the extend mode.
std::optional< uint32_t > color () const
 Gets the optional stroke color.
LineStyle style () const
 Gets the stroke style.
int32_t width () const
 Gets the stroke width.
bool forceOverlay () const
 Gets whether the line is forced to render as overlay.

Detailed Description

Represents a line graph.

Definition at line 25 of file line.hpp.

Constructor & Destructor Documentation

◆ Line()

openpine::graph::Line::Line ( const ffi::Line * p)
inline

Definition at line 30 of file line.hpp.

Member Function Documentation

◆ color()

std::optional< uint32_t > openpine::graph::Line::color ( ) const
inline

Gets the optional stroke color.

Definition at line 65 of file line.hpp.

◆ extend()

Extend openpine::graph::Line::extend ( ) const
inline

Gets the extend mode.

Definition at line 60 of file line.hpp.

◆ forceOverlay()

bool openpine::graph::Line::forceOverlay ( ) const
inline

Gets whether the line is forced to render as overlay.

Definition at line 87 of file line.hpp.

◆ style()

LineStyle openpine::graph::Line::style ( ) const
inline

Gets the stroke style.

Definition at line 77 of file line.hpp.

◆ width()

int32_t openpine::graph::Line::width ( ) const
inline

Gets the stroke width.

Definition at line 82 of file line.hpp.

◆ x1()

int64_t openpine::graph::Line::x1 ( ) const
inline

Gets the first X coordinate.

Definition at line 35 of file line.hpp.

◆ x2()

int64_t openpine::graph::Line::x2 ( ) const
inline

Gets the second X coordinate.

Definition at line 45 of file line.hpp.

◆ xloc()

XLocation openpine::graph::Line::xloc ( ) const
inline

Gets the X-axis coordinate system used by x1()/x2().

Definition at line 55 of file line.hpp.

◆ y1()

double openpine::graph::Line::y1 ( ) const
inline

Gets the first Y coordinate.

Definition at line 40 of file line.hpp.

◆ y2()

double openpine::graph::Line::y2 ( ) const
inline

Gets the second Y coordinate.

Definition at line 50 of file line.hpp.


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