ScottPlot.Plottables.ErrorBar Class Reference

Inheritance diagram for ScottPlot.Plottables.ErrorBar:

Public Member Functions
	ErrorBar (IReadOnlyList< double > xs, IReadOnlyList< double > ys, IReadOnlyList< double >? xErrorsPositive, IReadOnlyList< double >? xErrorsNegative, IReadOnlyList< double >? yErrorsPositive, IReadOnlyList< double >? yErrorsNegative)
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
virtual void	Render (RenderPack rp)
	Draw the data from this plottable into the data area defined in the Axes. By default the surface is already clipped to the data area, but this can be cleared inside the plottable.

Properties
bool	IsVisible = true [get, set]
	Toggles whether this plottable is shown and contributes to the automatic axis limit detection. The calling method will check this variable (it does not need to be checked inside the Render method).
IAxes	Axes = new Axes() [get, set]
	This object performs coordinate/pixel translation at render time based on the latest data area. It stores the axes to use for this plottable and also the data area (in pixels) updated just before each render. If this object is null it will be constructed using the default X and Y axes at render time.
IReadOnlyList< double >	Xs [get, set]
IReadOnlyList< double >	Ys [get, set]
IReadOnlyList< double >?	XErrorPositive [get, set]
IReadOnlyList< double >?	XErrorNegative [get, set]
IReadOnlyList< double >?	YErrorPositive [get, set]
IReadOnlyList< double >?	YErrorNegative [get, set]
LineStyle	LineStyle = new() { Width = 1 } [get, set]
float	LineWidth [get, set]
LinePattern	LinePattern [get, set]
Color	LineColor [get, set]
float	CapSize = 3 [get, set]
Color	Color [get, set]
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
string	Label [get, set]
string	LegendText = string.Empty [get, set]
	If populated, this text appears in the legend.
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasLine
Properties inherited from ScottPlot.IHasLegendText

Constructor & Destructor Documentation

ErrorBar()

ScottPlot.Plottables.ErrorBar.ErrorBar ( IReadOnlyList< double >  xs, IReadOnlyList< double >  ys, IReadOnlyList< double >?  xErrorsPositive, IReadOnlyList< double >?  xErrorsNegative, IReadOnlyList< double >?  yErrorsPositive, IReadOnlyList< double >?  yErrorsNegative  )

inline

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.ErrorBar.GetAxisLimits ( )

inline

Return the 2D area (in coordinate space) occupied by the data contained in this plottable.

Implements ScottPlot.IPlottable.

Render()

virtual void ScottPlot.Plottables.ErrorBar.Render ( RenderPack  rp )

inlinevirtual

Draw the data from this plottable into the data area defined in the Axes. By default the surface is already clipped to the data area, but this can be cleared inside the plottable.

Implements ScottPlot.IPlottable.

Property Documentation

Axes

IAxes ScottPlot.Plottables.ErrorBar.Axes = new Axes()

getset

This object performs coordinate/pixel translation at render time based on the latest data area. It stores the axes to use for this plottable and also the data area (in pixels) updated just before each render. If this object is null it will be constructed using the default X and Y axes at render time.

Implements ScottPlot.IPlottable.

CapSize

float ScottPlot.Plottables.ErrorBar.CapSize = 3

getset

Color

Color ScottPlot.Plottables.ErrorBar.Color

getset

IsVisible

bool ScottPlot.Plottables.ErrorBar.IsVisible = true

getset

Toggles whether this plottable is shown and contributes to the automatic axis limit detection. The calling method will check this variable (it does not need to be checked inside the Render method).

Implements ScottPlot.IPlottable.

Label

string ScottPlot.Plottables.ErrorBar.Label

getset

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.ErrorBar.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LegendText

string ScottPlot.Plottables.ErrorBar.LegendText = string.Empty

getset

If populated, this text appears in the legend.

Implements ScottPlot.IHasLegendText.

LineColor

Color ScottPlot.Plottables.ErrorBar.LineColor

getset

Implements ScottPlot.IHasLine.

LinePattern

LinePattern ScottPlot.Plottables.ErrorBar.LinePattern

getset

Implements ScottPlot.IHasLine.

LineStyle

LineStyle ScottPlot.Plottables.ErrorBar.LineStyle = new() { Width = 1 }

getset

Implements ScottPlot.IHasLine.

LineWidth

float ScottPlot.Plottables.ErrorBar.LineWidth

getset

Implements ScottPlot.IHasLine.

XErrorNegative

IReadOnlyList<double>? ScottPlot.Plottables.ErrorBar.XErrorNegative

getset

XErrorPositive

IReadOnlyList<double>? ScottPlot.Plottables.ErrorBar.XErrorPositive

getset

Xs

IReadOnlyList<double> ScottPlot.Plottables.ErrorBar.Xs

getset

YErrorNegative

IReadOnlyList<double>? ScottPlot.Plottables.ErrorBar.YErrorNegative

getset

YErrorPositive

IReadOnlyList<double>? ScottPlot.Plottables.ErrorBar.YErrorPositive

getset

Ys

IReadOnlyList<double> ScottPlot.Plottables.ErrorBar.Ys

getset

---

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

• ScottPlot/src/ScottPlot5/ScottPlot5/Plottables/ErrorBar.cs