Class ChartTooltipSettings

Inheritance
System.Object
Syncfusion.Blazor.BaseComponent
ChartTooltipSettings
Implements
System.IDisposable
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.dll
Syntax
public class ChartTooltipSettings : BaseComponent, IDisposable

Constructors

ChartTooltipSettings()

Declaration
public ChartTooltipSettings()

Properties

Border

Options to customize tooltip borders.

Declaration
public ChartTooltipBorder Border { get; set; }
Property Value
Type Description
ChartTooltipBorder

ChildContent

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

Duration

Duration for the ToolTip animation.

Declaration
public double Duration { get; set; }
Property Value
Type Description
System.Double

Enable

Enables / Disables the visibility of the tooltip.

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

EnableAnimation

If set to true, ToolTip will animate while moving from one point to another.

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

EnableMarker

Enables / Disables the visibility of the marker.

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

EnableTextWrap

To wrap the tooltip long text based on available space. This is only application for chart tooltip.

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

FadeOutDuration

Fade Out duration for the ToolTip hide.

Declaration
public double FadeOutDuration { get; set; }
Property Value
Type Description
System.Double

Fill

The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.

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

Format

Format the ToolTip content.

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

Header

Header for tooltip.

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

jsProperty

Declaration
protected override string jsProperty { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.BaseComponent.jsProperty

mainParent

Declaration
protected override BaseComponent mainParent { get; set; }
Property Value
Type Description
Syncfusion.Blazor.BaseComponent
Overrides
Syncfusion.Blazor.BaseComponent.mainParent

Opacity

The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.

Declaration
public double Opacity { get; set; }
Property Value
Type Description
System.Double

Shared

If set to true, a single ToolTip will be displayed for every index.

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

Template

Custom template to format the ToolTip content. Use ${x} and ${y} as the placeholder text to display the corresponding data point.

Declaration
public RenderFragment<object> Template { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

TemplateData

Declaration
public List<Dictionary<string, object>> TemplateData { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Collections.Generic.Dictionary<System.String, System.Object>>

TemplateID

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

TemplateItems

Declaration
public List<string> TemplateItems { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

TextStyle

Options to customize the ToolTip text.

Declaration
public ChartTooltipTextStyle TextStyle { get; set; }
Property Value
Type Description
ChartTooltipTextStyle

Methods

BuildRenderTree(RenderTreeBuilder)

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

GetJSNamespace()

Declaration
public string GetJSNamespace()
Returns
Type Description
System.String

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.BaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

updateChildProperties(String, Object)

Declaration
public void updateChildProperties(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value

Implements

System.IDisposable