Class ScaleBar

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public class ScaleBar : IPlottable, IHasLine

Inheritance

object

ScaleBar

Implements

IPlottable

IHasLine

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

EdgePadding

Distance of the corner of the scalebar from the corner of the data area

public PixelPadding EdgePadding { get; set; }

Property Value

PixelPadding

Height

public double Height { get; set; }

Property Value

double

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

LabelPadding

Padding to add between labels and scalebar lines

public PixelPadding LabelPadding { get; set; }

Property Value

PixelPadding

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

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

Width

public double Width { get; set; }

Property Value

double

XLabel

public string XLabel { get; set; }

Property Value

string

XLabelStyle

public LabelStyle XLabelStyle { get; set; }

Property Value

LabelStyle

YLabel

public string YLabel { get; set; }

Property Value

string

YLabelStyle

public LabelStyle YLabelStyle { get; set; }

Property Value

LabelStyle

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