Class CircularGaugePointer

Defines the options to customize the pointer in an axis of the circular gauge component.

Inheritance

System.Object

CircularGaugePointer

Namespace: Syncfusion.Blazor.CircularGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class CircularGaugePointer : OwningComponentBase

Constructors

CircularGaugePointer()

Declaration

public CircularGaugePointer()

Properties

ChildContent

Gets or sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment representing the content of the pointer.

Remarks

Use this property to define custom UI elements or additional content for the pointer.

Color

Gets or sets the color of the pointer in an axis.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String	A System.String representing the pointer's color.

Remarks

This property changes the visual color of the pointer for better visibility within the gauge.

Description

Gets or sets the information about pointer for assistive technology.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	A System.String that provides a description used by screen readers.

Remarks

Set this property to enhance user experience for those utilizing assistive technologies.

ImageUrl

Gets or sets the URL for the image that is to be displayed as pointer.

Declaration

public string ImageUrl { get; set; }

Property Value

Type	Description
System.String	A System.String containing the URL of the image.

Remarks

This URL specifies an image when the pointer marker shape is set to Image.

MarkerHeight

Gets or sets the height of the marker pointer in an axis.

Declaration

public double MarkerHeight { get; set; }

Property Value

Type	Description
System.Double	A System.Double specifying the marker's height.

Remarks

Adjust this property to customize the vertical size of the marker pointer.

MarkerShape

Gets or sets the shape of the marker type pointer in an axis.

Declaration

public GaugeShape MarkerShape { get; set; }

Property Value

Type	Description
GaugeShape	A GaugeShape representing the marker's shape.

Remarks

Use this property to switch between predefined shapes for the marker pointer.

MarkerWidth

Gets or sets the width of the marker pointer in an axis.

Declaration

public double MarkerWidth { get; set; }

Property Value

Type	Description
System.Double	A System.Double specifying the marker's width.

Remarks

Modify this property to change the horizontal size of the marker pointer.

NeedleEndWidth

Gets or sets the end width of the needle pointer in an axis.

Declaration

public double NeedleEndWidth { get; set; }

Property Value

Type	Description
System.Double	A System.Double specifying the needle's end width.

Remarks

This property allows customization of the needle's taper from the midpoint to the end.

NeedleStartWidth

Gets or sets the start width of the needle pointer in an axis.

Declaration

public double NeedleStartWidth { get; set; }

Property Value

Type	Description
System.Double	A System.Double specifying the needle's start width.

Remarks

This property allows customization of the needle's taper from the start to the midpoint.

Offset

Gets or sets the offset value of the pointer from the scale.

Declaration

public string Offset { get; set; }

Property Value

Type	Description
System.String	A System.String specifying the pointer's offset distance from the scale.

Remarks

Use this property to adjust how far the pointer sits from the circular scale.

PointerWidth

Gets or sets the width of the pointer in an axis.

Declaration

public double PointerWidth { get; set; }

Property Value

Type	Description
System.Double	A System.Double specifying the pointer's overall width.

Remarks

Set this property to alter the general thickness of the pointer.

Position

Gets or sets the position of pointer for an axis.

Declaration

public PointerRangePosition Position { get; set; }

Property Value

Type	Description
PointerRangePosition	A PointerRangePosition value dictating the alignment of the pointer.

Remarks

Configure this property to manage the pointer's placement within the gauge axis.

Radius

Gets or sets the radius of pointer for marker and range type pointer and fix length of pointer for needle pointer.

Declaration

public string Radius { get; set; }

Property Value

Type	Description
System.String	A System.String that defines the radius or fixed length of the pointer.

Remarks

Utilize this property to modify how the pointer extends from its center point or origin.

RoundedCornerRadius

Gets or sets the corner radius for pointer in an axis.

Declaration

public double RoundedCornerRadius { get; set; }

Property Value

Type	Description
System.Double	A System.Double indicating the radius used to round the corners of the pointer.

Remarks

Adjust this property to smooth out the angles of the pointer for improved visuals.

Text

Gets or sets the text in the pointer.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A System.String representing text to display on the pointer.

Remarks

This property supports adding labels or annotations directly on the pointer.

Type

Gets or sets the type of pointer for an axis in the circular gauge component.

Declaration

public PointerType Type { get; set; }

Property Value

Type	Description
PointerType	A PointerType specifying the pointer's type.

Remarks

Assign this to switch between different pointer styles such as needle or marker.

Value

Gets or sets the value of the pointer in the circular gauge component.

Declaration

public double Value { get; set; }

Property Value

Type	Description
System.Double	A System.Double that represents the pointer's value indicating its position along the scale.

Remarks

Use this to set or retrieve the current position of the pointer, often representing data points.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

Dispose(Boolean)

Disposes the property values during the destroy of the component that is hold up for the execution of the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

OnInitializedAsync method is called when the component has received its initial parameters.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task representing the asynchronous operation.

OnParametersSetAsync()

OnParametersSetAsync is a lifecycle method that is invoked when the component has received parameters, and the incoming values have been assigned to the properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task representing the asynchronous operation.