Class ChartTooltipSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
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, including the color and width of the tooltip's border.
Declaration
public ChartTooltipSettingsBuilder Border(ChartTooltipBorder value)
Parameters
Returns
Declaration
public ChartTooltipSettingsBuilder Border(Action<ChartBorderBuilder> border)
Parameters
Returns
Duration of the tooltip animation, specified in milliseconds.
Declaration
public ChartTooltipSettingsBuilder Duration(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
If set to true, enables tooltips for the data points.
Declaration
public ChartTooltipSettingsBuilder Enable(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
If set to true, the tooltip will animate as it moves from one point to another.
Declaration
public ChartTooltipSettingsBuilder EnableAnimation(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
When set to true, highlights all points in the hovered series while dimming points in other series for better focus and clarity.
Declaration
public ChartTooltipSettingsBuilder EnableHighlight(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)
Wraps the tooltip's long text based on the available space.
Note that this feature applies only to chart tooltips.
Declaration
public ChartTooltipSettingsBuilder EnableTextWrap(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Duration of the fade-out animation for hiding the tooltip, in milliseconds.
Declaration
public ChartTooltipSettingsBuilder FadeOutDuration(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Specifies the mode for the fade-out animation when hiding the tooltip.
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
Specifies the format for customizing the content of the tooltip.
Declaration
public ChartTooltipSettingsBuilder Format(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Customizes the header text for the tooltip. By default, this property 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, the tooltip moves 20 pixels to the right of the chart.
Declaration
public ChartTooltipSettingsBuilder Location(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
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 each index.
Declaration
public ChartTooltipSettingsBuilder Shared(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Specifies whether to display the header line in the tooltip.
Declaration
public ChartTooltipSettingsBuilder ShowHeaderLine(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
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 ChartTooltipSettingsBuilder ShowNearestPoint(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Enables or disables the display of tooltips for the nearest data point to the cursor.
Declaration
public ChartTooltipSettingsBuilder ShowNearestTooltip(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
A custom template used to format the tooltip content. Use ${x} and ${y} as placeholders for the corresponding data points.
Declaration
public ChartTooltipSettingsBuilder Template(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TextStyle(ChartTooltipTextStyle)
This property defines the font family, size, style, weight, and color for the tooltip text.
Declaration
public ChartTooltipSettingsBuilder TextStyle(ChartTooltipTextStyle value)
Parameters
Returns
TextStyle(Action<ChartFontBuilder>)
Declaration
public ChartTooltipSettingsBuilder TextStyle(Action<ChartFontBuilder> textStyle)
Parameters
Returns
