Class ChartTooltipSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

ChartTooltipSettings

Namespace: Syncfusion.EJ2.Charts

Assembly: Syncfusion.EJ2.dll

Syntax

public class ChartTooltipSettings : EJTagHelper

Constructors

ChartTooltipSettings()

Declaration

public ChartTooltipSettings()

Properties

Border

Options for customizing the tooltip borders, including the color and width of the tooltip's border.

Declaration

public ChartTooltipBorder Border { get; set; }

Property Value

Type	Description
ChartTooltipBorder	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

Duration

Duration of the tooltip animation, specified in milliseconds.

Declaration

public double Duration { get; set; }

Property Value

Type	Description
System.Double	The default value is 300

Enable

If set to true, enables tooltips for the data points.

Declaration

public bool Enable { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableAnimation

If set to true, the tooltip will animate as it moves from one point to another.

Declaration

public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableHighlight

When set to true, highlights all points in the hovered series while dimming points in other series for better focus and clarity.

Declaration

public bool EnableHighlight { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableMarker

If set to true, enables the marker in the chart tooltip.

Declaration

public bool EnableMarker { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableTextWrap

Wraps the tooltip's long text based on the available space.

Note that this feature applies only to chart tooltips.

Declaration

public bool EnableTextWrap { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

FadeOutDuration

Duration of the fade-out animation for hiding the tooltip, in milliseconds.

Declaration

public double FadeOutDuration { get; set; }

Property Value

Type	Description
System.Double	The default value is 1000

FadeOutMode

Specifies the mode for the fade-out animation when hiding the tooltip.

Declaration

public FadeOutMode FadeOutMode { get; set; }

Property Value

Type	Description
FadeOutMode	The default value is FadeOutMode.Move

Fill

The fill color of the tooltip, specified as a valid CSS color string in hex or rgba format.

Declaration

public string Fill { get; set; }

Property Value

Type	Description
System.String	The default value is null

Format

Specifies the format for customizing the content of the tooltip.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String	The default value is null

Header

Customizes the header text for the tooltip. By default, this property displays the series name.

Declaration

public string Header { get; set; }

Property Value

Type	Description
System.String	The default value is null

Location

Specifies the location of the tooltip relative to the chart. If x is 20, the tooltip moves 20 pixels to the right of the chart.

Declaration

public object Location { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Opacity

The opacity of the tooltip, expressed as a numerical value.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

Shared

If set to true, a single tooltip will be displayed for each index.

Declaration

public bool Shared { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ShowNearestPoint

Specifies whether the nearest points should be included in the shared tooltip. By default, the nearest data points are displayed. Set this property to false to exclude the nearest point.

Declaration

public bool ShowNearestPoint { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Template

A custom template used to format the tooltip content. Use ${x} and ${y} as placeholders for the corresponding data points.

Declaration

public string Template { get; set; }

Property Value

Type	Description
System.String	The default value is null

TextStyle

This property defines the font family, size, style, weight, and color for the tooltip text.

Declaration

public ChartTooltipTextStyle TextStyle { get; set; }

Property Value

Type	Description
ChartTooltipTextStyle	The default value is null