A polar axes uses spoke lines and circles to describe a polar coordinate system where points are represented by a radius and angle. This class draws a polar axes and has options to customize spokes and circles. More...

Inheritance diagram for ScottPlot.Plottables.SmithChartAxis:

Classes
class	ImaginaryTick

class	RealTick

Public Member Functions
RealTick	AddRealTick (double value)

ImaginaryTick	AddImaginaryTick (double value)

Coordinates	GetCoordinates (double radius, Angle angle)
	Return the X/Y position of a point defined in polar space.

Coordinates	GetCoordinates (PolarCoordinates point)
	Return the X/Y position of a point defined in polar space.

Coordinates	GetCoordinates (double resistance, double reactance)
	Return the X/Y position of the given impedance.

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

virtual void	UpdateAxisLimits (Plot plot)

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.

Static Public Member Functions
static Coordinates	CalculateGamma (Coordinates normalizedImpedance)

static IEnumerable< Coordinates >	FindIntersectionPoints (Coordinates pt1, double r1, Coordinates pt2, double r2)

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.

List< RealTick >	RealTicks = [] `[get]`
	Concentric circular tick lines.

List< ImaginaryTick >	ImaginaryTicks = [] `[get]`
	Curves extending from the right side of the outer circle to various points around its circumference.

Angle	Rotation = Angle.FromDegrees(0) `[get, set]`
	Rotates the axis clockwise from its default position (where 0 points right)

bool	ManageAxisLimits = true `[get, set]`
	Enable this to modify the axis limits at render time to achieve "square axes" where the units/px values are equal for horizontal and vertical axes, allowing circles to always appear as circles instead of ellipses.

LineStyle	RealLineStyle `[get, set]`
	Default style of the curved lines extending from the right edge to points around the circumference of the chart outline.

LineStyle	Imaginary `[get, set]`
	Default style of the concentric circular axis lines.

LabelStyle	LabelStyle = new() `[get]`

string?	LabelText = null `[get, set]`

double	LabelPaddingFraction = 0.1 `[get, set]`
	Distance to offset label text.

Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IManagesAxisLimits

Detailed Description

A polar axes uses spoke lines and circles to describe a polar coordinate system where points are represented by a radius and angle. This class draws a polar axes and has options to customize spokes and circles.

Member Function Documentation

◆ AddImaginaryTick()

ImaginaryTick ScottPlot.Plottables.SmithChartAxis.AddImaginaryTick ( double value )

inline

◆ AddRealTick()

RealTick ScottPlot.Plottables.SmithChartAxis.AddRealTick ( double value )

inline

◆ CalculateGamma()

static Coordinates ScottPlot.Plottables.SmithChartAxis.CalculateGamma ( Coordinates normalizedImpedance )

inlinestatic

◆ FindIntersectionPoints()

static IEnumerable< Coordinates > ScottPlot.Plottables.SmithChartAxis.FindIntersectionPoints	(	Coordinates	pt1,
		double	r1,
		Coordinates	pt2,
		double	r2
	)

inlinestatic

◆ GetAxisLimits()

AxisLimits ScottPlot.Plottables.SmithChartAxis.GetAxisLimits ( )

inline

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

Implements ScottPlot.IPlottable.

◆ GetCoordinates() [1/3]

Coordinates ScottPlot.Plottables.SmithChartAxis.GetCoordinates	(	double	radius,
		Angle	angle
	)

inline

Return the X/Y position of a point defined in polar space.

◆ GetCoordinates() [2/3]

Coordinates ScottPlot.Plottables.SmithChartAxis.GetCoordinates	(	double	resistance,
		double	reactance
	)

inline

Return the X/Y position of the given impedance.

◆ GetCoordinates() [3/3]

Coordinates ScottPlot.Plottables.SmithChartAxis.GetCoordinates ( PolarCoordinates point )

inline

Return the X/Y position of a point defined in polar space.

◆ Render()

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

◆ UpdateAxisLimits()

virtual void ScottPlot.Plottables.SmithChartAxis.UpdateAxisLimits ( Plot plot )

inlinevirtual

Implements ScottPlot.IManagesAxisLimits.

Property Documentation

◆ Axes

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

◆ Imaginary

LineStyle ScottPlot.Plottables.SmithChartAxis.Imaginary

getset

Initial value:

= new()
    {
        Width = 1,
        Color = Colors.Black.WithAlpha(.2),
    }

Default style of the concentric circular axis lines.

◆ ImaginaryTicks

List<ImaginaryTick> ScottPlot.Plottables.SmithChartAxis.ImaginaryTicks = []

get

Curves extending from the right side of the outer circle to various points around its circumference.

◆ IsVisible

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

◆ LabelPaddingFraction

double ScottPlot.Plottables.SmithChartAxis.LabelPaddingFraction = 0.1

getset

Distance to offset label text.

◆ LabelStyle

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

get

◆ LabelText

string? ScottPlot.Plottables.SmithChartAxis.LabelText = null

getset

◆ LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.SmithChartAxis.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

◆ ManageAxisLimits

bool ScottPlot.Plottables.SmithChartAxis.ManageAxisLimits = true

getset

Enable this to modify the axis limits at render time to achieve "square axes" where the units/px values are equal for horizontal and vertical axes, allowing circles to always appear as circles instead of ellipses.

Implements ScottPlot.IManagesAxisLimits.

◆ RealLineStyle

LineStyle ScottPlot.Plottables.SmithChartAxis.RealLineStyle

getset

Initial value:

= new()
    {
        Width = 1,
        Color = Colors.Black.WithAlpha(.2),
    }

Default style of the curved lines extending from the right edge to points around the circumference of the chart outline.

◆ RealTicks

List<RealTick> ScottPlot.Plottables.SmithChartAxis.RealTicks = []

get

Concentric circular tick lines.

◆ Rotation

Angle ScottPlot.Plottables.SmithChartAxis.Rotation = Angle.FromDegrees(0)

getset

Rotates the axis clockwise from its default position (where 0 points right)

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

ScottPlot/src/ScottPlot5/ScottPlot5/Plottables/SmithChartAxis.cs

Classes

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddImaginaryTick()

◆ AddRealTick()

◆ CalculateGamma()

◆ FindIntersectionPoints()

◆ GetAxisLimits()

◆ GetCoordinates() [1/3]

◆ GetCoordinates() [2/3]

◆ GetCoordinates() [3/3]

◆ Render()

◆ UpdateAxisLimits()

Property Documentation

◆ Axes

◆ Imaginary

◆ ImaginaryTicks

◆ IsVisible

◆ LabelPaddingFraction

◆ LabelStyle

◆ LabelText

◆ LegendItems

◆ ManageAxisLimits

◆ RealLineStyle

◆ RealTicks

◆ Rotation