ScottPlot.Plottables.Crosshair Class Reference

Inheritance diagram for ScottPlot.Plottables.Crosshair:

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.
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 Attributes
Color	FontColor

Properties
HorizontalLine	HorizontalLine = new() [get]
VerticalLine	VerticalLine = new() [get]
Coordinates	Position [get, set]
double	X [get, set]
double	Y [get, set]
float	FontSize [set]
bool	FontBold [set]
string	FontName [set]
Color	TextColor [set]
Color	TextBackgroundColor [set]
Color	LineColor [set]
float	LineWidth [set]
LinePattern	LinePattern [set]
MarkerStyle	MarkerStyle = new() { LineWidth = 1 } [get, set]
MarkerShape	MarkerShape [get, set]
float	MarkerSize [get, set]
Color	MarkerFillColor [get, set]
Color	MarkerLineColor [get, set]
Color	MarkerColor [get, set]
float	MarkerLineWidth [get, set]
LineStyle	LineStyle = new() [get, set]
bool	EnableAutoscale = false [get, set]
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.
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasMarker

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.Crosshair.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

Render()

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

RenderLast()

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

Member Data Documentation

FontColor

Color ScottPlot.Plottables.Crosshair.FontColor

Property Documentation

Axes

IAxes ScottPlot.Plottables.Crosshair.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.Crosshair.EnableAutoscale = false

getset

FontBold

bool ScottPlot.Plottables.Crosshair.FontBold

set

FontName

string ScottPlot.Plottables.Crosshair.FontName

set

FontSize

float ScottPlot.Plottables.Crosshair.FontSize

set

HorizontalLine

HorizontalLine ScottPlot.Plottables.Crosshair.HorizontalLine = new()

get

IsVisible

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

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.Crosshair.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LineColor

Color ScottPlot.Plottables.Crosshair.LineColor

set

LinePattern

LinePattern ScottPlot.Plottables.Crosshair.LinePattern

set

LineStyle

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

getset

LineWidth

float ScottPlot.Plottables.Crosshair.LineWidth

set

MarkerColor

Color ScottPlot.Plottables.Crosshair.MarkerColor

getset

Implements ScottPlot.IHasMarker.

MarkerFillColor

Color ScottPlot.Plottables.Crosshair.MarkerFillColor

getset

Implements ScottPlot.IHasMarker.

MarkerLineColor

Color ScottPlot.Plottables.Crosshair.MarkerLineColor

getset

Implements ScottPlot.IHasMarker.

MarkerLineWidth

float ScottPlot.Plottables.Crosshair.MarkerLineWidth

getset

Implements ScottPlot.IHasMarker.

MarkerShape

MarkerShape ScottPlot.Plottables.Crosshair.MarkerShape

getset

Implements ScottPlot.IHasMarker.

MarkerSize

float ScottPlot.Plottables.Crosshair.MarkerSize

getset

Implements ScottPlot.IHasMarker.

MarkerStyle

MarkerStyle ScottPlot.Plottables.Crosshair.MarkerStyle = new() { LineWidth = 1 }

getset

Implements ScottPlot.IHasMarker.

Position

Coordinates ScottPlot.Plottables.Crosshair.Position

getset

TextBackgroundColor

Color ScottPlot.Plottables.Crosshair.TextBackgroundColor

set

TextColor

Color ScottPlot.Plottables.Crosshair.TextColor

set

VerticalLine

VerticalLine ScottPlot.Plottables.Crosshair.VerticalLine = new()

get

X

double ScottPlot.Plottables.Crosshair.X

getset

Y

double ScottPlot.Plottables.Crosshair.Y

getset

---

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

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