A radial gauge chart is a graphical method of displaying scalar data in the form of a chart made of circular gauges so that each scalar is represented by each gauge. More...

Inheritance diagram for ScottPlot.Plottables.RadialGaugePlot:

Public Member Functions
	RadialGaugePlot (double[] levels, Color[] colors)

override string	ToString ()

void	Update (double[] levels, Color[]? colors=null)
	Replace gauge levels with new ones.

void	ValidateData (bool deep=false)

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.

Public Attributes
readonly FontStyle	Font = new()
	Describes labels drawn on each gauge.

Properties
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.

double[]	Levels = [] `[get]`
	This array holds the original levels passed-in by the user. These levels are used to calculate radial gauge positions on every render.

int	GaugeCount `[get]`
	Number of gauges.

double	MaximumAngle = 360 `[get, set]`
	Maximum size (degrees) for the gauge. 180 is a semicircle and 360 is a full circle.

bool	CircularBackground = true `[get, set]`
	Controls whether the backgrounds of the gauges are full circles or stop at the maximum angle.

string?[]	Labels `[get, set]`
	Labels that appear in the legend for each gauge. Number of labels must equal number of gauges. May be null if gauges are not to appear in the legend.

Color[]	Colors = [] `[get, set]`
	Colors for each gauge. Number of colors must equal number of gauges.

double	BackgroundTransparencyFraction = .15 `[get, set]`
	Describes how transparent the unfilled background of each gauge is (0 to 1). The larger the number the darker the background becomes.

bool	Clockwise = true `[get, set]`
	Indicates whether gauges fill clockwise as levels increase. If false, gauges will fill counter-clockwise (anti-clockwise).

RadialGaugeMode	GaugeMode = RadialGaugeMode.Stacked `[get, set]`
	Determines whether the gauges are drawn stacked (dafault value), sequentially, or as a single gauge (ressembling a pie plot).

bool	OrderInsideOut = true `[get, set]`
	Controls whether gauges will be dwan inside-out (true) or outside-in (false)

double	LabelPositionFraction = 1 `[get, set]`
	Defines where the gauge label is written on the gage as a fraction of its length. Low values place the label near the base and high values place the label at its tip.

float	StartingAngle = 270 `[get, set]`
	Angle (degrees) at which the gauges start. 270° for North (default value), 0° for East, 90° for South, 180° for West, etc. Expected values in the range [0°-360°], otherwise unexpected side-effects might happen.

double	SpaceFraction = .5f `[get, set]`
	The empty space between gauges as a fraction of the gauge width.

double	FontSizeFraction = .75 `[get, set]`
	Size of the gague label text as a fraction of the gauge width.

bool	ShowLevels = true `[get, set]`
	Controls if value labels are shown inside the gauges.

string	LevelTextFormat = "0.##" `[get, set]`
	String formatter to use for converting gauge levels to text.

SkiaSharp.SKStrokeCap	EndCap = SKStrokeCap.Round `[get, set]`
	Style of the tip of the gauge.

SkiaSharp.SKStrokeCap	StartCap = SKStrokeCap.Round `[get, set]`
	Style of the base of the gauge.

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).

int	XAxisIndex = 0 `[get, set]`

int	YAxisIndex = 0 `[get, set]`

IEnumerable< LegendItem >	LegendItems `[get]`
	Items which will appear in the legend.

Properties inherited from ScottPlot.IPlottable

Detailed Description

A radial gauge chart is a graphical method of displaying scalar data in the form of a chart made of circular gauges so that each scalar is represented by each gauge.

Constructor & Destructor Documentation

◆ RadialGaugePlot()

ScottPlot.Plottables.RadialGaugePlot.RadialGaugePlot	(	double[]	levels,
		Color[]	colors
	)

inline

Member Function Documentation

◆ GetAxisLimits()

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

◆ ToString()

override string ScottPlot.Plottables.RadialGaugePlot.ToString ( )

◆ Update()

void ScottPlot.Plottables.RadialGaugePlot.Update	(	double[]	levels,
		Color?[]	colors = `null`
	)

inline

Replace gauge levels with new ones.

◆ ValidateData()

void ScottPlot.Plottables.RadialGaugePlot.ValidateData ( bool deep = false )

inline

Member Data Documentation

◆ Font

readonly FontStyle ScottPlot.Plottables.RadialGaugePlot.Font = new()

Describes labels drawn on each gauge.

Property Documentation

◆ Axes

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

◆ BackgroundTransparencyFraction

double ScottPlot.Plottables.RadialGaugePlot.BackgroundTransparencyFraction = .15

getset

Describes how transparent the unfilled background of each gauge is (0 to 1). The larger the number the darker the background becomes.

