ScottPlot.Plottables.BoxPlot Class Reference

Displays 1 or more boxes all styled the same. More...

Inheritance diagram for ScottPlot.Plottables.BoxPlot:

Public Member Functions
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.

Public Attributes
readonly List< Box >	Boxes = []

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.
string	Label [get, set]
string	LegendText = string.Empty [get, set]
	If populated, this text appears in the legend.
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
Color	FillColor [set]
Color	LineColor [set]
float	LineWidth [set]
Color	StrokeColor [set]
float	StrokeWidth [set]
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasLegendText

Detailed Description

Displays 1 or more boxes all styled the same.

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.BoxPlot.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.BoxPlot.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.

Member Data Documentation

Boxes

readonly List<Box> ScottPlot.Plottables.BoxPlot.Boxes = []

Property Documentation

Axes

IAxes ScottPlot.Plottables.BoxPlot.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.

FillColor

Color ScottPlot.Plottables.BoxPlot.FillColor

set

IsVisible

bool ScottPlot.Plottables.BoxPlot.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.BoxPlot.Label

getset

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.BoxPlot.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LegendText

string ScottPlot.Plottables.BoxPlot.LegendText = string.Empty

getset

If populated, this text appears in the legend.

Implements ScottPlot.IHasLegendText.

LineColor

Color ScottPlot.Plottables.BoxPlot.LineColor

set

LineWidth

float ScottPlot.Plottables.BoxPlot.LineWidth

set

StrokeColor

Color ScottPlot.Plottables.BoxPlot.StrokeColor

set

StrokeWidth

float ScottPlot.Plottables.BoxPlot.StrokeWidth

set

---

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

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