Class CircularGaugeRangeTooltipSettings

Configures the tooltip settings of the range in the circular gauge.

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

Constructors

CircularGaugeRangeTooltipSettings()

Declaration
public CircularGaugeRangeTooltipSettings()

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 tooltip settings.
Remarks

This property allows the rendering of custom content as child elements within the tooltip settings.

EnableAnimation

Gets or sets a value indicating whether to enable animation for the range tooltip. The default value is true.

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

A bool indicating if the tooltip animation is enabled.
Remarks

Enables or disables animation when the tooltip appears.

Fill

Gets or sets the fill color of the range tooltip. This property supports CSS color values such as hex, rgba strings, etc.

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

A string representing the background color of the tooltip.
Remarks

Customizes the appearance of the tooltip by setting its fill color.

Format

Gets or sets the format of the range tooltip in the circular gauge.

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

A string representing the format of the tooltip content. Default is an empty string.
Remarks

You can use format strings to customize the text displayed in the tooltip.

ShowAtMousePosition

Gets or sets a value indicating whether to display the tooltip at the mouse position. The default value is false.

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

A bool specifying if the tooltip should appear at the mouse cursor.
Remarks

Controls the positioning of the tooltip relative to the mouse pointer.

Template

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

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

A RenderFragment used to define a template for the tooltip content.
Remarks

This property lets you customize the tooltip content using a template.

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