◆ CircularBackground

bool ScottPlot.Plottables.RadialGaugePlot.CircularBackground = true

getset

Controls whether the backgrounds of the gauges are full circles or stop at the maximum angle.

◆ Clockwise

bool ScottPlot.Plottables.RadialGaugePlot.Clockwise = true

getset

Indicates whether gauges fill clockwise as levels increase. If false, gauges will fill counter-clockwise (anti-clockwise).

◆ Colors

Color [] ScottPlot.Plottables.RadialGaugePlot.Colors = []

getset

Colors for each gauge. Number of colors must equal number of gauges.

◆ EndCap

SkiaSharp.SKStrokeCap ScottPlot.Plottables.RadialGaugePlot.EndCap = SKStrokeCap.Round

getset

Style of the tip of the gauge.

◆ FontSizeFraction

double ScottPlot.Plottables.RadialGaugePlot.FontSizeFraction = .75

getset

Size of the gague label text as a fraction of the gauge width.

◆ GaugeCount

int ScottPlot.Plottables.RadialGaugePlot.GaugeCount

get

Number of gauges.

◆ GaugeMode

RadialGaugeMode ScottPlot.Plottables.RadialGaugePlot.GaugeMode = RadialGaugeMode.Stacked

getset

Determines whether the gauges are drawn stacked (dafault value), sequentially, or as a single gauge (ressembling a pie plot).

◆ IsVisible

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

◆ LabelPositionFraction

double ScottPlot.Plottables.RadialGaugePlot.LabelPositionFraction = 1

getset

Defines where the gauge label is written on the gage as a fraction of its length. Low values place the label near the base and high values place the label at its tip.

◆ Labels

string? [] ScottPlot.Plottables.RadialGaugePlot.Labels

getset

Labels that appear in the legend for each gauge. Number of labels must equal number of gauges. May be null if gauges are not to appear in the legend.

◆ LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.RadialGaugePlot.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

◆ Levels

double [] ScottPlot.Plottables.RadialGaugePlot.Levels = []

get

This array holds the original levels passed-in by the user. These levels are used to calculate radial gauge positions on every render.

◆ LevelTextFormat

string ScottPlot.Plottables.RadialGaugePlot.LevelTextFormat = "0.##"

getset

String formatter to use for converting gauge levels to text.

◆ MaximumAngle

double ScottPlot.Plottables.RadialGaugePlot.MaximumAngle = 360

getset

Maximum size (degrees) for the gauge. 180 is a semicircle and 360 is a full circle.

◆ OrderInsideOut

bool ScottPlot.Plottables.RadialGaugePlot.OrderInsideOut = true

getset

Controls whether gauges will be dwan inside-out (true) or outside-in (false)

◆ ShowLevels

bool ScottPlot.Plottables.RadialGaugePlot.ShowLevels = true

getset

Controls if value labels are shown inside the gauges.

◆ SpaceFraction

double ScottPlot.Plottables.RadialGaugePlot.SpaceFraction = .5f

getset

The empty space between gauges as a fraction of the gauge width.

◆ StartCap

SkiaSharp.SKStrokeCap ScottPlot.Plottables.RadialGaugePlot.StartCap = SKStrokeCap.Round

getset

Style of the base of the gauge.

◆ StartingAngle

float ScottPlot.Plottables.RadialGaugePlot.StartingAngle = 270

getset

Angle (degrees) at which the gauges start. 270° for North (default value), 0° for East, 90° for South, 180° for West, etc. Expected values in the range [0°-360°], otherwise unexpected side-effects might happen.

◆ XAxisIndex

int ScottPlot.Plottables.RadialGaugePlot.XAxisIndex = 0

getset

◆ YAxisIndex

int ScottPlot.Plottables.RadialGaugePlot.YAxisIndex = 0

getset

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

ScottPlot/src/ScottPlot5/ScottPlot5/Plottables/RadialGaugePlot.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RadialGaugePlot()

Member Function Documentation

◆ GetAxisLimits()

◆ Render()

◆ ToString()

◆ Update()

◆ ValidateData()

Member Data Documentation

◆ Font

Property Documentation

◆ Axes

◆ BackgroundTransparencyFraction

◆ CircularBackground

◆ Clockwise

◆ Colors

◆ EndCap

◆ FontSizeFraction

◆ GaugeCount

◆ GaugeMode

◆ IsVisible

◆ LabelPositionFraction

◆ Labels

◆ LegendItems

◆ Levels

◆ LevelTextFormat

◆ MaximumAngle

◆ OrderInsideOut

◆ ShowLevels

◆ SpaceFraction

◆ StartCap

◆ StartingAngle

◆ XAxisIndex

◆ YAxisIndex