Class LinearGaugeRangeTooltipSettings
Defines the tooltip settings of the range in linear gauge.
Inheritance
Namespace: Syncfusion.Blazor.LinearGauge
Assembly: Syncfusion.Blazor.dll
Syntax
public class LinearGaugeRangeTooltipSettings : OwningComponentBase
Constructors
LinearGaugeRangeTooltipSettings()
Declaration
public LinearGaugeRangeTooltipSettings()
Properties
ChildContent
Gets or sets the child content for the tooltip.
Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.RenderFragment | A Microsoft.AspNetCore.Components.RenderFragment representing any additional content to include in the tooltip. |
EnableAnimation
Gets or sets a value indicating whether or not to enable the animation of the range tooltip. The animation is set as true by default.
Declaration
public bool EnableAnimation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | A System.Boolean indicating if the tooltip should animate upon appearance. |
Remarks
Enabling animation can enhance user experience by providing visual feedback as tooltips appear and disappear.
Fill
Gets or sets the fill color of the range 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 specifying the color used to fill the tooltip's background. |
Remarks
The fill color customization provides additional control over the tooltip's appearance, aligning it with the visual design.
Format
Gets or sets the format of the range tooltip in linear gauge.
Declaration
public string Format { get; set; }
Property Value
Type | Description |
---|---|
System.String | A System.String that defines the format for displaying the tooltip content. |
Remarks
Use format strings to customize the information displayed in the tooltip, using placeholders like ${value}.
Position
Gets or sets the position type to place the tooltip in the axis.
Declaration
public TooltipPosition Position { get; set; }
Property Value
Type | Description |
---|---|
TooltipPosition | A TooltipPosition that positions the tooltip relative to the axis. Default is End. |
Remarks
Positioning affects where the tooltip is displayed in relation to the axis, influencing usability and clarity.
ShowAtMousePosition
Gets or sets a value indicating whether or not to show the range tooltip 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 if the tooltip should appear at the location of the mouse pointer. |
Remarks
Placing tooltips at the mouse position can help focus the user's attention on the specific point of interaction.
Template
Gets or sets the custom template to format the tooltip content, using placeholders like ${x} and ${y}.
Declaration
public RenderFragment Template { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.RenderFragment | A Microsoft.AspNetCore.Components.RenderFragment allowing detailed customization of tooltip content and formatting. |
Remarks
This template feature provides flexibility in displaying dynamic data within the tooltip.
TooltipTemplate
Gets or sets the template content for the tooltip display.
Declaration
public RenderFragment TooltipTemplate { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.RenderFragment | A Microsoft.AspNetCore.Components.RenderFragment to customize the tooltip's layout and appearance. |
Remarks
This template allows for flexible customization of how tooltips are presented, supporting advanced layout designs.
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. |