ScottPlot.Plottables.Callout Class Reference

Inheritance diagram for ScottPlot.Plottables.Callout:

Public Member Functions
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
Coordinates	CalculateClosestAttachPoint ()
	Calculates the attachment point on the label based on the closest distance from the given pixel location.
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
Text	LabelPlottable = new() { LabelPadding = 5 } [get]
Arrow	ArrowPlottable = new() [get]
override LabelStyle	LabelStyle [get, set]
string	Text [get, set]
ArrowStyle	ArrowStyle [get, set]
Color	ArrowLineColor [get, set]
float	ArrowLineWidth [get, set]
Color	ArrowFillColor [get, set]
float	ArrowMinimumLength [get, set]
float	ArrowMaximumLength [get, set]
float	ArrowOffset [get, set]
ArrowAnchor	ArrowAnchor [get, set]
float	ArrowWidth [get, set]
float	ArrowheadAxisLength [get, set]
float	ArrowheadLength [get, set]
float	ArrowheadWidth [get, set]
Color	ArrowColor [get, set]
Color	TextColor [get, set]
bool	Bold [get, set]
float	FontSize [get, set]
Color	TextBorderColor [get, set]
float	TextBorderWidth [get, set]
Color	TextBackgroundColor [get, set]
Coordinates	TextCoordinates [get, set]
Pixel	TextPixel [get]
Coordinates	TipCoordinates [get, set]
Pixel	TipPixel [get]
PixelRect	LastRenderRect [get]
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.
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.IHasArrow

Member Function Documentation

CalculateClosestAttachPoint()

Coordinates ScottPlot.Plottables.Callout.CalculateClosestAttachPoint ( )

inline

Calculates the attachment point on the label based on the closest distance from the given pixel location.

Returns

The coordinates of the attachment point on the label.

GetAxisLimits()

AxisLimits ScottPlot.Plottables.Callout.GetAxisLimits ( )

inline

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

Implements ScottPlot.IPlottable.

Render()

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

ArrowAnchor

ArrowAnchor ScottPlot.Plottables.Callout.ArrowAnchor

getset

Implements ScottPlot.IHasArrow.

ArrowColor

Color ScottPlot.Plottables.Callout.ArrowColor

getset

ArrowFillColor

Color ScottPlot.Plottables.Callout.ArrowFillColor

getset

Implements ScottPlot.IHasArrow.

ArrowheadAxisLength

float ScottPlot.Plottables.Callout.ArrowheadAxisLength

getset

Implements ScottPlot.IHasArrow.

ArrowheadLength

float ScottPlot.Plottables.Callout.ArrowheadLength

getset

Implements ScottPlot.IHasArrow.

ArrowheadWidth

float ScottPlot.Plottables.Callout.ArrowheadWidth

getset

Implements ScottPlot.IHasArrow.

ArrowLineColor

Color ScottPlot.Plottables.Callout.ArrowLineColor

getset

Implements ScottPlot.IHasArrow.

ArrowLineWidth

float ScottPlot.Plottables.Callout.ArrowLineWidth

getset

Implements ScottPlot.IHasArrow.

ArrowMaximumLength

float ScottPlot.Plottables.Callout.ArrowMaximumLength

getset

Implements ScottPlot.IHasArrow.

ArrowMinimumLength

float ScottPlot.Plottables.Callout.ArrowMinimumLength

getset

Implements ScottPlot.IHasArrow.

ArrowOffset

float ScottPlot.Plottables.Callout.ArrowOffset

getset

Implements ScottPlot.IHasArrow.

ArrowPlottable

Arrow ScottPlot.Plottables.Callout.ArrowPlottable = new()

get

ArrowStyle

ArrowStyle ScottPlot.Plottables.Callout.ArrowStyle

getset

Implements ScottPlot.IHasArrow.

ArrowWidth

float ScottPlot.Plottables.Callout.ArrowWidth

getset

Implements ScottPlot.IHasArrow.

Axes

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

Bold

bool ScottPlot.Plottables.Callout.Bold

getset

FontSize

float ScottPlot.Plottables.Callout.FontSize

getset

IsVisible

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

LabelPlottable

Text ScottPlot.Plottables.Callout.LabelPlottable = new() { LabelPadding = 5 }

get

LabelStyle

override LabelStyle ScottPlot.Plottables.Callout.LabelStyle

getset

Implements ScottPlot.IHasLabel.

LastRenderRect

PixelRect ScottPlot.Plottables.Callout.LastRenderRect

get

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.Callout.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

Text

string ScottPlot.Plottables.Callout.Text

getset

TextBackgroundColor

Color ScottPlot.Plottables.Callout.TextBackgroundColor

getset

TextBorderColor

Color ScottPlot.Plottables.Callout.TextBorderColor

getset

TextBorderWidth

float ScottPlot.Plottables.Callout.TextBorderWidth

getset

TextColor

Color ScottPlot.Plottables.Callout.TextColor

getset

TextCoordinates

Coordinates ScottPlot.Plottables.Callout.TextCoordinates

getset

TextPixel

Pixel ScottPlot.Plottables.Callout.TextPixel

get

TipCoordinates

Coordinates ScottPlot.Plottables.Callout.TipCoordinates

getset

TipPixel

Pixel ScottPlot.Plottables.Callout.TipPixel

get

---

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

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