Class StockChartStockTooltipSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
StockChartStockTooltipSettingsBuilder
Assembly: Syncfusion.EJ2.dll
public class StockChartStockTooltipSettingsBuilder : ControlBuilder
Constructors
Declaration
public StockChartStockTooltipSettingsBuilder()
Declaration
public StockChartStockTooltipSettingsBuilder(StockChartStockTooltipSettings model)
Parameters
Methods
Options to customize tooltip borders.
Declaration
public StockChartStockTooltipSettingsBuilder Border(StockChartBorder value)
Parameters
Returns
Declaration
public StockChartStockTooltipSettingsBuilder Border(Action<StockChartBorderBuilder> border)
Parameters
Returns
Duration for the ToolTip animation.
Declaration
public StockChartStockTooltipSettingsBuilder Duration(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Enables / Disables the visibility of the tooltip.
Declaration
public StockChartStockTooltipSettingsBuilder 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 StockChartStockTooltipSettingsBuilder EnableAnimation(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Enables / Disables the visibility of the marker.
Declaration
public StockChartStockTooltipSettingsBuilder 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 StockChartStockTooltipSettingsBuilder EnableTextWrap(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Fade Out duration for the ToolTip hide.
Declaration
public StockChartStockTooltipSettingsBuilder FadeOutDuration(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Fade Out duration for the Tooltip hide.
Declaration
public StockChartStockTooltipSettingsBuilder FadeOutMode(FadeOutMode value)
Parameters
Returns
The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.
Declaration
public StockChartStockTooltipSettingsBuilder Fill(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Format the ToolTip content.
Declaration
public StockChartStockTooltipSettingsBuilder Format(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Header for tooltip. By default, the shared tooltip displays the point x value and the series name for each individual tooltip.
Declaration
public StockChartStockTooltipSettingsBuilder Header(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.
Declaration
public StockChartStockTooltipSettingsBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Specifies the tooltip position. They are:
fixed - Place the tooltip in the fixed position.
nearest- Tooltip moves along with the mouse.
Declaration
public StockChartStockTooltipSettingsBuilder Position(TooltipPosition value)
Parameters
Returns
If set to true, a single ToolTip will be displayed for every index.
Declaration
public StockChartStockTooltipSettingsBuilder Shared(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Specifies whether to display the header line in the tooltip.
Declaration
public StockChartStockTooltipSettingsBuilder ShowHeaderLine(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 StockChartStockTooltipSettingsBuilder 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 StockChartStockTooltipSettingsBuilder ShowNearestTooltip(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Custom template to format the ToolTip content. Use ${x} and ${y} as the placeholder text to display the corresponding data point.
Declaration
public StockChartStockTooltipSettingsBuilder Template(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TextStyle(StockChartFont)
Options to customize the ToolTip text.
Declaration
public StockChartStockTooltipSettingsBuilder TextStyle(StockChartFont value)
Parameters
Returns
TextStyle(Action<StockChartFontBuilder>)
Declaration
public StockChartStockTooltipSettingsBuilder TextStyle(Action<StockChartFontBuilder> textStyle)
Parameters
Returns
