ScottPlot.Plottables.Annotation Class Reference

Inheritance diagram for ScottPlot.Plottables.Annotation:

Public Member Functions
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
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.
override LabelStyle	LabelStyle = new() { ShadowColor = Colors.Black.WithAlpha(.2) } [get, set]
LabelStyle	Label [get, set]
string	Text [get, set]
Alignment	Alignment = Alignment.UpperLeft [get, set]
PixelOffset	PixelOffset = new(10, 10) [get, set]
float	OffsetX [get, set]
float	OffsetY [get, set]
FractionRect	FractionRect = FractionRect.Full [get, set]
	The annotation will be placed inside this fractional portion of the data area according to Alignment and PixelOffset
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

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.Annotation.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

Render()

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

Property Documentation

Alignment

Alignment ScottPlot.Plottables.Annotation.Alignment = Alignment.UpperLeft

getset

Axes

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

FractionRect

FractionRect ScottPlot.Plottables.Annotation.FractionRect = FractionRect.Full

getset

The annotation will be placed inside this fractional portion of the data area according to Alignment and PixelOffset

IsVisible

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

getset

LabelStyle

override LabelStyle ScottPlot.Plottables.Annotation.LabelStyle = new() { ShadowColor = Colors.Black.WithAlpha(.2) }

getset

Implements ScottPlot.IHasLabel.

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.Annotation.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

OffsetX

float ScottPlot.Plottables.Annotation.OffsetX

getset

OffsetY

float ScottPlot.Plottables.Annotation.OffsetY

getset

PixelOffset

PixelOffset ScottPlot.Plottables.Annotation.PixelOffset = new(10, 10)

getset

Text

string ScottPlot.Plottables.Annotation.Text

getset

---

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

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