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

Inheritance

object
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

constructor

public IgbLinearGauge()

Returns IgbLinearGauge

Inherited from: BaseRendererControl

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Height { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Width { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Class { get; set; }

Inherited from: BaseRendererControl

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }

Inherited from: BaseRendererControl

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererControl

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererControl

protected virtual string DirectRenderElementName { get; }

Inherited from: BaseRendererControl

protected virtual bool NeedsDynamicContent { get; }

Inherited from: BaseRendererControl

protected virtual bool UseCamelEnumValues { get; }

Gets whether and how to display the highlighted value.

[Parameter]
public HighlightedValueDisplayMode ActualHighlightValueDisplayMode { get; set; }

Gets the actual opacity of the primary needle while highlighting

[Parameter]
public double ActualHighlightValueOpacity { get; set; }
public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; }

Gets the resolved maximum value of the scale.

[Parameter]
public double ActualMaximumValue { get; set; }
[Parameter]
public Action<double> ActualMaximumValueChanged { get; set; }
[Parameter]
public string ActualMaximumValueChangedScript { get; set; }

Gets the resolved minimum value of the scale.

[Parameter]
public double ActualMinimumValue { get; set; }
[Parameter]
public Action<double> ActualMinimumValueChanged { get; set; }
[Parameter]
public string ActualMinimumValueChangedScript { get; set; }

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

[Parameter]
public double ActualPixelScalingRatio { get; set; }
public IgbLinearGraphRangeCollection ActualRanges { get; }

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

[Parameter]
public string BackingBrush { get; set; }

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

[Parameter]
public double BackingInnerExtent { get; set; }

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

[Parameter]
public double BackingOuterExtent { get; set; }

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

[Parameter]
public string BackingOutline { get; set; }

Gets or sets the stroke thickness of the backing outline.

[Parameter]
public double BackingStrokeThickness { get; set; }
public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }
public IgbLinearGraphRangeCollection ContentRanges { get; }

Gets the components default event behavior.

protected override ControlEventBehavior DefaultEventBehavior { get; }

Gets or sets the font.

[Parameter]
public string Font { get; set; }

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

[Parameter]
public string FontBrush { get; set; }

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

[Parameter]
public double HighlightValue { get; set; }
[Parameter]
public Action<IgbDoubleValueChangedEventArgs> HighlightValueChanged { get; set; }
[Parameter]
public string HighlightValueChangedScript { get; set; }

Gets or sets whether and how to display the highlighted value.

[Parameter]
public HighlightedValueDisplayMode HighlightValueDisplayMode { get; set; }

Gets or sets the opacity of the primary needle while highlighting

[Parameter]
public double HighlightValueOpacity { get; set; }

Gets or sets the interval to use for the scale.

[Parameter]
public double Interval { get; set; }

Gets or sets whether highlight needle dragging is enabled or not.

[Parameter]
public bool IsHighlightNeedleDraggingEnabled { get; set; }

Gets or sets whether needle dragging is enabled or not.

[Parameter]
public bool IsNeedleDraggingEnabled { get; set; }

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.

[Parameter]
public bool IsScaleInverted { get; set; }

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.

[Parameter]
public double LabelExtent { get; set; }

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

[Parameter]
public string LabelFormat { get; set; }

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

public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; }

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

[Parameter]
public double LabelInterval { get; set; }

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

[Parameter]
public double LabelsPostInitial { get; set; }

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

[Parameter]
public double LabelsPreTerminal { get; set; }

Gets or sets whether the labels are visible in the gauge.

[Parameter]
public bool LabelsVisible { get; set; }

Gets or sets the maximum value of the scale.

[Parameter]
public double MaximumValue { get; set; }

Gets or sets whether the scale viewport will be merged with backing viewport.

[Parameter]
public bool MergeViewports { get; set; }

Gets or sets the minimum value of the scale.

[Parameter]
public double MinimumValue { get; set; }

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

[Parameter]
public string MinorTickBrush { get; set; }

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

[Parameter]
public double MinorTickCount { get; set; }

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.

[Parameter]
public double MinorTickEndExtent { get; set; }

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.

[Parameter]
public double MinorTickStartExtent { get; set; }

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

[Parameter]
public double MinorTickStrokeThickness { get; set; }

Gets or sets the needle breadth.

[Parameter]
public double NeedleBreadth { get; set; }

Gets or sets the brush to use for needle element.

[Parameter]
public string NeedleBrush { get; set; }

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

