Class IgbLinearGauge

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

Inheritance

System.Object

BaseRendererControl

IgbLinearGauge

Implements

JsonSerializable

System.IDisposable

Inherited Members

BaseRendererControl._cachedSerializedContent

BaseRendererControl.ResolveDisplay()

BaseRendererControl.ToSpinal(String)

BaseRendererControl.TransformSimpleKey(String)

BaseRendererControl.BuildSequenceInfo(Int32)

BaseRendererControl.BuildRenderTree(RenderTreeBuilder)

BaseRendererControl.TemplateContentType(String)

BaseRendererControl.OnAfterRenderAsync(Boolean)

BaseRendererControl.EnsureReady()

BaseRendererControl.MarkPropDirty(String)

BaseRendererControl.IsPropDirty(String)

BaseRendererControl.Serialize(SerializationContext, String)

BaseRendererControl.Serialize()

BaseRendererControl.InvokeMethod(String, Object[], String[])

BaseRendererControl.InvokeMethodSync(String, Object[], String[])

BaseRendererControl.NotifyInsertItem(Object, Int32, Object)

BaseRendererControl.NotifyRemoveItem(Object, Int32, Object)

BaseRendererControl.NotifyClearItems(Object)

BaseRendererControl.NotifySetItem(Object, Int32, Object, Object)

BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)

BaseRendererControl.OnRefChanged(String, Object)

BaseRendererControl.OnInvokeReturn(Int64, Object)

BaseRendererControl.Camelize(String)

BaseRendererControl.ToPascal(String)

BaseRendererControl.Dispose(Boolean)

BaseRendererControl.Finalize()

BaseRendererControl.Dispose()

BaseRendererControl.IgBlazor

BaseRendererControl.Height

BaseRendererControl.Width

BaseRendererControl.Class

BaseRendererControl.AdditionalAttributes

BaseRendererControl.ChildContent

BaseRendererControl.SupportsVisualChildren

BaseRendererControl.UseDirectRender

BaseRendererControl.DirectRenderElementName

BaseRendererControl.NeedsDynamicContent

BaseRendererControl.UseCamelEnumValues

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbLinearGauge : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbLinearGauge()

Declaration

public IgbLinearGauge()

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 IgbLinearGraphRangeCollection ActualRanges { get; }

Property Value

Type	Description
IgbLinearGraphRangeCollection

AlignLabel

Declaration

public EventCallback<IgbAlignLinearGraphLabelEventArgs> AlignLabel { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbAlignLinearGraphLabelEventArgs>

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 linear gauge.

Declaration

public string BackingBrush { get; set; }

Property Value

Type	Description
System.String

BackingInnerExtent

Gets or sets the inner extent of the linear gauge backing.

Declaration

public double BackingInnerExtent { get; set; }

Property Value

Type	Description
System.Double

BackingOuterExtent

Gets or sets the outer extent of the linear 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

BackingStrokeThickness

Gets or sets the stroke thickness of the backing outline.

Declaration

public double BackingStrokeThickness { get; set; }

Property Value

Type	Description
System.Double

ContentLabelFormatSpecifiers

Declaration

public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }

Property Value

Type	Description
IgbFormatSpecifierCollection

ContentRanges

Declaration

public IgbLinearGraphRangeCollection ContentRanges { get; }

Property Value

