Class LinearGaugeTooltipSettings

Defines the annotation element for an axis in linear gauge component.

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

Constructors

LinearGaugeTooltipSettings()

Declaration
public LinearGaugeTooltipSettings()

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

Use this property to include custom UI elements as content within the tooltip.

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 boolean indicating the visibility of the tooltip.
Remarks

Set this to true to make the tooltip visible, or false to hide it.

EnableAnimation

Gets or sets a value indicating whether or not to enable the animation for the tooltip while moving from one place to another.

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

A boolean indicating whether animation is enabled for the tooltip. The default is true.
Remarks

Enable smooth transitions by setting this property to true.

Fill

Gets or sets the 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 specifying the background color of the tooltip.
Remarks

Customize tooltip appearance by specifying its color using standard CSS color formats.

Format

Gets or sets the format of the tooltip content in the linear gauge.

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

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

Use placeholders like ${value} to format the displayed data dynamically.

Position

Gets or sets the position type to place the tooltip in the axis.

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

A TooltipPosition value that determines the tooltip's position. The default is End.
Remarks

This property controls where on the axis the tooltip is shown (Start, Center, End).

ShowAtMousePosition

Gets or sets a value indicating whether or not to show the tooltip at the mouse pointer position.

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

A boolean specifying whether to display the tooltip at the mouse pointer location.
Remarks

Set this to true to position the tooltip at the mouse pointer, instead of the default position.

Template

Gets or sets the custom template to format the tooltip content. Use ${x} and ${y} as placeholder text to display the corresponding data point.

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

A string that contains the template format for tooltip content.
Remarks

This enables dynamic content formatting within tooltips using placeholders for variable data.

TooltipTemplate

Gets or sets the tooltip template content for display.

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

A RenderFragment that defines the custom template for the tooltip.
Remarks

This allows for customized display layouts within the tooltip, using templating.

Type

Gets or sets the option to display the tooltip for range, annotation, or pointer.

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

An array of strings indicating the elements for which tooltips are shown which takes the values such as Pointer and Range.
Remarks

Allows customization of tooltip visibility, enabling selective display on range, annotation, or pointer elements within the gauge.

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