ScottPlot.Plottables.AxisLine Class Reference

Inheritance diagram for ScottPlot.Plottables.AxisLine:

Public Member Functions
bool	IsUnderMouse (CoordinateRect rect)
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
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	RenderLast (RenderPack rp)
	Plottables that implement this interface have a second render method that runs after the axes are drawn, allowing graphics to be placed on top of the axes.

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.
LineStyle	LineStyle = new() { Width = 1 } [get, set]
float	LineWidth [get, set]
LinePattern	LinePattern [get, set]
Color	LineColor [get, set]
override LabelStyle	LabelStyle = new() [get, set]
string	Text [get, set]
string	LegendText = string.Empty [get, set]
	If populated, this text appears in the legend.
Alignment?	ManualLabelAlignment = null [get, set]
Alignment?	TextAlignment [get, set]
LabelStyle	Label [get, set]
float	FontSize [get, set]
bool	FontBold [get, set]
string	FontName [get, set]
Color	FontColor [get, set]
Color	TextColor [get, set]
Color	TextBackgroundColor [get, set]
float	TextRotation [get, set]
float	TextSize [get, set]
bool	LabelOppositeAxis = false [get, set]
bool	IsDraggable = false [get, set]
bool	ExcludeFromLegend = false [get, set]
bool	EnableAutoscale = true [get, set]
Color	Color [get, set]
double	Position = 0 [get, set]
IEnumerable< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
Properties inherited from ScottPlot.LabelStyleProperties
LabelStyle	LabelStyle [get, set]
float	LabelOffsetX [get, set]
float	LabelOffsetY [get, set]
float	LabelRotation [get, set]
float	LabelPadding [set]
PixelPadding	LabelPixelPadding [get, set]
PixelRect	LabelLastRenderPixelRect [get]
string	LabelText [get, set]
Alignment	LabelAlignment [get, set]
string	LabelFontName [get, set]
float	LabelFontSize [get, set]
float?	LabelLineSpacing [get, set]
bool	LabelItalic [get, set]
bool	LabelBold [get, set]
Color	LabelFontColor [get, set]
Color	LabelBackgroundColor [get, set]
float	LabelBorderRadius [get, set]
float	LabelBorderRadiusX [get, set]
float	LabelBorderRadiusY [get, set]
float	LabelBorderWidth [get, set]
Color	LabelBorderColor [get, set]
Color	LabelShadowColor [get, set]
PixelOffset	LabelShadowOffset [get, set]
Properties inherited from ScottPlot.IHasLabel
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasLine
Properties inherited from ScottPlot.IHasLegendText

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.AxisLine.GetAxisLimits ( )

abstract

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

Implements ScottPlot.IPlottable.

IsUnderMouse()

bool ScottPlot.Plottables.AxisLine.IsUnderMouse ( CoordinateRect  rect )

abstract

Render()

void ScottPlot.Plottables.AxisLine.Render ( RenderPack  rp )

abstract

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.

RenderLast()

void ScottPlot.Plottables.AxisLine.RenderLast ( RenderPack  rp )

abstract

Plottables that implement this interface have a second render method that runs after the axes are drawn, allowing graphics to be placed on top of the axes.

Implements ScottPlot.IRenderLast.

Property Documentation

Axes

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

Color

Color ScottPlot.Plottables.AxisLine.Color

getset

EnableAutoscale

bool ScottPlot.Plottables.AxisLine.EnableAutoscale = true

getset

ExcludeFromLegend

bool ScottPlot.Plottables.AxisLine.ExcludeFromLegend = false

getset

FontBold

bool ScottPlot.Plottables.AxisLine.FontBold

getset

FontColor

Color ScottPlot.Plottables.AxisLine.FontColor

getset

FontName

string ScottPlot.Plottables.AxisLine.FontName

getset

FontSize

float ScottPlot.Plottables.AxisLine.FontSize

getset

IsDraggable

bool ScottPlot.Plottables.AxisLine.IsDraggable = false

getset

IsVisible

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

Label

LabelStyle ScottPlot.Plottables.AxisLine.Label

getset

LabelOppositeAxis

bool ScottPlot.Plottables.AxisLine.LabelOppositeAxis = false

getset

LabelStyle

override LabelStyle ScottPlot.Plottables.AxisLine.LabelStyle = new()

getset

Implements ScottPlot.IHasLabel.

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.AxisLine.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LegendText

string ScottPlot.Plottables.AxisLine.LegendText = string.Empty

getset

If populated, this text appears in the legend.

Implements ScottPlot.IHasLegendText.

LineColor

Color ScottPlot.Plottables.AxisLine.LineColor

getset

Implements ScottPlot.IHasLine.

LinePattern

LinePattern ScottPlot.Plottables.AxisLine.LinePattern

getset

Implements ScottPlot.IHasLine.

LineStyle

LineStyle ScottPlot.Plottables.AxisLine.LineStyle = new() { Width = 1 }

getset

Implements ScottPlot.IHasLine.

LineWidth

float ScottPlot.Plottables.AxisLine.LineWidth

getset

Implements ScottPlot.IHasLine.

ManualLabelAlignment

Alignment? ScottPlot.Plottables.AxisLine.ManualLabelAlignment = null

getset

Position

double ScottPlot.Plottables.AxisLine.Position = 0

getset

Text

string ScottPlot.Plottables.AxisLine.Text

getset

TextAlignment

Alignment? ScottPlot.Plottables.AxisLine.TextAlignment

getset

TextBackgroundColor

Color ScottPlot.Plottables.AxisLine.TextBackgroundColor

getset

TextColor

Color ScottPlot.Plottables.AxisLine.TextColor

getset

TextRotation

float ScottPlot.Plottables.AxisLine.TextRotation

getset

TextSize

float ScottPlot.Plottables.AxisLine.TextSize

getset

---

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

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