Class ChartTooltipSettingsBuilder
Inheritance
System.Object
ChartTooltipSettingsBuilder
Assembly: Syncfusion.EJ2.dll
public class ChartTooltipSettingsBuilder : ControlBuilder
Constructors
Declaration
public ChartTooltipSettingsBuilder()
Declaration
public ChartTooltipSettingsBuilder(ChartTooltipSettings model)
Parameters
Methods
Options for customizing the tooltip borders.
Declaration
public ChartTooltipSettingsBuilder Border(ChartTooltipBorder value)
Parameters
Returns
Declaration
public ChartTooltipSettingsBuilder Border(Action<ChartBorderBuilder> border)
Parameters
Returns
Duration for the Tooltip animation.
Declaration
public ChartTooltipSettingsBuilder Duration(double value)
Parameters
Type |
Name |
Description |
System.Double |
value |
|
Returns
If set to true, enables the tooltip for the data points.
Declaration
public ChartTooltipSettingsBuilder Enable(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
If set to true, tooltip will animate while moving from one point to another.
Declaration
public ChartTooltipSettingsBuilder EnableAnimation(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
If set to true, enables the marker in the chart tooltip.
Declaration
public ChartTooltipSettingsBuilder EnableMarker(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
EnableTextWrap(Boolean)
To wrap the tooltip long text based on available space.
This is only application for chart tooltip.
Declaration
public ChartTooltipSettingsBuilder EnableTextWrap(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
Duration of the fade-out animation for hiding the Tooltip.
Declaration
public ChartTooltipSettingsBuilder FadeOutDuration(double value)
Parameters
Type |
Name |
Description |
System.Double |
value |
|
Returns
Fade Out duration for the Tooltip hide.
Declaration
public ChartTooltipSettingsBuilder FadeOutMode(FadeOutMode value)
Parameters
Returns
The fill color of the tooltip, specified as a valid CSS color string in hex or rgba format.
Declaration
public ChartTooltipSettingsBuilder Fill(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
The format for customizing the tooltip content.
Declaration
public ChartTooltipSettingsBuilder Format(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
The header text for the tooltip. By default, it displays the series name.
Declaration
public ChartTooltipSettingsBuilder Header(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
Specifies the location of the tooltip, relative to the chart.
If x is 20, tooltip moves by 20 pixels to the right of the chart
Declaration
public ChartTooltipSettingsBuilder Location(ChartLocation value)
Parameters
Returns
Declaration
public ChartTooltipSettingsBuilder Location(Action<ChartLocationBuilder> location)
Parameters
Returns
The opacity of the tooltip, expressed as a numerical value.
Declaration
public ChartTooltipSettingsBuilder Opacity(double value)
Parameters
Type |
Name |
Description |
System.Double |
value |
|
Returns
If set to true, a single ToolTip will be displayed for every index.
Declaration
public ChartTooltipSettingsBuilder Shared(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
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
public ChartTooltipSettingsBuilder ShowNearestPoint(bool value)
Parameters
Type |
Name |
Description |
System.Boolean |
value |
|
Returns
A custom template used to format the Tooltip content. You can use ${x} and ${y} as placeholder text to display the corresponding data points.
Declaration
public ChartTooltipSettingsBuilder Template(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
TextStyle(ChartTooltipTextStyle)
Options for customizing the tooltip text appearance.
Declaration
public ChartTooltipSettingsBuilder TextStyle(ChartTooltipTextStyle value)
Parameters
Returns
TextStyle(Action<ChartFontBuilder>)
Declaration
public ChartTooltipSettingsBuilder TextStyle(Action<ChartFontBuilder> textStyle)
Parameters
Returns