ScottPlot.Plottables.TickModifierLabel Class Reference

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. More...

Inheritance diagram for ScottPlot.Plottables.TickModifierLabel:

Public Member Functions
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
	TickModifierLabel (IAxis axis)
virtual void	UpdateTickLabels ()
virtual void	Render (RenderPack rp)
	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.

Properties
bool	IsVisible = true [get, set]
	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).
IAxes	Axes = new Axes() [get, set]
	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.
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
LabelStyle	LabelStyle = new() [get]
IAxis	Axis [get]
	The axis this tick modifier will modify tick labels for.
Func< PixelRect, Pixel >	GetTextPixel [get, set]
	This logic determines where the text will be placed relative to the data area.
Func< int, string >	LabelFormatter = (x) => $"1e{x}" [get, set]
	This logic determines how to display the exponent as a string.
Properties inherited from ScottPlot.IPlottable

Detailed Description

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.

Constructor & Destructor Documentation

TickModifierLabel()

ScottPlot.Plottables.TickModifierLabel.TickModifierLabel ( IAxis  axis )

inline

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.TickModifierLabel.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

Render()

virtual void ScottPlot.Plottables.TickModifierLabel.Render ( RenderPack  rp )

inlinevirtual

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.

Implements ScottPlot.IPlottable.

UpdateTickLabels()

virtual void ScottPlot.Plottables.TickModifierLabel.UpdateTickLabels ( )

inlinevirtual

Property Documentation

Axes

IAxes ScottPlot.Plottables.TickModifierLabel.Axes = new Axes()

getset

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.

Implements ScottPlot.IPlottable.

Axis

IAxis ScottPlot.Plottables.TickModifierLabel.Axis

get

The axis this tick modifier will modify tick labels for.

GetTextPixel

Func<PixelRect, Pixel> ScottPlot.Plottables.TickModifierLabel.GetTextPixel

getset

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

IsVisible

bool ScottPlot.Plottables.TickModifierLabel.IsVisible = true

getset

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

Implements ScottPlot.IPlottable.

LabelFormatter

Func<int, string> ScottPlot.Plottables.TickModifierLabel.LabelFormatter = (x) => $"1e{x}"

getset

This logic determines how to display the exponent as a string.

LabelStyle

LabelStyle ScottPlot.Plottables.TickModifierLabel.LabelStyle = new()

get

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.TickModifierLabel.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

---

The documentation for this class was generated from the following file:

• ScottPlot/src/ScottPlot5/ScottPlot5/Plottables/TickModifierLabel.cs