namespace_Plot2D::PLOT2D_structSeriesInfo Struct Reference

#include <Plot2D.h>


Detailed Description

The options needed for a series.

Definition at line 48 of file Plot2D.h.


Data Fields

std::string DataPath
 The path to the data file.
unsigned X_Column
 The zero based index of the x part of the series.
unsigned Y_Column
 The zero based index of the y part of the series.
bool negate_X
 A boolean to indicate if the user wants to plot -X vs Y.
bool negate_Y
 A boolean to indicate if the user wants to plot X vs -Y.
bool IsConnected
 Is the data connected with line?
CPLOT_enumColor Color
 The color of the points/lines for this series.
std::string Label
 The series label.
std::string Units
 The series label units.
unsigned Precision
 The precision for the statistics table if present.
bool MarkOutlierData
 Data outside the plot window can be indicated (in Cyan) along the plot borders by enabling this option.
bool UsesRightYLabel
 Indicates if data pertains to the right y label.

Field Documentation

std::string namespace_Plot2D::PLOT2D_structSeriesInfo::DataPath

The path to the data file.

Definition at line 50 of file Plot2D.h.

unsigned namespace_Plot2D::PLOT2D_structSeriesInfo::X_Column

The zero based index of the x part of the series.

Definition at line 51 of file Plot2D.h.

unsigned namespace_Plot2D::PLOT2D_structSeriesInfo::Y_Column

The zero based index of the y part of the series.

Definition at line 52 of file Plot2D.h.

bool namespace_Plot2D::PLOT2D_structSeriesInfo::negate_X

A boolean to indicate if the user wants to plot -X vs Y.

Definition at line 53 of file Plot2D.h.

bool namespace_Plot2D::PLOT2D_structSeriesInfo::negate_Y

A boolean to indicate if the user wants to plot X vs -Y.

Definition at line 54 of file Plot2D.h.

bool namespace_Plot2D::PLOT2D_structSeriesInfo::IsConnected

Is the data connected with line?

Definition at line 55 of file Plot2D.h.

CPLOT_enumColor namespace_Plot2D::PLOT2D_structSeriesInfo::Color

The color of the points/lines for this series.

Definition at line 56 of file Plot2D.h.

std::string namespace_Plot2D::PLOT2D_structSeriesInfo::Label

The series label.

Definition at line 57 of file Plot2D.h.

std::string namespace_Plot2D::PLOT2D_structSeriesInfo::Units

The series label units.

Definition at line 58 of file Plot2D.h.

unsigned namespace_Plot2D::PLOT2D_structSeriesInfo::Precision

The precision for the statistics table if present.

Definition at line 59 of file Plot2D.h.

bool namespace_Plot2D::PLOT2D_structSeriesInfo::MarkOutlierData

Data outside the plot window can be indicated (in Cyan) along the plot borders by enabling this option.

Definition at line 60 of file Plot2D.h.

bool namespace_Plot2D::PLOT2D_structSeriesInfo::UsesRightYLabel

Indicates if data pertains to the right y label.

Definition at line 61 of file Plot2D.h.


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