React PolarChart - tooltip
Configures tooltips.
A tooltip is a miniature rectangle displaying values of a series point. A tooltip appears when the end-user hovers the cursor over a series point. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.
argumentFormat
Formats the point argument before it is displayed in the tooltip. To format the point value, use the format option.
See Also
- format - provides a comprehensive overview of formatting capabilities.
- Data Formatting - shows how to apply formatting to various widget elements.
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 a tooltip.
You can access the following pointInfo object fields:
| Field name | Description |
|---|---|
originalValue |
The value of the represented point as it is set in the data source. |
value |
The value of the represented point. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the value field contains a value of the specified type. |
valueText |
The value of the point being hovered over with applied formatting if the format property is specified |
originalArgument |
The argument value of the represented point as it is set in the data source. |
argument |
The argument value of the represented point. Differs from the originalArgument when the axis argument type differs from the argument type in the data source. In this instance, argument has a similar type as the argument axis. |
argumentText |
The argument value of the represented point with applied formatting if the argumentFormat option is specified. |
seriesName |
The series name of the point being hovered over. |
point |
Information on the point being hovered over. For more information about the field and the point object's methods, refer to the Point topic. |
points |
An array of points with the same argument as the point being hovered over. This field is accessible when the shared option of the tooltip is set to true. |
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 series 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. |
This function's parameter has the following fields:
| Field name | Description |
|---|---|
originalValue |
The value of the represented point as it is set in the data source. |
value |
The value of the represented point. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the value field contains a value of the specified type. |
valueText |
The value of the point being hovered over with applied formatting if the format property is specified |
originalArgument |
The argument value of the represented point as it is set in the data source. |
argument |
The argument value of the represented point. Differs from the originalArgument when the axis argument type differs from the argument type in the data source. In this instance, argument has a similar type as the argument axis. |
argumentText |
The argument value of the represented point with applied formatting if the argumentFormat option is specified. |
seriesName |
The series name of the point being hovered over. |
point |
Information on the point being hovered over. To learn more about the field and methods of the point object, refer to the Point topic. |
points |
An array of points with the same argument as the point being hovered over. This field is accessible when the shared option of the tooltip is set to true. |
this keyword.See Also
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.
shared
Specifies whether the tooltip is shared across all series points with the same argument.
If this option is false, the tooltip displays information only about the point being hovered over.
If this option is set to true, the tooltip also displays information about all series points that have the same argument as the point being hovered over.
See Also
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.