ScottPlot.Plottables.Bracket Class Reference

Inheritance diagram for ScottPlot.Plottables.Bracket:

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
float	EdgeLength = 5
	Size of the small lines (in pixels) placed the edges of the bracket and between the center of the bracket and the label.

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.
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
Coordinates	Point1 [get, set]
Coordinates	Point2 [get, set]
bool	LabelCounterClockwise = false [get, set]
	Controls whether the tip of the bracket is counter-clockwise from the line formed by the bracket base.
string	Text = string.Empty [get, set]
	Text displayed near the center of the bracket.
LineStyle	LineStyle = new() { IsVisible = true, Width = 1 } [get, set]
LabelStyle	LabelStyle = new() { IsVisible = true, Alignment = Alignment.LowerCenter } [get, set]
Properties inherited from ScottPlot.IPlottable

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.Bracket.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

Render()

virtual void ScottPlot.Plottables.Bracket.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

EdgeLength

float ScottPlot.Plottables.Bracket.EdgeLength = 5

Size of the small lines (in pixels) placed the edges of the bracket and between the center of the bracket and the label.

Property Documentation

Axes

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

IsVisible

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

LabelCounterClockwise

bool ScottPlot.Plottables.Bracket.LabelCounterClockwise = false

getset

Controls whether the tip of the bracket is counter-clockwise from the line formed by the bracket base.

LabelStyle

LabelStyle ScottPlot.Plottables.Bracket.LabelStyle = new() { IsVisible = true, Alignment = Alignment.LowerCenter }

getset

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.Bracket.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LineStyle

LineStyle ScottPlot.Plottables.Bracket.LineStyle = new() { IsVisible = true, Width = 1 }

getset

Point1

Coordinates ScottPlot.Plottables.Bracket.Point1

getset

Point2

Coordinates ScottPlot.Plottables.Bracket.Point2

getset

Text

string ScottPlot.Plottables.Bracket.Text = string.Empty

getset

Text displayed near the center of the bracket.

---

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

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