Class AxisSpan

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public abstract class AxisSpan : IPlottable, IHasLine, IHasFill, IHasLegendText

Inheritance

object

AxisSpan

Implements

IPlottable

IHasLine

IHasFill

IHasLegendText

Derived

HorizontalSpan

VerticalSpan

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

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

FillColor

public Color FillColor { get; set; }

Property Value

Color

FillHatch

public IHatch? FillHatch { get; set; }

Property Value

IHatch

FillHatchColor

public Color FillHatchColor { get; set; }

Property Value

Color

FillStyle

public FillStyle FillStyle { get; set; }

Property Value

FillStyle

IsDraggable

public bool IsDraggable { get; set; }

Property Value

bool

IsResizable

public bool IsResizable { get; set; }

Property Value

bool

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

Label

[Obsolete("set LegendText")]
public LabelStyle Label { get; set; }

Property Value

LabelStyle

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

LegendText

If populated, this text appears in the legend

public string LegendText { get; set; }

Property Value

string

LineColor

public Color LineColor { get; set; }

Property Value

Color

LinePattern

public LinePattern LinePattern { get; set; }

Property Value

LinePattern

LineStyle

public LineStyle LineStyle { get; set; }

Property Value

LineStyle

LineWidth

public float LineWidth { get; set; }

Property Value

float

Methods

DragTo(AxisSpanUnderMouse, Coordinates)

public abstract void DragTo(AxisSpanUnderMouse start, Coordinates mouseNow)

Parameters

start AxisSpanUnderMouse

mouseNow Coordinates

GetAxisLimits()

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

public abstract AxisLimits GetAxisLimits()

Returns

AxisLimits

IsUnderMouse(CoordinateRect)

public bool IsUnderMouse(CoordinateRect rect)

Parameters

rect CoordinateRect

Returns

bool

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

Parameters

rp RenderPack

Render(RenderPack, PixelRect)

protected void Render(RenderPack rp, PixelRect rect)

Parameters

rp RenderPack

rect PixelRect

UnderMouse(CoordinateRect)

public abstract AxisSpanUnderMouse? UnderMouse(CoordinateRect rect)

Parameters

rect CoordinateRect

Returns

AxisSpanUnderMouse