Class IgbRadialGauge

A radial gauge for displaying a single value on a defined scale.

Inheritance
System.Object
BaseRendererControl
IgbRadialGauge
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbRadialGauge : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbRadialGauge()

Declaration
public IgbRadialGauge()

Properties

ActualLabelFormatSpecifiers

Declaration
public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; }
Property Value
Type Description
IgbFormatSpecifierCollection

ActualMaximumValue

Gets the resolved maximum value of the scale.

Declaration
public double ActualMaximumValue { get; set; }
Property Value
Type Description
System.Double

ActualMaximumValueChanged

Declaration
public Action<double> ActualMaximumValueChanged { get; set; }
Property Value
Type Description
System.Action<System.Double>

ActualMaximumValueChangedScript

Declaration
public string ActualMaximumValueChangedScript { get; set; }
Property Value
Type Description
System.String

ActualMinimumValue

Gets the resolved minimum value of the scale.

Declaration
public double ActualMinimumValue { get; set; }
Property Value
Type Description
System.Double

ActualMinimumValueChanged

Declaration
public Action<double> ActualMinimumValueChanged { get; set; }
Property Value
Type Description
System.Action<System.Double>

ActualMinimumValueChangedScript

Declaration
public string ActualMinimumValueChangedScript { get; set; }
Property Value
Type Description
System.String

ActualPixelScalingRatio

Gets the actual pixel scaling ratio used to affect the pixel density of the control.

Declaration
public double ActualPixelScalingRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

ActualRanges

Declaration
public IgbRadialGaugeRangeCollection ActualRanges { get; }
Property Value
Type Description
IgbRadialGaugeRangeCollection

AlignLabel

Declaration
public EventCallback<IgbAlignRadialGaugeLabelEventArgs> AlignLabel { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbAlignRadialGaugeLabelEventArgs>

AlignLabelScript

Declaration
public string AlignLabelScript { get; set; }
Property Value
Type Description
System.String

BackingBrush

Gets or sets the brush to use to fill the backing of the gauge.

Declaration
public string BackingBrush { get; set; }
Property Value
Type Description
System.String

BackingCornerRadius

Gets or sets the corner rounding radius to use for the fitted scale backings.

Declaration
public double BackingCornerRadius { get; set; }
Property Value
Type Description
System.Double

BackingInnerExtent

Gets or sets the inner extent of the gauge backing.

Declaration
public double BackingInnerExtent { get; set; }
Property Value
Type Description
System.Double

BackingOuterExtent

Gets or sets the outer extent of the gauge backing.

Declaration
public double BackingOuterExtent { get; set; }
Property Value
Type Description
System.Double

BackingOutline

Gets or sets the brush to use for the outline of the backing.

Declaration
public string BackingOutline { get; set; }
Property Value
Type Description
System.String

BackingOversweep

Gets or sets the over sweep angle to apply to the backing if it is displaying fitted (in degrees). Must be greater or equal to 0.

Declaration
public double BackingOversweep { get; set; }
Property Value
Type Description
System.Double

BackingShape

Gets or sets the type of shape to use for the backing of the gauge.

Declaration
public RadialGaugeBackingShape BackingShape { get; set; }
Property Value
Type Description
RadialGaugeBackingShape

BackingStrokeThickness

Gets or sets the stroke thickness of the backing outline.

Declaration
public double BackingStrokeThickness { get; set; }
Property Value
Type Description
System.Double

CenterX

Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1.

Declaration
public double CenterX { get; set; }
Property Value
Type Description
System.Double

CenterY

Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1.

Declaration
public double CenterY { get; set; }
Property Value
Type Description
System.Double

ContentLabelFormatSpecifiers

Declaration
public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }
Property Value
Type Description
IgbFormatSpecifierCollection

ContentRanges

Declaration
public IgbRadialGaugeRangeCollection ContentRanges { get; }
Property Value
Type Description
IgbRadialGaugeRangeCollection

DuplicateLabelOmissionStrategy

Gets or sets the strategy to use for omitting labels if the first and last label have the same value.

Declaration
public RadialGaugeDuplicateLabelOmissionStrategy DuplicateLabelOmissionStrategy { get; set; }
Property Value
Type Description
RadialGaugeDuplicateLabelOmissionStrategy

Font

Gets or sets the font.

Declaration
public string Font { get; set; }
Property Value
Type Description
System.String

FontBrush

Gets or sets the brush to use for the label font.

