ScottPlot.Plottables.Phasor Class Reference

A Phasor plot marks a collection of points in polar space using an arrow with its base centered at the origin. More...

Inheritance diagram for ScottPlot.Plottables.Phasor:

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
List< PolarCoordinates >	Points = [] [get]
	A collection of points in polar space.
List< string >	Labels = [] [get]
	If populated, Points will be labeled with these strings.
LabelStyle	LabelStyle = new() [get]
	Style for arrow labels defined in Labels
double	PaddingFraction = 0.01 [get, set]
	Additional padding given to accommodate spoke labels.
double	PaddingArc = 5 [get, set]
	Additional padding given to accommodate labels.
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.
string	LegendText = string.Empty [get, set]
	If populated, this text appears in the legend.
ArrowStyle	ArrowStyle = new() { LineWidth = 2, ArrowWidth = 3 } [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]
IArrowShape	ArrowShape = new ArrowShapes.Single() [get, set]
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasArrow
Properties inherited from ScottPlot.IHasLegendText

Detailed Description

A Phasor plot marks a collection of points in polar space using an arrow with its base centered at the origin.

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.Phasor.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.Phasor.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.Phasor.ArrowAnchor

getset

Implements ScottPlot.IHasArrow.

ArrowFillColor

Color ScottPlot.Plottables.Phasor.ArrowFillColor

getset

Implements ScottPlot.IHasArrow.

ArrowheadAxisLength

float ScottPlot.Plottables.Phasor.ArrowheadAxisLength

getset

Implements ScottPlot.IHasArrow.

ArrowheadLength

float ScottPlot.Plottables.Phasor.ArrowheadLength

getset

Implements ScottPlot.IHasArrow.

ArrowheadWidth

float ScottPlot.Plottables.Phasor.ArrowheadWidth

getset

Implements ScottPlot.IHasArrow.

ArrowLineColor

Color ScottPlot.Plottables.Phasor.ArrowLineColor

getset

Implements ScottPlot.IHasArrow.

ArrowLineWidth

float ScottPlot.Plottables.Phasor.ArrowLineWidth

getset

Implements ScottPlot.IHasArrow.

ArrowMaximumLength

float ScottPlot.Plottables.Phasor.ArrowMaximumLength

getset

Implements ScottPlot.IHasArrow.

ArrowMinimumLength

float ScottPlot.Plottables.Phasor.ArrowMinimumLength

getset

Implements ScottPlot.IHasArrow.

ArrowOffset

float ScottPlot.Plottables.Phasor.ArrowOffset

getset

Implements ScottPlot.IHasArrow.

ArrowShape

IArrowShape ScottPlot.Plottables.Phasor.ArrowShape = new ArrowShapes.Single()

getset

ArrowStyle

ArrowStyle ScottPlot.Plottables.Phasor.ArrowStyle = new() { LineWidth = 2, ArrowWidth = 3 }

getset

Implements ScottPlot.IHasArrow.

ArrowWidth

float ScottPlot.Plottables.Phasor.ArrowWidth

getset

Implements ScottPlot.IHasArrow.

Axes

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

IsVisible

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

Labels

List<string> ScottPlot.Plottables.Phasor.Labels = []

get

If populated, Points will be labeled with these strings.

LabelStyle

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

get

Style for arrow labels defined in Labels

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.Phasor.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LegendText

string ScottPlot.Plottables.Phasor.LegendText = string.Empty

getset

If populated, this text appears in the legend.

Implements ScottPlot.IHasLegendText.

PaddingArc

double ScottPlot.Plottables.Phasor.PaddingArc = 5

getset

Additional padding given to accommodate labels.

PaddingFraction

double ScottPlot.Plottables.Phasor.PaddingFraction = 0.01

getset

Additional padding given to accommodate spoke labels.

Points

List<PolarCoordinates> ScottPlot.Plottables.Phasor.Points = []

get

A collection of points in polar space.

---

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

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