Class AxisLine

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public abstract class AxisLine : LabelStyleProperties, IPlottable, IRenderLast, IHasLine, IHasLegendText

Inheritance

object

LabelStyleProperties

AxisLine

Implements

IPlottable

IRenderLast

IHasLine

IHasLegendText

Derived

HorizontalLine

VerticalLine

Inherited Members

LabelStyleProperties.LabelOffsetX

LabelStyleProperties.LabelOffsetY

LabelStyleProperties.LabelRotation

LabelStyleProperties.LabelPadding

LabelStyleProperties.LabelPixelPadding

LabelStyleProperties.LabelLastRenderPixelRect

LabelStyleProperties.LabelText

LabelStyleProperties.LabelAlignment

LabelStyleProperties.LabelFontName

LabelStyleProperties.LabelFontSize

LabelStyleProperties.LabelLineSpacing

LabelStyleProperties.LabelItalic

LabelStyleProperties.LabelBold

LabelStyleProperties.LabelUnderline

LabelStyleProperties.LabelUnderlineWidth

LabelStyleProperties.LabelUnderlineOffset

LabelStyleProperties.LabelFontColor

LabelStyleProperties.LabelBackgroundColor

LabelStyleProperties.LabelBorderRadius

LabelStyleProperties.LabelBorderRadiusX

LabelStyleProperties.LabelBorderRadiusY

LabelStyleProperties.LabelBorderWidth

LabelStyleProperties.LabelBorderColor

LabelStyleProperties.LabelShadowColor

LabelStyleProperties.LabelShadowOffset

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

Color

public Color Color { get; set; }

Property Value

Color

EnableAutoscale

public bool EnableAutoscale { get; set; }

Property Value

bool

ExcludeFromLegend

public bool ExcludeFromLegend { get; set; }

Property Value

bool

FontBold

[Obsolete("Use LabelBold")]
public bool FontBold { get; set; }

Property Value

bool

FontColor

[Obsolete("Use LabelFontColor")]
public Color FontColor { get; set; }

Property Value

Color

FontName

[Obsolete("Use LabelFontName")]
public string FontName { get; set; }

Property Value

string

FontSize

[Obsolete("Use LabelFontSize")]
public float FontSize { get; set; }

Property Value

float

IsDraggable

public bool IsDraggable { 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 LabelFontSize, LabelBold, LabelFontColor, or properties of the LabelStyle object.")]
public LabelStyle Label { get; set; }

Property Value

LabelStyle

LabelOppositeAxis

public bool LabelOppositeAxis { get; set; }

Property Value

bool

LabelStyle

public override LabelStyle LabelStyle { 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

ManualLabelAlignment

public Alignment? ManualLabelAlignment { get; set; }

Property Value

Alignment?

Position

public double Position { get; set; }

Property Value

double

Text

public string Text { get; set; }

Property Value

string

TextAlignment

[Obsolete("Use ManualLabelAlignment")]
public Alignment? TextAlignment { get; set; }

Property Value

Alignment?

TextBackgroundColor

[Obsolete("Use LabelFontColor")]
public Color TextBackgroundColor { get; set; }

Property Value

Color

TextColor

[Obsolete("Use LabelFontColor")]
public Color TextColor { get; set; }

Property Value

Color

TextRotation

[Obsolete("Use LabelRotation")]
public float TextRotation { get; set; }

Property Value

float

TextSize

[Obsolete("Use LabelFontSize")]
public float TextSize { get; set; }

Property Value

float

Methods

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

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

Parameters

rp RenderPack