Class Crosshair

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public class Crosshair : IPlottable, IRenderLast, IHasMarker

Inheritance

object

Crosshair

Implements

IPlottable

IRenderLast

IHasMarker

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

DataSourceUtilities.BinarySearch<T, TList>(TList, int, int, T, IComparer<T>?)

DataSourceUtilities.GetClosestIndex<TValue, TList>(TList, TValue, IndexRange, IComparer<TValue>?)

Fields

FontColor

[Obsolete("Use TextColor and TextBackgroundColor instead", true)]
public Color FontColor

Field Value

Color

Properties

Axes

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.

public IAxes Axes { get; set; }

Property Value

IAxes

EnableAutoscale

public bool EnableAutoscale { get; set; }

Property Value

bool

FontBold

public bool FontBold { set; }

Property Value

bool

FontName

public string FontName { set; }

Property Value

string

FontSize

public float FontSize { set; }

Property Value

float

HorizontalLine

public HorizontalLine HorizontalLine { get; }

Property Value

HorizontalLine

IsVisible

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

public bool IsVisible { get; set; }

Property Value

bool

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

LineColor

public Color LineColor { set; }

Property Value

Color

LinePattern

public LinePattern LinePattern { set; }

Property Value

LinePattern

LineStyle

[Obsolete("Assign values to LineColor, LineWidth, or LinePattern properties to set style for both lines. HorizontalLine and VerticalLine have properties that can be set individually as well.", true)]
public LineStyle LineStyle { get; set; }

Property Value

LineStyle

LineWidth

public float LineWidth { set; }

Property Value

float

MarkerColor

public Color MarkerColor { get; set; }

Property Value

Color

MarkerFillColor

public Color MarkerFillColor { get; set; }

Property Value

Color

MarkerLineColor

public Color MarkerLineColor { get; set; }

Property Value

Color

MarkerLineWidth

public float MarkerLineWidth { get; set; }

Property Value

float

MarkerShape

public MarkerShape MarkerShape { get; set; }

Property Value

MarkerShape

MarkerSize

public float MarkerSize { get; set; }

Property Value

float

MarkerStyle

public MarkerStyle MarkerStyle { get; set; }

Property Value

MarkerStyle

Position

public Coordinates Position { get; set; }

Property Value

Coordinates

TextBackgroundColor

public Color TextBackgroundColor { set; }

Property Value

Color

TextColor

public Color TextColor { set; }

Property Value

Color

VerticalLine

public VerticalLine VerticalLine { get; }

Property Value

VerticalLine

X

public double X { get; set; }

Property Value

double

Y

public double Y { get; set; }

Property Value

double

Methods

GetAxisLimits()

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

public AxisLimits GetAxisLimits()

Returns

AxisLimits

Render(RenderPack)

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 virtual void Render(RenderPack rp)

Parameters

rp RenderPack

RenderLast(RenderPack)

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 void RenderLast(RenderPack rp)

Parameters

rp RenderPack