Class CircularGaugeAnnotationTooltipSettings
Represents the tooltip settings for annotations within the circular gauge, allowing customization of appearance and behavior.
Inheritance
Namespace: Syncfusion.Blazor.CircularGauge
Assembly: Syncfusion.Blazor.dll
Syntax
public class CircularGaugeAnnotationTooltipSettings : OwningComponentBaseConstructors
CircularGaugeAnnotationTooltipSettings()
Declaration
public CircularGaugeAnnotationTooltipSettings()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 that defines the content to be rendered inside the tooltip settings component. |
Remarks
This property is used to insert custom UI elements within the tooltip settings context.
EnableAnimation
Gets or sets a value indicating whether the animation of the annotation tooltip is enabled.
Declaration
public bool EnableAnimation { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | A System.Boolean where true means animation is enabled; otherwise, false. The default is true. |
Remarks
Enabling this property provides a smooth transition effect when displaying the tooltip.
Fill
Gets or sets the fill color of the annotation tooltip.
Declaration
public string Fill { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A string representing the color, which can be in hex, rgba, or any valid CSS color format. |
Remarks
This property allows you to customize the background color of the tooltip for improved visibility and aesthetics.
Format
Gets or sets the format for displaying annotations in the tooltip.
Declaration
public string Format { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A string that specifies the format, typically using placeholders for dynamic content. |
Remarks
This property helps in defining how the annotation information is presented within the tooltip.
Template
Gets or sets the custom template to render the tooltip content.
Declaration
public RenderFragment Template { get; set; }Property Value
| Type | Description |
|---|---|
| Microsoft.AspNetCore.Components.RenderFragment | A Microsoft.AspNetCore.Components.RenderFragment representing the custom template for tooltip content. |
Remarks
Use this property to define custom layouts or information to be displayed inside the tooltip.
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. |