Class ChartTooltipSettings
Inherited Members
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartTooltipSettings : EJTagHelper
Constructors
ChartTooltipSettings()
Declaration
public ChartTooltipSettings()
Properties
Border
Options to customize tooltip borders.
Declaration
[HtmlAttributeName("border")]
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 | Description |
---|---|
MvcTemplate<System.Object> |
Duration
Duration for the ToolTip animation.
Declaration
[HtmlAttributeName("duration")]
public double Duration { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Enable
Enables / Disables the visibility of the tooltip.
Declaration
[HtmlAttributeName("enable")]
public bool Enable { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableAnimation
If set to true, ToolTip will animate while moving from one point to another.
Declaration
[HtmlAttributeName("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableMarker
Enables / Disables the visibility of the marker.
Declaration
[HtmlAttributeName("enableMarker")]
public bool EnableMarker { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableTextWrap
To wrap the tooltip long text based on available space. This is only application for chart tooltip.
Declaration
[HtmlAttributeName("enableTextWrap")]
public bool EnableTextWrap { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
FadeOutDuration
Fade Out duration for the ToolTip hide.
Declaration
[HtmlAttributeName("fadeOutDuration")]
public double FadeOutDuration { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 1000 |
FadeOutMode
Fade Out duration for the Tooltip hide.
Declaration
[HtmlAttributeName("fadeOutMode")]
public FadeOutMode FadeOutMode { get; set; }
Property Value
Type | Description |
---|---|
FadeOutMode | The default value is FadeOutMode.Move |
Fill
The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.
Declaration
[HtmlAttributeName("fill")]
public string Fill { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Format
Format the ToolTip content.
Declaration
[HtmlAttributeName("format")]
public string Format { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Header
Header for tooltip. By default, the shared tooltip displays the point x value and the series name for each individual tooltip.
Declaration
[HtmlAttributeName("header")]
public string Header { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Opacity
The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.
Declaration
[HtmlAttributeName("opacity")]
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 every index.
Declaration
[HtmlAttributeName("shared")]
public bool Shared { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
ShowNearestPoint
By default, the nearest points will be included in the shared tooltip; however, you can set it to false to exclude the nearest value from the tooltip.
Declaration
[HtmlAttributeName("showNearestPoint")]
public bool ShowNearestPoint { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
Template
Custom template to format the ToolTip content. Use ${x} and ${y} as the placeholder text to display the corresponding data point.
Declaration
[HtmlAttributeName("template")]
public string Template { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TextStyle
Options to customize the ToolTip text.
Declaration
[HtmlAttributeName("textStyle")]
public ChartTooltipTextStyle TextStyle { get; set; }
Property Value
Type | Description |
---|---|
ChartTooltipTextStyle | The default value is null |