Class LinearGaugeTooltipSettings

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

Inheritance
System.Object
SfBaseComponent
LinearGaugeTooltipSettings
Inherited Members
Namespace: Syncfusion.Blazor.LinearGauge
Assembly: Syncfusion.Blazor.dll
Syntax
public class LinearGaugeTooltipSettings : SfBaseComponent

Constructors

LinearGaugeTooltipSettings()

Declaration
public LinearGaugeTooltipSettings()

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

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

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
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean

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
public string Fill { get; set; }
Property Value
Type Description
System.String

Format

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

Declaration
public string Format { get; set; }
Property Value
Type Description
System.String

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

ShowAtMousePosition

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

Declaration
public bool ShowAtMousePosition { get; set; }
Property Value
Type Description
System.Boolean

Template

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

Declaration
public string Template { get; set; }
Property Value
Type Description
System.String

TooltipTemplate

Gets or sets the tooltip template content for display.

Declaration
public RenderFragment TooltipTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

Type

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

Declaration
public string[] Type { get; set; }
Property Value
Type Description
System.String[]

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

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.
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
System.Threading.Tasks.Task

System.Threading.Tasks.Task representing the asynchronous operation.