React Sparkline - 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
This option supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
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.
customizeTooltip
This option should be assigned a function returning a specific object. The following fields can be specified in this object.
color
Specifies the color of a tooltip.text
Specifies the text displayed by a tooltip.html
Specifies the HTML markup displayed by a tooltip.NOTEIf you are going to use external resources (for example, images) in the markup, specify the size of the area they will occupy beforehand.fontColor
Specifies the color of the text displayed by a tooltip.borderColor
Specifies the color of the tooltip border.
When implementing a callback function for this option, you can access different types of values indicated by a sparkline. For this purpose, use the following fields of the this object.
- originalFirstValue
Contains the first value of a sparkline as it is specified in a data source. - firstValue
Contains the first value of a sparkline with applied formatting if the format option is specified. - originalLastValue
Contains the last value of a sparkline as it is specified in a data source. - lastValue
Contains the last value of a sparkline with applied formatting if the format option is specified. - originalMinValue
Contains the minimum value of a sparkline as it is specified in a data source. - minValue
Contains the minimum value of a sparkline with applied formatting if the format option is specified. - originalMaxValue
Contains the maximum value of a sparkline as it is specified in a data source. - maxValue
Contains 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.
- originalThresholdValue
Contains the threshold value of a winloss sparkline as it is assigned to the winlossThreshold option. - thresholdValue
Contains the threshold value of a winloss sparkline with applied formatting if the format option is specified.
To access the fields above, you can use the function's parameter as well as the this object.
To get general information on data formatting, refer to the Data Formatting topic.
horizontalAlignment
Tooltip alignment is no longer useful because the tooltips are aligned automatically.
verticalAlignment
Tooltip alignment is no longer useful because the tooltips are aligned automatically.
zIndex
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.