ScottPlot.Plottables.HorizontalSpan Class Reference

A horizontal span marks the full vertical range between two horizontal values. More...

Inheritance diagram for ScottPlot.Plottables.HorizontalSpan:

Public Member Functions
override AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
override 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.
override? AxisSpanUnderMouse	UnderMouse (CoordinateRect rect)
override void	DragTo (AxisSpanUnderMouse spanUnderMouse, Coordinates mouseNow)
Public Member Functions inherited from ScottPlot.Plottables.AxisSpan
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
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.
AxisSpanUnderMouse?	UnderMouse (CoordinateRect rect)
bool	IsUnderMouse (CoordinateRect rect)
void	DragTo (AxisSpanUnderMouse start, Coordinates mouseNow)

Properties
double	X1 [get, set]
double	X2 [get, set]
CoordinateRange	XRange [get]
double	Left [get, set]
double	Right [get, set]
Properties inherited from ScottPlot.Plottables.AxisSpan
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.
LabelStyle	Label [get, set]
string	LegendText = string.Empty [get, set]
	If populated, this text appears in the legend.
LineStyle	LineStyle = new() [get, set]
float	LineWidth [get, set]
LinePattern	LinePattern [get, set]
Color	LineColor [get, set]
FillStyle	FillStyle = new() [get, set]
Color	FillColor [get, set]
Color	FillHatchColor [get, set]
IHatch?	FillHatch [get, set]
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
bool	EnableAutoscale = true [get, set]
bool	IsDraggable = false [get, set]
bool	IsResizable = false [get, set]
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasLine
Properties inherited from ScottPlot.IHasFill
Properties inherited from ScottPlot.IHasLegendText

Additional Inherited Members
Protected Member Functions inherited from ScottPlot.Plottables.AxisSpan
void	Render (RenderPack rp, PixelRect rect)

Detailed Description

A horizontal span marks the full vertical range between two horizontal values.

Member Function Documentation

DragTo()

override void ScottPlot.Plottables.HorizontalSpan.DragTo ( AxisSpanUnderMouse  spanUnderMouse, Coordinates  mouseNow  )

inline

GetAxisLimits()

override AxisLimits ScottPlot.Plottables.HorizontalSpan.GetAxisLimits ( )

inline

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

Implements ScottPlot.IPlottable.

Render()

override void ScottPlot.Plottables.HorizontalSpan.Render ( RenderPack  rp )

inline

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.

UnderMouse()

override? AxisSpanUnderMouse ScottPlot.Plottables.HorizontalSpan.UnderMouse ( CoordinateRect  rect )

inline

Property Documentation

Left

double ScottPlot.Plottables.HorizontalSpan.Left

getset

Right

double ScottPlot.Plottables.HorizontalSpan.Right

getset

X1

double ScottPlot.Plottables.HorizontalSpan.X1

getset

X2

double ScottPlot.Plottables.HorizontalSpan.X2

getset

XRange

CoordinateRange ScottPlot.Plottables.HorizontalSpan.XRange

get

---

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

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