Class TickModifierLabel

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

This plottable contains logic to modify tick labels to display them using scientific notation with a multiplier displaed as text placed just outside the corner of the data area.

public class TickModifierLabel : IPlottable

Inheritance

object

TickModifierLabel

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

TickModifierLabel(IAxis)

public TickModifierLabel(IAxis axis)

Parameters

axis IAxis

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

Axis

The axis this tick modifier will modify tick labels for

public IAxis Axis { get; }

Property Value

IAxis

GetTextPixel

This logic determines where the text will be placed relative to the data area

public Func<PixelRect, Pixel> GetTextPixel { get; set; }

Property Value

Func<PixelRect, Pixel>

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

LabelFormatter

This logic determines how to display the exponent as a string

public Func<int, string> LabelFormatter { get; set; }

Property Value

Func<int, string>

LabelStyle

public LabelStyle LabelStyle { get; }

Property Value

LabelStyle

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

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

UpdateTickLabels()

public virtual void UpdateTickLabels()