Class CircularGaugeTooltipSettings

Specifies the options for customizing the tooltip of gauge.

Inheritance

System.Object

CircularGaugeTooltipSettings

Namespace: Syncfusion.Blazor.CircularGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class CircularGaugeTooltipSettings : OwningComponentBase

Constructors

CircularGaugeTooltipSettings()

Declaration

public CircularGaugeTooltipSettings()

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 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

public bool Enable { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean 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

public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean 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

public string Fill { get; set; }

Property Value

Type	Description
System.String	A System.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

public string Format { get; set; }

Property Value

Type	Description
System.String	A System.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

public bool ShowAtMousePosition { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean 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

public RenderFragment TooltipTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.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

public string[] Type { get; set; }

Property Value

Type	Description
System.String[]	An array of System.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
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.