[Parameter]
public double NeedleInnerBaseWidth { get; set; }

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.

[Parameter]
public double NeedleInnerExtent { get; set; }

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

[Parameter]
public double NeedleInnerPointExtent { get; set; }

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

[Parameter]
public double NeedleInnerPointWidth { get; set; }

Gets or sets the name used for needle.

[Parameter]
public string NeedleName { get; set; }

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

[Parameter]
public double NeedleOuterBaseWidth { get; set; }

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.

[Parameter]
public double NeedleOuterExtent { get; set; }

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

[Parameter]
public double NeedleOuterPointExtent { get; set; }

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

[Parameter]
public double NeedleOuterPointWidth { get; set; }

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

[Parameter]
public string NeedleOutline { get; set; }

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

[Parameter]
public LinearGraphNeedleShape NeedleShape { get; set; }

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

[Parameter]
public double NeedleStrokeThickness { get; set; }

Gets or sets the orientation of the scale.

[Parameter]
public LinearScaleOrientation Orientation { get; set; }
protected override string ParentTypeName { get; }

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

[Parameter]
public double PixelScalingRatio { get; set; }

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

[Parameter]
public string RangeBrushes { get; set; }

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.

[Parameter]
public double RangeInnerExtent { get; set; }

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.

[Parameter]
public double RangeOuterExtent { get; set; }

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

[Parameter]
public string RangeOutlines { get; set; }

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

public IgbLinearGraphRangeCollection Ranges { get; set; }

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

[Parameter]
public string ScaleBrush { get; set; }

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.

[Parameter]
public double ScaleEndExtent { get; set; }

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.

[Parameter]
public double ScaleInnerExtent { get; set; }

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.

[Parameter]
public double ScaleOuterExtent { get; set; }

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

[Parameter]
public string ScaleOutline { get; set; }

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.

[Parameter]
public double ScaleStartExtent { get; set; }

Gets or sets the stroke thickness of the scale outline.

[Parameter]
public double ScaleStrokeThickness { get; set; }

Gets or sets a value indicating whether tooltips are enabled.

[Parameter]
public bool ShowToolTip { get; set; }

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

[Parameter]
public int ShowToolTipTimeout { get; set; }

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

[Parameter]
public string TickBrush { get; set; }

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.

[Parameter]
public double TickEndExtent { get; set; }

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.

[Parameter]
public double TickStartExtent { get; set; }

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

[Parameter]
public double TickStrokeThickness { get; set; }

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

[Parameter]
public double TicksPostInitial { get; set; }

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

[Parameter]
public double TicksPreTerminal { get; set; }

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

[Parameter]
public int TransitionDuration { get; set; }

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

[Parameter]
public double TransitionProgress { get; set; }
public override string Type { get; }

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

[Parameter]
public double Value { get; set; }
[Parameter]
public Action<IgbDoubleValueChangedEventArgs> ValueChanged { get; set; }
[Parameter]
public string ValueChangedScript { get; set; }

Inherited from: BaseRendererControl

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererControl

protected string _cachedSerializedContent

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

Inherited from: BaseRendererControl

protected virtual string ResolveDisplay()

Returns any

Inherited from: BaseRendererControl

