ScottPlot.Plottables.FloatingAxis Class Reference

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

Inheritance diagram for ScottPlot.Plottables.FloatingAxis:

Public Member Functions
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
	FloatingAxis (IXAxis axis)
	FloatingAxis (IYAxis axis)
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.
void	RenderVerticalAxis (RenderPack rp)
void	RenderHorizontalAxis (RenderPack rp)

Public Attributes
double	Position = 0.5

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.
bool	IsVertical [get]
ITickGenerator	TickGenerator [get]
Properties inherited from ScottPlot.IPlottable

Detailed Description

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

Constructor & Destructor Documentation

FloatingAxis() [1/2]

ScottPlot.Plottables.FloatingAxis.FloatingAxis ( IXAxis  axis )

inline

FloatingAxis() [2/2]

ScottPlot.Plottables.FloatingAxis.FloatingAxis ( IYAxis  axis )

inline

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.FloatingAxis.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

Render()

virtual void ScottPlot.Plottables.FloatingAxis.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.

RenderHorizontalAxis()

void ScottPlot.Plottables.FloatingAxis.RenderHorizontalAxis ( RenderPack  rp )

inline

RenderVerticalAxis()

void ScottPlot.Plottables.FloatingAxis.RenderVerticalAxis ( RenderPack  rp )

inline

Member Data Documentation

Position

double ScottPlot.Plottables.FloatingAxis.Position = 0.5

Property Documentation

Axes

IAxes ScottPlot.Plottables.FloatingAxis.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.

IsVertical

bool ScottPlot.Plottables.FloatingAxis.IsVertical

get

IsVisible

bool ScottPlot.Plottables.FloatingAxis.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.

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.FloatingAxis.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

TickGenerator

ITickGenerator ScottPlot.Plottables.FloatingAxis.TickGenerator

get

---

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

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