ScottPlot.Plottables.AxisSpan Class Reference

Inheritance diagram for ScottPlot.Plottables.AxisSpan:

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

Protected Member Functions
void	Render (RenderPack rp, PixelRect rect)

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.
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

Member Function Documentation

DragTo()

void ScottPlot.Plottables.AxisSpan.DragTo ( AxisSpanUnderMouse  start, Coordinates  mouseNow  )

abstract

GetAxisLimits()

AxisLimits ScottPlot.Plottables.AxisSpan.GetAxisLimits ( )

abstract

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

Implements ScottPlot.IPlottable.

IsUnderMouse()

bool ScottPlot.Plottables.AxisSpan.IsUnderMouse

(

CoordinateRect

rect

)

Render() [1/2]

void ScottPlot.Plottables.AxisSpan.Render ( RenderPack  rp )

abstract

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.

Render() [2/2]

void ScottPlot.Plottables.AxisSpan.Render ( RenderPack  rp, PixelRect  rect  )

inlineprotected

UnderMouse()

AxisSpanUnderMouse? ScottPlot.Plottables.AxisSpan.UnderMouse ( CoordinateRect  rect )

abstract

Property Documentation

Axes

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

EnableAutoscale

bool ScottPlot.Plottables.AxisSpan.EnableAutoscale = true

getset

FillColor

Color ScottPlot.Plottables.AxisSpan.FillColor

getset

Implements ScottPlot.IHasFill.

FillHatch

IHatch? ScottPlot.Plottables.AxisSpan.FillHatch

getset

Implements ScottPlot.IHasFill.

FillHatchColor

Color ScottPlot.Plottables.AxisSpan.FillHatchColor

getset

Implements ScottPlot.IHasFill.

FillStyle

FillStyle ScottPlot.Plottables.AxisSpan.FillStyle = new()

getset

Implements ScottPlot.IHasFill.

IsDraggable

bool ScottPlot.Plottables.AxisSpan.IsDraggable = false

getset

IsResizable

bool ScottPlot.Plottables.AxisSpan.IsResizable = false

getset

IsVisible

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

LabelStyle ScottPlot.Plottables.AxisSpan.Label

getset

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.AxisSpan.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LegendText

string ScottPlot.Plottables.AxisSpan.LegendText = string.Empty

getset

If populated, this text appears in the legend.

Implements ScottPlot.IHasLegendText.

LineColor

Color ScottPlot.Plottables.AxisSpan.LineColor

getset

Implements ScottPlot.IHasLine.

LinePattern

LinePattern ScottPlot.Plottables.AxisSpan.LinePattern

getset

Implements ScottPlot.IHasLine.

LineStyle

LineStyle ScottPlot.Plottables.AxisSpan.LineStyle = new()

getset

Implements ScottPlot.IHasLine.

LineWidth

float ScottPlot.Plottables.AxisSpan.LineWidth

getset

Implements ScottPlot.IHasLine.

---

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

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