protected string ToSpinal(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected virtual string TransformSimpleKey(string key)

Parameters

  • key: string

Returns any

Inherited from: BaseRendererControl

protected virtual bool IsTransformedEnumValue(string key)

Parameters

  • key: string

Returns any

TransformPotentialEnumValue(string, object)

Section titled "TransformPotentialEnumValue(string, object)"

Inherited from: BaseRendererControl

protected virtual object TransformPotentialEnumValue(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

Inherited from: BaseRendererControl

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

  • startSequence: int

Returns any

Inherited from: BaseRendererControl

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

Inherited from: BaseRendererControl

protected Type TemplateContentType(string templateId)

Parameters

  • templateId: string

Returns any

Inherited from: BaseRendererControl

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

  • firstRender: bool

Returns any

Inherited from: BaseRendererControl

public Task EnsureReady()

Returns any

Inherited from: BaseRendererControl

protected void MarkPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Inherited from: BaseRendererControl

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererControl

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererControl

public string Serialize()

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

  • dataSource: object

Returns any

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

  • dataSource: object
  • notify: bool

Returns any

NotifyInsertItem(object, int, object)

Section titled "NotifyInsertItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

  • dataSource: object
  • index: int
  • refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Section titled "NotifyRemoveItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object

Returns any

Inherited from: BaseRendererControl

public void NotifyClearItems(object dataSource)

Parameters

  • dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Section titled "NotifySetItem(object, int, object, object)"

Inherited from: BaseRendererControl

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object
  • newItem: object

Returns any

NotifyUpdateItem(object, int, object, bool)

Section titled "NotifyUpdateItem(object, int, object, bool)"

Inherited from: BaseRendererControl

public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)

Parameters

  • dataSource: object
  • index: int
  • refItem: object
  • syncDataOnly: bool

Returns any

Inherited from: BaseRendererControl

public void OnRefChanged(string refName, object refValue)

Parameters

  • refName: string
  • refValue: object

Returns any

Inherited from: BaseRendererControl

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

  • invokeId: long
  • returnValue: object

Returns any

Inherited from: BaseRendererControl

protected string Camelize(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected string ToPascal(string value)

Parameters

  • value: string

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererControl

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

Inherited from: BaseRendererControl

protected virtual void Dispose(bool disposing)

Parameters

  • disposing: bool

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

SetPropertyValue(object, PropertyInfo, JsonElement)

Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)

Parameters

  • item: object
  • property: PropertyInfo
  • jsonElement: JsonElement

Returns any

SetPropertyValue(object, PropertyInfo, object)

Section titled "SetPropertyValue(object, PropertyInfo, object)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, object value)

Parameters

  • item: object
  • property: PropertyInfo
  • value: object

Returns any

Inherited from: BaseRendererControl

public void Dispose()

Returns any

public void ContainerResized()

Returns any

public Task ContainerResizedAsync()

Returns any

protected override void EnsureModulesLoaded()

Returns any

public string ExportSerializedVisualData()

Returns any

Returns visuals as a serialized string.

public Task<string> ExportSerializedVisualDataAsync()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

public void Flush()

Returns any

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

public Task FlushAsync()

Returns any

public double GetCurrentActualMaximumValue()

Returns any

GetCurrentActualMaximumValueAsync()

Section titled "GetCurrentActualMaximumValueAsync()"
public Task<double> GetCurrentActualMaximumValueAsync()

Returns any

public double GetCurrentActualMinimumValue()

Returns any

GetCurrentActualMinimumValueAsync()

Section titled "GetCurrentActualMinimumValueAsync()"
public Task<double> GetCurrentActualMinimumValueAsync()

Returns any

public double GetCurrentHighlightValue()

Returns any

public Task<double> GetCurrentHighlightValueAsync()

Returns any

public double GetCurrentValue()

Returns any

public Task<double> GetCurrentValueAsync()

Returns any

public double GetValueForPoint(Point point)

Parameters

  • point: Point

Returns any

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

public Task<double> GetValueForPointAsync(Point point)

Parameters

  • point: Point

Returns any

HighlightNeedleContainsPoint(Point, bool)

Section titled "HighlightNeedleContainsPoint(Point, bool)"
public bool HighlightNeedleContainsPoint(Point point, bool isFinger)

Parameters

  • point: Point
  • isFinger: bool

Returns any

HighlightNeedleContainsPointAsync(Point, bool)

Section titled "HighlightNeedleContainsPointAsync(Point, bool)"
public Task<bool> HighlightNeedleContainsPointAsync(Point point, bool isFinger)

Parameters

  • point: Point
  • isFinger: bool

Returns any

public bool NeedleContainsPoint(Point point, bool isFinger)

Parameters

  • point: Point
  • isFinger: bool

Returns any

NeedleContainsPointAsync(Point, bool)

Section titled "NeedleContainsPointAsync(Point, bool)"
public Task<bool> NeedleContainsPointAsync(Point point, bool isFinger)

Parameters

  • point: Point
  • isFinger: bool

Returns any

public void ProvideContainer(object container)

Parameters

  • container: object

Returns any

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

public Task ProvideContainerAsync(object container)

Parameters

  • container: object

Returns any

public void StyleUpdated()

Returns any

public Task StyleUpdatedAsync()

Returns any

[Parameter]
public EventCallback<IgbAlignLinearGraphLabelEventArgs> AlignLabel { get; set; }
[Parameter]
public EventCallback<IgbFormatLinearGraphLabelEventArgs> FormatLabel { get; set; }
[Parameter]
public string AlignLabelScript { get; set; }
[Parameter]
public string FormatLabelScript { get; set; }