Vue Sparkline - tooltip
Configures the tooltip.
A tooltip is a miniature rectangle displaying widget data. The tooltip appears when the end-user hovers the cursor over the widget. You can enable/disable the tooltip, change its appearance and format its text using fields of the tooltip configuration object.
color
Colors all tooltips.
This option supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
This option sets one color for all tooltips. You can specify a particular tooltip's color in the tooltip.customizeTooltip function.
container
Specifies the container in which to draw tooltips. The default container is the HTML DOM <body> element.
contentComponent
An alias for the contentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
contentRender
An alias for the contentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
contentTemplate
Specifies a custom template for tooltips.
Information on the points that belong to the series that is pressed or hovered over.
You can access the following pointsInfo fields:
| Field name | Description |
|---|---|
originalFirstValue |
The first value of a sparkline specified in the dataSource. |
firstValue |
The first value of a sparkline with formatting applied if the format option is specified. |
originalLastValue |
The last value of a sparkline as it is specified in the dataSource. |
lastValue |
The last value of a sparkline with applied formatting if the format option is specified. |
originalMinValue |
The minimum value of a sparkline as it is specified in the dataSource. |
minValue |
The minimum value of a sparkline with applied formatting if the format option is specified. |
originalMaxValue |
The maximum value of a sparkline as it is specified in the dataSource. |
maxValue |
The maximum value of a sparkline with applied formatting if the format option is specified. |
The following fields are available for a sparkline of the "winloss" type only.
| Field name | Description |
|---|---|
originalThresholdValue |
The threshold value of a winloss sparkline as it is assigned to the winlossThreshold option. |
thresholdValue |
The threshold value of a winloss sparkline with applied formatting if the format option is specified. |
cornerRadius
Makes all the tooltip's corners rounded.
The following table demonstrates how the corner's curvature depends on the cornerRadius value:
| cornerRadius | Result |
|---|---|
cornerRadius: 0 |
 |
cornerRadius: 15 |
 |
cornerRadius: 35 |
 |
customizeTooltip
Allows you to change tooltip appearance.
Information on the point being pressed or hovered over with the mouse pointer.
The tooltip's text or markup and appearance settings.
This option should be assigned a function that returns an object with the following fields:
| Field name | Description |
|---|---|
text |
The tooltip's text. |
html |
The HTML markup displayed in a tooltip. To use external resources (for example, images) in the markup, specify the size of the area they occupy beforehand. |
color |
The tooltip's color. |
fontColor |
The color of the tooltip's text. |
borderColor |
The color of the tooltip's border. |
You can access the following fields of the Sparkline:
| Field name | Description |
|---|---|
originalFirstValue |
The first value of a sparkline as it is specified in a dataSource |
firstValue |
The first value of a sparkline with applied formatting if the format option is specified. |
originalLastValue |
The last value of a sparkline as it is specified in a data source. |
lastValue |
The last value of a sparkline with applied formatting if the format option is specified. |
originalMinValue |
The minimum value of a sparkline as it is specified in a data source. |
minValue |
The minimum value of a sparkline with applied formatting if the format option is specified. |
originalMaxValue |
The maximum value of a sparkline as it is specified in a data source. |
maxValue |
The maximum value of a sparkline with applied formatting if the format option is specified. |
The following fields are available for a sparkline of the "winloss" type only:
| Field name | Description |
|---|---|
originalThresholdValue |
The threshold value of a winloss sparkline as it is assigned to the winlossThreshold option. |
thresholdValue |
The threshold value of a winloss sparkline with applied formatting if the format option is specified. |
To access the fields above, use the function's parameter and the this object.
To get general information on data formatting, refer to the Data Formatting topic.
opacity
Specifies tooltips' transparency.
This option accepts a value from 0 to 1, where 0 makes tooltips completely transparent, and 1 makes them opaque.
paddingLeftRight
Generates an empty space, measured in pixels, between a tooltip's left/right border and its text.
paddingTopBottom
Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text.
zIndex
Specifies a tooltip's z-index.
If the widget's container has the CSS z-index property specified, and tooltips are displayed incorrectly, configure their z-index using this option.
If you have technical questions, please create a support ticket in the DevExpress Support Center.