Class CircularGaugeTooltipSettings

Specifies the options for customizing the tooltip of gauge.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
CircularGaugeTooltipSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.CircularGauge
Assembly: Syncfusion.Blazor.dll
Syntax
public class CircularGaugeTooltipSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

CircularGaugeTooltipSettings()

Declaration
public CircularGaugeTooltipSettings()

Properties

ChildContent

Gets or sets the content of the UI element.

Declaration
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment representing the child content of the circular gauge.
Remarks

Use this property to define the inner elements of the gauge's UI representation.

Enable

Gets or sets a value indicating whether or not to enable the visibility of tooltip.

Declaration
[Parameter]
public bool Enable { get; set; }
Property Value
Type Description
bool

A bool that enables or disables the tooltip visibility. Default is false.
Remarks

This property determines if the tooltip should be displayed when interacting with the gauge.

EnableAnimation

Gets or sets a value indicating whether or not to enable the animation to take place in circular gauge.

Declaration
[Parameter]
public bool EnableAnimation { get; set; }
Property Value
Type Description
bool

A bool that indicates whether animation is enabled. Default is true.
Remarks

Animation enhances the user experience by providing smooth transitions when tooltips appear.

Fill

Gets or sets the fill color of the tooltip. This property accepts value in hex code, rgba string as a valid CSS color string.

Declaration
[Parameter]
public string Fill { get; set; }
Property Value
Type Description
string

A string representing the color of the tooltip's background.
Remarks

Customize the background color of the tooltip using HEX, RGB, or CSS color names.

Format

Gets or sets the format for the tooltip content in circular gauge.

Declaration
[Parameter]
public string Format { get; set; }
Property Value
Type Description
string

A string that defines the format of displayed tooltip content.
Remarks

Use this property to specify how the tooltip content should be formatted.

ShowAtMousePosition

Gets or sets a value indicating whether or not to enable the tooltip of the circular gauge at mouse position. By default, it set as false.

Declaration
[Parameter]
public bool ShowAtMousePosition { get; set; }
Property Value
Type Description
bool

A bool indicating whether the tooltip appears at the mouse position. Default is false.
Remarks

Enabling this property shows the tooltip exactly where the user clicks or hovers.

TooltipTemplate

Gets or sets the custom template to render the tooltip content.

Declaration
[Parameter]
public RenderFragment TooltipTemplate { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment that represents a custom template for the tooltip.
Remarks

You can define a custom layout and style for the tooltip content using this property.

Type

Gets or sets the options to select the type of tooltip for range, annotation and pointer.

Declaration
[Parameter]
public string[] Type { get; set; }
Property Value
Type Description
string[]

An array of string that specifies the tooltip types to be used (e.g., Range, Annotation, Pointer).
Remarks

Define which parts of the gauge will display tooltips using this property.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Dispose(bool)

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
bool disposing
Overrides

OnInitializedAsync()

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

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

Task representing the asynchronous operation.
Overrides

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
Task

Task representing the asynchronous operation.
Overrides

Implements