Class FloatingAxis

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

This plottable renders an axis line, ticks, and tick labels inside the data area

public class FloatingAxis : IPlottable

Inheritance

object

FloatingAxis

Implements

IPlottable

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

Constructors

FloatingAxis(IXAxis)

public FloatingAxis(IXAxis axis)

Parameters

axis IXAxis

FloatingAxis(IYAxis)

public FloatingAxis(IYAxis axis)

Parameters

axis IYAxis

Fields

Position

public double Position

Field Value

double

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

IsVertical

public bool IsVertical { get; }

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

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

TickGenerator

public ITickGenerator TickGenerator { get; }

Property Value

ITickGenerator

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

RenderHorizontalAxis(RenderPack)

public void RenderHorizontalAxis(RenderPack rp)

Parameters

rp RenderPack

RenderVerticalAxis(RenderPack)

public void RenderVerticalAxis(RenderPack rp)

Parameters

rp RenderPack