Type	Description
IgbLinearGraphRangeCollection

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<IgbFormatLinearGraphLabelEventArgs> FormatLabel { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFormatLinearGraphLabelEventArgs>

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

IsNeedleDraggingEnabled

Gets or sets whether needle dragging is enabled or not.

Declaration

public bool IsNeedleDraggingEnabled { get; set; }

Property Value

Type	Description
System.Boolean

IsScaleInverted

Gets or sets a value indicating whether the scale is inverted. When the scale is inverted the direction in which the scale values increase is right to left.

Declaration

public bool IsScaleInverted { 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 from the bottom of the scale. Values further from zero than 1 can be used to hide the labels of the linear 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

LabelsPostInitial

A value to start adding labels, added to the scale's MinimumValue.

Declaration

public double LabelsPostInitial { get; set; }

Property Value

Type	Description
System.Double

LabelsPreTerminal

A value to stop adding labels, subtracted from the scale's MaximumValue.

Declaration

public double LabelsPreTerminal { 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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear 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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear 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

NeedleBreadth

Gets or sets the needle breadth.

Declaration

public double NeedleBreadth { get; set; }

Property Value

Type	Description
System.Double

NeedleBrush

Gets or sets the brush to use for needle element.

Declaration

public string NeedleBrush { get; set; }

Property Value

Type	Description
System.String

NeedleInnerBaseWidth

Gets or sets the width of the needle's inner base.

Declaration

public double NeedleInnerBaseWidth { get; set; }

Property Value

Type	Description
System.Double

NeedleInnerExtent

Gets or sets the position at which to start rendering the needle geometry, measured from the front/bottom of the linear 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 size of the linear gauge.

Declaration

public double NeedleInnerExtent { get; set; }

Property Value

Type	Description
System.Double

NeedleInnerPointExtent

Gets or sets the extent of the needle's inner point.

Declaration

public double NeedleInnerPointExtent { get; set; }

Property Value

Type	Description
System.Double

NeedleInnerPointWidth

Gets or sets the width of the needle's inner point.

Declaration

public double NeedleInnerPointWidth { get; set; }

Property Value

Type	Description
System.Double

NeedleName

Gets or sets the name used for needle.

Declaration

public string NeedleName { get; set; }

Property Value

Type	Description
System.String

NeedleOuterBaseWidth

Gets or sets the width of the needle's outer base.

Declaration

public double NeedleOuterBaseWidth { get; set; }

Property Value

Type	Description
System.Double

NeedleOuterExtent

Gets or sets the position at which to stop rendering the needle geometry as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

Declaration

public double NeedleOuterExtent { get; set; }

Property Value

Type	Description
System.Double

NeedleOuterPointExtent

Gets or sets the extent of the needle's outer point.

Declaration

public double NeedleOuterPointExtent { get; set; }

Property Value

Type	Description
System.Double

NeedleOuterPointWidth

Gets or sets the width of the needle's outer point.

Declaration

public double NeedleOuterPointWidth { get; set; }

Property Value

Type	Description
System.Double

NeedleOutline

Gets or sets the brush to use for the outline of needle element.

Declaration

public string NeedleOutline { get; set; }

Property Value

Type	Description
System.String

NeedleShape

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

Declaration

public LinearGraphNeedleShape NeedleShape { get; set; }

Property Value

Type	Description
LinearGraphNeedleShape

NeedleStrokeThickness

Gets or sets the stroke thickness to use when rendering single actual value element.

Declaration

public double NeedleStrokeThickness { get; set; }

Property Value

Type	Description
System.Double

Orientation

Gets or sets the orientation of the scale.

Declaration

public LinearScaleOrientation Orientation { get; set; }

Property Value

Type	Description
LinearScaleOrientation

ParentTypeName

Declaration

protected override string ParentTypeName { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererControl.ParentTypeName

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.

RangeBrushes

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

Declaration

public string RangeBrushes { get; set; }

Property Value

Type	Description
System.String

RangeInnerExtent

Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

Declaration

public double RangeInnerExtent { get; set; }

Property Value

Type	Description
System.Double

RangeOuterExtent

Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

Declaration

public double RangeOuterExtent { get; set; }

Property Value

Type	Description
System.Double

RangeOutlines

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

Declaration

public string RangeOutlines { get; set; }

Property Value

Type	Description
System.String

Ranges

Gets or sets the scale ranges to render on the linear gauge.

Declaration

public IgbLinearGraphRangeCollection Ranges { get; set; }

Property Value

Type	Description
IgbLinearGraphRangeCollection

ScaleBrush

Gets or sets the brush to use to fill the scale of the linear gauge.

Declaration

public string ScaleBrush { get; set; }

Property Value

Type	Description
System.String

ScaleEndExtent

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

Declaration

public double ScaleEndExtent { get; set; }

Property Value

Type	Description
System.Double

ScaleInnerExtent

Gets or sets the position at which to start rendering the scale, measured from the bottom/front (when orientation is horizontal/vertical) of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

Declaration

public double ScaleInnerExtent { get; set; }

Property Value

Type	Description
System.Double

ScaleOuterExtent

Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the bottom/front (when orientation is horizontal/vertical) of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

Declaration

public double ScaleOuterExtent { get; set; }

Property Value

Type	Description
System.Double

ScaleOutline

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

Declaration

public string ScaleOutline { get; set; }

Property Value

Type	Description
System.String

ScaleStartExtent

Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the linear 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 size of the linear gauge.

Declaration

public double ScaleStartExtent { get; set; }

Property Value

Type	Description
System.Double

ScaleStrokeThickness

Gets or sets the stroke thickness of the scale outline.

Declaration

public double ScaleStrokeThickness { get; set; }

Property Value

Type	Description
System.Double

ShowToolTip

Gets or sets a value indicating whether tooltips are enabled.

Declaration

public bool ShowToolTip { get; set; }

Property Value

Type	Description
System.Boolean

ShowToolTipTimeout

Gets or sets the time in milliseconds that tooltip appearance is delayed with.

Declaration

public int ShowToolTipTimeout { get; set; }

Property Value

Type	Description
System.Int32

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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge.

Declaration

public double TickEndExtent { get; set; }

Property Value

Type	Description
System.Double

TicksPostInitial

A value to start adding tickmarks, added to the scale's MinimumValue.

Declaration

public double TicksPostInitial { get; set; }

Property Value

Type	Description
System.Double

TicksPreTerminal

A value to stop adding tickmarks, subtracted from the scale's MaximumValue.

Declaration

public double TicksPreTerminal { 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 front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear 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 linear 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

BaseRendererControl.Type

Value

Gets or sets the value at which the needle is positioned.

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

BaseRendererControl.EnsureModulesLoaded()

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

BaseRendererControl.FindByName(String)

Flush()

Declaration

public void Flush()

FlushAsync()

Use to force the linear 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 linear gauge needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the linear 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>

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

StyleUpdated()

Declaration

public void StyleUpdated()

StyleUpdatedAsync()

Declaration

public Task StyleUpdatedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable

System.IDisposable