Declaration
public string FontBrush { get; set; }
Property Value
Type Description
System.String

FormatLabel

Declaration
public EventCallback<IgbFormatRadialGaugeLabelEventArgs> FormatLabel { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbFormatRadialGaugeLabelEventArgs>

FormatLabelScript

Declaration
public string FormatLabelScript { get; set; }
Property Value
Type Description
System.String

Interval

Gets or sets the interval to use for the scale.

Declaration
public double Interval { get; set; }
Property Value
Type Description
System.Double

IsNeedleDraggingConstrained

Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging.

Declaration
public bool IsNeedleDraggingConstrained { get; set; }
Property Value
Type Description
System.Boolean

IsNeedleDraggingEnabled

Gets or sets whether needle dragging is enabled or not.

Declaration
public bool IsNeedleDraggingEnabled { get; set; }
Property Value
Type Description
System.Boolean

LabelExtent

Gets or sets the position at which to put the labels as a value from 0 to 1, measured form the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double LabelExtent { get; set; }
Property Value
Type Description
System.Double

LabelFormat

Gets or sets the label composite format used when creating label values.

Declaration
public string LabelFormat { get; set; }
Property Value
Type Description
System.String

LabelFormatSpecifiers

Gets or sets the format specifiers to use with the LabelFormat string.

Declaration
public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

LabelInterval

Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale.

Declaration
public double LabelInterval { get; set; }
Property Value
Type Description
System.Double

MaximumValue

Gets or sets the maximum value of the scale.

Declaration
public double MaximumValue { get; set; }
Property Value
Type Description
System.Double

MinimumValue

Gets or sets the minimum value of the scale.

Declaration
public double MinimumValue { get; set; }
Property Value
Type Description
System.Double

MinorTickBrush

Gets or sets the brush to use for the minor tickmarks.

Declaration
public string MinorTickBrush { get; set; }
Property Value
Type Description
System.String

MinorTickCount

Gets or sets the number of minor tickmarks to place between major tickmarks.

Declaration
public double MinorTickCount { get; set; }
Property Value
Type Description
System.Double

MinorTickEndExtent

Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double MinorTickEndExtent { get; set; }
Property Value
Type Description
System.Double

MinorTickStartExtent

Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double MinorTickStartExtent { get; set; }
Property Value
Type Description
System.Double

MinorTickStrokeThickness

Gets or sets the stroke thickness to use when rendering minor ticks.

Declaration
public double MinorTickStrokeThickness { get; set; }
Property Value
Type Description
System.Double

NeedleBaseFeatureExtent

Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedleBaseFeatureExtent { get; set; }
Property Value
Type Description
System.Double

NeedleBaseFeatureWidthRatio

Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedleBaseFeatureWidthRatio { get; set; }
Property Value
Type Description
System.Double

NeedleBrush

Gets or sets the brush to use when rendering the fill of the needle.

Declaration
public string NeedleBrush { get; set; }
Property Value
Type Description
System.String

NeedleEndExtent

Gets or sets the extent (from -1 to 1) at which to end rendering the needle, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedleEndExtent { get; set; }
Property Value
Type Description
System.Double

NeedleEndWidthRatio

Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedleEndWidthRatio { get; set; }
Property Value
Type Description
System.Double

NeedleOutline

Gets or sets the brush to use when rendering the outline of the needle.

Declaration
public string NeedleOutline { get; set; }
Property Value
Type Description
System.String

NeedlePivotBrush

Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes.

Declaration
public string NeedlePivotBrush { get; set; }
Property Value
Type Description
System.String

NeedlePivotInnerWidthRatio

Gets or sets the width of the inner cutout section of the needle cap with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle that has a cutout section.

Declaration
public double NeedlePivotInnerWidthRatio { get; set; }
Property Value
Type Description
System.Double

NeedlePivotOutline

Gets or sets the brush to use for the outlines of the needle cap.

Declaration
public string NeedlePivotOutline { get; set; }
Property Value
Type Description
System.String

NeedlePivotShape

Gets or sets the shape to use for the needle cap.

Declaration
public RadialGaugePivotShape NeedlePivotShape { get; set; }
Property Value
Type Description
RadialGaugePivotShape

NeedlePivotStrokeThickness

Gets or sets the stroke thickness to use for the outline of the needle cap.

Declaration
public double NeedlePivotStrokeThickness { get; set; }
Property Value
Type Description
System.Double

NeedlePivotWidthRatio

Gets or sets the width of the cap of the needle with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedlePivotWidthRatio { get; set; }
Property Value
Type Description
System.Double

NeedlePointFeatureExtent

Gets or sets the extent of the feature which is closest to the point (e.g. the tapering point of a needle) with a value from -1 to 1. Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedlePointFeatureExtent { get; set; }
Property Value
Type Description
System.Double

NeedlePointFeatureWidthRatio

Gets or sets the width of the needle at its feature which is closest to the point (e.g. the tapering point of a needle) with a value from 0 to 1. Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedlePointFeatureWidthRatio { get; set; }
Property Value
Type Description
System.Double

NeedleShape

Gets or sets the shape to use when rendering the needle from a number of options.

Declaration
public RadialGaugeNeedleShape NeedleShape { get; set; }
Property Value
Type Description
RadialGaugeNeedleShape

NeedleStartExtent

Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedleStartExtent { get; set; }
Property Value
Type Description
System.Double

NeedleStartWidthRatio

Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double NeedleStartWidthRatio { get; set; }
Property Value
Type Description
System.Double

NeedleStrokeThickness

Gets or sets the stroke thickness of the needle outline.

Declaration
public double NeedleStrokeThickness { get; set; }
Property Value
Type Description
System.Double

ParentTypeName

Declaration
protected override string ParentTypeName { get; }
Property Value
Type Description
System.String
Overrides

PixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control.

Declaration
public double PixelScalingRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

RadiusMultiplier

Gets or sets the multiplying factor to apply to the normal radius of the gauge. The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. This introduces a multiplicative factor to that value.

Declaration
public double RadiusMultiplier { get; set; }
Property Value
Type Description
System.Double

RangeBrushes

Gets or sets a collection of brushes to be used as the palette for gauge ranges.

Declaration
public string RangeBrushes { get; set; }
Property Value
Type Description
System.String

RangeOutlines

Gets or sets a collection of brushes to be used as the palette for gauge outlines.

Declaration
public string RangeOutlines { get; set; }
Property Value
Type Description
System.String

Ranges

Gets or sets the ranges to render on the gauge.

Declaration
public IgbRadialGaugeRangeCollection Ranges { get; set; }
Property Value
Type Description
IgbRadialGaugeRangeCollection

ScaleBrush

Gets or sets the brush to use to fill the background of the scale.

Declaration
public string ScaleBrush { get; set; }
Property Value
Type Description
System.String

ScaleEndAngle

Gets or sets the end angle for the scale in degrees.

Declaration
public double ScaleEndAngle { get; set; }
Property Value
Type Description
System.Double

ScaleEndExtent

Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double ScaleEndExtent { get; set; }
Property Value
Type Description
System.Double

ScaleOversweep

Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0.

Declaration
public double ScaleOversweep { get; set; }
Property Value
Type Description
System.Double

ScaleOversweepShape

Gets or sets the oversweep shape to use for the excess fill area for the scale.

Declaration
public RadialGaugeScaleOversweepShape ScaleOversweepShape { get; set; }
Property Value
Type Description
RadialGaugeScaleOversweepShape

ScaleStartAngle

Gets or sets the start angle for the scale in degrees.

Declaration
public double ScaleStartAngle { get; set; }
Property Value
Type Description
System.Double

ScaleStartExtent

Gets or sets the position at which to start rendering the scale, measured from the center of the gauge as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double ScaleStartExtent { get; set; }
Property Value
Type Description
System.Double

ScaleSweepDirection

Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle.

Declaration
public SweepDirection ScaleSweepDirection { get; set; }
Property Value
Type Description
SweepDirection

TickBrush

Gets or sets the brush to use for the major tickmarks.

Declaration
public string TickBrush { get; set; }
Property Value
Type Description
System.String

TickEndExtent

Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double TickEndExtent { get; set; }
Property Value
Type Description
System.Double

TickStartExtent

Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

Declaration
public double TickStartExtent { get; set; }
Property Value
Type Description
System.Double

TickStrokeThickness

Gets or sets the stroke thickness to use when rendering ticks.

Declaration
public double TickStrokeThickness { get; set; }
Property Value
Type Description
System.Double

TransitionDuration

Gets or sets the number of milliseconds over which changes to the gauge should be animated.

Declaration
public int TransitionDuration { get; set; }
Property Value
Type Description
System.Int32

TransitionProgress

Gets the transition progress of the animation when the control is animating.

Declaration
public double TransitionProgress { get; set; }
Property Value
Type Description
System.Double

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Value

Gets or sets the value at which to point the needle of the gauge.

Declaration
public double Value { get; set; }
Property Value
Type Description
System.Double

ValueChanged

Declaration
public Action<IgbDoubleValueChangedEventArgs> ValueChanged { get; set; }
Property Value
Type Description
System.Action<IgbDoubleValueChangedEventArgs>

ValueChangedScript

Declaration
public string ValueChangedScript { get; set; }
Property Value
Type Description
System.String

Methods

ContainerResized()

Declaration
public void ContainerResized()

ContainerResizedAsync()

Declaration
public Task ContainerResizedAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

ExportSerializedVisualData()

Declaration
public string ExportSerializedVisualData()
Returns
Type Description
System.String

ExportSerializedVisualDataAsync()

Returns visuals as a serialized string.

Declaration
public Task<string> ExportSerializedVisualDataAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

Flush()

Declaration
public void Flush()

FlushAsync()

Use to force the radial gauge to finish any deferred work before printing or evaluating its visual.

Declaration
public Task FlushAsync()
Returns
Type Description
System.Threading.Tasks.Task
Remarks

This should only be called if the visual of the radial gauge needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the radial gauge.

GetCurrentActualMaximumValue()

Declaration
public double GetCurrentActualMaximumValue()
Returns
Type Description
System.Double

GetCurrentActualMaximumValueAsync()

Declaration
public Task<double> GetCurrentActualMaximumValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetCurrentActualMinimumValue()

Declaration
public double GetCurrentActualMinimumValue()
Returns
Type Description
System.Double

GetCurrentActualMinimumValueAsync()

Declaration
public Task<double> GetCurrentActualMinimumValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetCurrentValue()

Declaration
public double GetCurrentValue()
Returns
Type Description
System.Double

GetCurrentValueAsync()

Declaration
public Task<double> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetPointForValue(Double, Double)

Declaration
public Point GetPointForValue(double value, double extent)
Parameters
Type Name Description
System.Double value
System.Double extent
Returns
Type Description
Point

GetPointForValueAsync(Double, Double)

Declaration
public Task<Point> GetPointForValueAsync(double value, double extent)
Parameters
Type Name Description
System.Double value
System.Double extent
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetValueForPoint(Point)

Declaration
public double GetValueForPoint(Point point)
Parameters
Type Name Description
Point point
Returns
Type Description
System.Double

GetValueForPointAsync(Point)

Gets the value for the main scale of the gauge for a given point within the bounds of the gauge.

Declaration
public Task<double> GetValueForPointAsync(Point point)
Parameters
Type Name Description
Point point

The point for which to retrieve the associated value.
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

NeedleContainsPoint(Point, Boolean)

Declaration
public bool NeedleContainsPoint(Point point, bool isFinger)
Parameters
Type Name Description
Point point
System.Boolean isFinger
Returns
Type Description
System.Boolean

NeedleContainsPointAsync(Point, Boolean)

Declaration
public Task<bool> NeedleContainsPointAsync(Point point, bool isFinger)
Parameters
Type Name Description
Point point
System.Boolean isFinger
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ProvideContainer(Object)

Declaration
public void ProvideContainer(object container)
Parameters
Type Name Description
System.Object container

ProvideContainerAsync(Object)

Called by the UI framework to provide a UI container for rendering this control.

Declaration
public Task ProvideContainerAsync(object container)
Parameters
Type Name Description
System.Object container

The UI container element.
Returns
Type Description
System.Threading.Tasks.Task

ScaleValue(Double)

Declaration
public double ScaleValue(double value)
Parameters
Type Name Description
System.Double value
Returns
Type Description
System.Double

ScaleValueAsync(Double)

Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians.

Declaration
public Task<double> ScaleValueAsync(double value)
Parameters
Type Name Description
System.Double value

The value to scale.
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

StyleUpdated()

Declaration
public void StyleUpdated()

StyleUpdatedAsync()

Declaration
public Task StyleUpdatedAsync()
Returns
Type Description
System.Threading.Tasks.Task

UnscaleValue(Double)

Declaration
public double UnscaleValue(double angle)
Parameters
Type Name Description
System.Double angle
Returns
Type Description
System.Double

UnscaleValueAsync(Double)

Unscales a value from an angle in radians to the represented value along the main scale of the gauge.

Declaration
public Task<double> UnscaleValueAsync(double angle)
Parameters
Type Name Description
System.Double angle

The angle in radians to unscale to a value.
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

Implements

System.IDisposable