Class SfCircularGauge
The circular gauge component is used to visualize the numeric values on the circular scale. The circular gauge contains labels, ticks, and an axis line to customize its appearance.
Inheritance
Namespace: Syncfusion.Blazor.CircularGauge
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfCircularGauge : SfBaseComponent
Constructors
SfCircularGauge()
Declaration
public SfCircularGauge()
Properties
AllowImageExport
Enables and disables the export to image functionality in circular gauge.
Declaration
public bool AllowImageExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowMargin
Enables and disables the margin padding in circular gauge.
Declaration
public bool AllowMargin { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowPdfExport
Enables and disables the export to pdf functionality in circular gauge.
Declaration
public bool AllowPdfExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowPrint
Enables and disables the print functionality in circular gauge.
Declaration
public bool AllowPrint { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Axes
Sets and gets the options for customizing the axes of circular gauge.
Declaration
public List<CircularGaugeAxis> Axes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<CircularGaugeAxis> |
Background
Sets and gets 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 |
CenterX
Sets and gets the X coordinate of the circular gauge.
Declaration
public string CenterX { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CenterY
Sets and gets the Y coordinate of the circular gauge.
Declaration
public string CenterY { 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
Sets and gets the information about gauge for assistive technology.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EnableGroupingSeparator
Enables and disables the grouping separator should be used for a number.
Declaration
public bool EnableGroupingSeparator { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnablePointerDrag
Enables and disables drag movement of the pointer in the circular gauge.
Declaration
public bool EnablePointerDrag { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableRangeDrag
Enables and disables the drag movement of the ranges in the circular gauge.
Declaration
public bool EnableRangeDrag { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Height
Sets and gets the height of the circular 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 circular gauge component.
Declaration
public string ID { get; set; }
Property Value
Type | Description |
---|---|
System.String |
MoveToCenter
Enables and disables to place the half or quarter circle in center position, if values not specified for centerX and centerY.
Declaration
public bool MoveToCenter { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
TabIndex
Sets and gets the tab index value for the circular gauge.
Declaration
public int TabIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Theme
Sets and gets the themes supported for circular gauge.
Declaration
public Theme Theme { get; set; }
Property Value
Type | Description |
---|---|
Theme |
Title
Sets and gets the title for circular gauge.
Declaration
public string Title { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Width
Sets and gets the width of the circular 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 circular 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 format of the file to export the circular gauge. |
System.String | fileName | Specifies the name of the file for the exported circular gauge. |
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation> | orientation | Specifies the orientation of the exported PDF document when the type parameter is PDF |
System.Boolean | allowDownload | Specifies whether the exported file is to be downloaded or not. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.String> | Returns base64 string of the exported circular gauge when allowDownload parameter is false. |
OnAfterRenderAsync(Boolean)
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | firstRender |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Overrides
OnInitializedAsync()
Declaration
protected override Task OnInitializedAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Overrides
OnParametersSetAsync()
Declaration
protected override Task OnParametersSetAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Print()
The method is used to print the rendered circular gauge.
Declaration
public Task Print()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Refresh()
This method renders the circular gauge component again.
Declaration
public void Refresh()
SetAnnotationValue(Int32, Int32, String)
This method is used to set the annotation content dynamically for circular gauge.
Declaration
public void SetAnnotationValue(int axisIndex, int annotationIndex, string content)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | axisIndex | Specifies the index number of the axis in which the annotation content is to be changed. |
System.Int32 | annotationIndex | Specifies the index number of the annotation in which the content is to be changed. |
System.String | content | Specifies the content of the annotation to be updated in it. |
SetPointerValue(Int32, Int32, Double)
The method is used to set the pointer value dynamically for circular 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. |
SetRangeValue(Int32, Int32, Double, Double)
The method is used to set the range values dynamically for circular gauge.
Declaration
public void SetRangeValue(int axisIndex, int rangeIndex, double start, double end)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | axisIndex | Specifies the index number of the axis in which the range value is to be changed. |
System.Int32 | rangeIndex | Specifies the index number of the range in which the value is to be changed. |
System.Double | start | Specifies the start value of the range to be updated in it. |
System.Double | end | Specifies the end value of the range to be updated in it. |
UpdateChildProperties(String, Object)
Declaration
public void UpdateChildProperties(string key, object keyValue)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | |
System.Object | keyValue |