Class StockChartTooltipSettings

To specify customization options for stockchart tooltip.

Inheritance

System.Object

StockChartTooltipSettings

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class StockChartTooltipSettings : OwningComponentBase

Constructors

StockChartTooltipSettings()

Declaration

public StockChartTooltipSettings()

Properties

ChildContent

Gets and sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

Duration

Duration for the ToolTip animation.

Declaration

public double Duration { get; set; }

Property Value

Type
System.Double

Enable

Enables / Disables the visibility of the tooltip.

Declaration

public bool Enable { get; set; }

Property Value

Type
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
System.Boolean

EnableMarker

Enables / Disables the visibility of the marker.

Declaration

public bool EnableMarker { get; set; }

Property Value

Type
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
System.Boolean

FadeOutDuration

Fade Out duration for the ToolTip hide.

Declaration

public double FadeOutDuration { get; set; }

Property Value

Type
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
System.String

Format

Format the ToolTip content.

Declaration

public string Format { get; set; }

Property Value

Type
System.String

Header

Header for tooltip.

Declaration

public string Header { get; set; }

Property Value

Type
System.String

Opacity

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

Declaration

public Nullable<double> Opacity { get; set; }

Property Value

Type
System.Nullable<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
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
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

TooltipPosition

Gets and sets the tooltip position for the StockChart. The available modes are,

• Fixed The StockChart tooltip will be placed in the fixed position.
• Nearest The StockChart tooltip moves along with the mouse.

Declaration

public TooltipPosition TooltipPosition { get; set; }

Property Value

Type	Description
TooltipPosition	Customize the StockChart tooltip position. The default value is Fixed.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

SetTooltipOpacity(Theme)

Declaration

protected void SetTooltipOpacity(Theme theme)

Parameters

Type	Name	Description
Theme	theme