ScottPlot.Plottables.HorizontalLine Class Reference

A line at a defined Y position that spans the entire horizontal space of the data area. More...

Inheritance diagram for ScottPlot.Plottables.HorizontalLine:

Public Member Functions
	HorizontalLine ()
override bool	IsUnderMouse (CoordinateRect rect)
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 void	RenderLast (RenderPack rp)
	Plottables that implement this interface have a second render method that runs after the axes are drawn, allowing graphics to be placed on top of the axes.
Public Member Functions inherited from ScottPlot.Plottables.AxisLine
bool	IsUnderMouse (CoordinateRect rect)
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.
void	RenderLast (RenderPack rp)
	Plottables that implement this interface have a second render method that runs after the axes are drawn, allowing graphics to be placed on top of the axes.

Properties
double	Y [get, set]
double	Minimum = double.NegativeInfinity [get, set]
double	Maximum = double.PositiveInfinity [get, set]
Properties inherited from ScottPlot.Plottables.AxisLine
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.
LineStyle	LineStyle = new() { Width = 1 } [get, set]
float	LineWidth [get, set]
LinePattern	LinePattern [get, set]
Color	LineColor [get, set]
override LabelStyle	LabelStyle = new() [get, set]
string	Text [get, set]
string	LegendText = string.Empty [get, set]
	If populated, this text appears in the legend.
Alignment?	ManualLabelAlignment = null [get, set]
Alignment?	TextAlignment [get, set]
LabelStyle	Label [get, set]
float	FontSize [get, set]
bool	FontBold [get, set]
string	FontName [get, set]
Color	FontColor [get, set]
Color	TextColor [get, set]
Color	TextBackgroundColor [get, set]
float	TextRotation [get, set]
float	TextSize [get, set]
bool	LabelOppositeAxis = false [get, set]
bool	IsDraggable = false [get, set]
bool	ExcludeFromLegend = false [get, set]
bool	EnableAutoscale = true [get, set]
Color	Color [get, set]
double	Position = 0 [get, set]
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
Properties inherited from ScottPlot.LabelStyleProperties
LabelStyle	LabelStyle [get, set]
float	LabelOffsetX [get, set]
float	LabelOffsetY [get, set]
float	LabelRotation [get, set]
float	LabelPadding [set]
PixelPadding	LabelPixelPadding [get, set]
PixelRect	LabelLastRenderPixelRect [get]
string	LabelText [get, set]
Alignment	LabelAlignment [get, set]
string	LabelFontName [get, set]
float	LabelFontSize [get, set]
float?	LabelLineSpacing [get, set]
bool	LabelItalic [get, set]
bool	LabelBold [get, set]
Color	LabelFontColor [get, set]
Color	LabelBackgroundColor [get, set]
float	LabelBorderRadius [get, set]
float	LabelBorderRadiusX [get, set]
float	LabelBorderRadiusY [get, set]
float	LabelBorderWidth [get, set]
Color	LabelBorderColor [get, set]
Color	LabelShadowColor [get, set]
PixelOffset	LabelShadowOffset [get, set]
Properties inherited from ScottPlot.IHasLabel
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasLine
Properties inherited from ScottPlot.IHasLegendText

Detailed Description

A line at a defined Y position that spans the entire horizontal space of the data area.

Constructor & Destructor Documentation

HorizontalLine()

ScottPlot.Plottables.HorizontalLine.HorizontalLine ( )

inline

Member Function Documentation

GetAxisLimits()

override AxisLimits ScottPlot.Plottables.HorizontalLine.GetAxisLimits ( )

inline

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

Implements ScottPlot.IPlottable.

IsUnderMouse()

override bool ScottPlot.Plottables.HorizontalLine.IsUnderMouse

(

CoordinateRect

rect

)

Render()

override void ScottPlot.Plottables.HorizontalLine.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.

RenderLast()

override void ScottPlot.Plottables.HorizontalLine.RenderLast ( RenderPack  rp )

inline

Plottables that implement this interface have a second render method that runs after the axes are drawn, allowing graphics to be placed on top of the axes.

Implements ScottPlot.IRenderLast.

Property Documentation

Maximum

double ScottPlot.Plottables.HorizontalLine.Maximum = double.PositiveInfinity

getset

Minimum

double ScottPlot.Plottables.HorizontalLine.Minimum = double.NegativeInfinity

getset

Y

double ScottPlot.Plottables.HorizontalLine.Y

getset

---

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

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