Class SfLinearGauge

The linear gauge is an ideal control for visualizing numeric values in a linear scale with features like multiple axes, different orientations, and more.

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

SfLinearGauge

Namespace: Syncfusion.Blazor.LinearGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfLinearGauge : SfBaseComponent

Constructors

SfLinearGauge()

Declaration

public SfLinearGauge()

Properties

AllowImageExport

Enables or disables the export to image functionality in linear gauge.

Declaration

public bool AllowImageExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowPdfExport

Enables or disables the export to PDF functionality in linear gauge.

Declaration

public bool AllowPdfExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowPrint

Enables or disables the print functionality in linear gauge.

Declaration

public bool AllowPrint { get; set; }

Property Value

Type	Description
System.Boolean

Background

Specifies the background color of the gauge. This property accepts value in hex code, rgba string as a valid CSS color string.

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String

ChildContent

Sets and gets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

Description

Specifies the description for linear gauge.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

EnableGroupingSeparator

Enables or disables a grouping separator should be used for a number.

Declaration

public bool EnableGroupingSeparator { get; set; }

Property Value

Type	Description
System.Boolean

Format

Specifies the format to apply for internationalization in linear gauge.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String

Height

Specifies the height of the linear gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full height of its parent element.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

ID

Set the id string for the linear gauge component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Orientation

Specifies the orientation of the rendering of the linear gauge.

Declaration

public Orientation Orientation { get; set; }

Property Value

Type	Description
Orientation

RangePalettes

Specifies the color palette for axis ranges in linear gauge.

Declaration

public string[] RangePalettes { get; set; }

Property Value

Type	Description
System.String[]

TabIndex

Specifies the tab index value for the linear gauge.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
System.Int32

Theme

Specifies the theme supported for the linear gauge.

Declaration

public Theme Theme { get; set; }

Property Value

Type	Description
Theme

Title

Specifies the title for linear gauge.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

Width

Specifies the width of the linear gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full width of its parent element.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Export(ExportType, String, Nullable<PdfPageOrientation>, Boolean)

The method is used to perform the export functionality for the rendered linear gauge.

Declaration

public Task<string> Export(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation = null, bool allowDownload = true)

Parameters

Type	Name	Description
ExportType	type	Specifies the export type for the rendered linear gauge.
System.String	fileName	Specifies the filename.
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the portrait or landscape orientation of the page.
System.Boolean	allowDownload	Specifies whether to download or not.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Returns base64 string.

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnGaugeInitialized()

Declaration

protected Task OnGaugeInitialized()

Returns

Type	Description
System.Threading.Tasks.Task

OnGaugeParametersSet()

Declaration

protected Task OnGaugeParametersSet()

Returns

Type	Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Print()

The method is used to print the rendered linear gauge.

Declaration

public Task Print()

Returns

Type	Description
System.Threading.Tasks.Task

Refresh()

Declaration

public Task Refresh()

Returns

Type	Description
System.Threading.Tasks.Task

SetAnnotationValue(Int32, String, Int32)

The method is used to set the annotation value dynamically for linear gauge.

Declaration

public void SetAnnotationValue(int annotationIndex, string content, int axisValue)

Parameters

Type	Name	Description
System.Int32	annotationIndex	Specifies the index number of the axis in which the annotation value is to be changed.
System.String	content	Specifies the value of the annotation to be updated in it.
System.Int32	axisValue

SetPointerValue(Int32, Int32, Double)

The method is used to set the pointer value dynamically for linear gauge.

Declaration

public void SetPointerValue(int axisIndex, int pointerIndex, double pointerValue)

Parameters

Type	Name	Description
System.Int32	axisIndex	Specifies the index number of the axis in which the pointer value is to be changed.
System.Int32	pointerIndex	Specifies the index number of the pointer in which the value is to be changed.
System.Double	pointerValue	Specifies the value of the pointer to be updated in it.