JavaScript/jQuery PolarChart - tooltip
Type:
argumentFormat
Formats the point argument before it is displayed in the tooltip. To format the point value, use the format property.
Type:
| undefined
Default Value: undefined
NOTE
DevExtreme UI components provide a wide choice of predefined formats. If you are, however, going to use custom formats, link the Globalize library to your project. Learn how to do this from topics in the Installation section.
See Also
- format - provides a comprehensive overview of formatting capabilities.
- Value Formatting - shows how to apply formatting to various UI component elements.
color
Type:
Default Value: '#ffffff'
This property supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
This property 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.
Default Value: undefined
contentTemplate
Type:
Default Name: undefined
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 property 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 property of the tooltip is set to true. |
customizeTooltip
Type:
| undefined
Function parameters:
pointInfo:
Return Value:
Default Value: undefined
Cannot be used in themes.
This property 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. The PolarChart evaluates the markup. Make sure that it does not contain malicious code. Refer to the following help topic for more information: Potentially Vulnerable API - customizeTooltip. 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 property 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 property of the tooltip is set to true. |
NOTE
As an alternative to the function’s parameter you can use the
this keyword.See Also
shared
Type:
Default Value: false
This property can have one of the following values:
| tooltip.shared | Description |
|---|---|
| false | The tooltip only displays information about a series point that is hovered over with the mouse pointer. |
| true | The tooltip displays information about all series points with the same argument as the point that is hovered over. If this point is included in a stack, the tooltip only displays information about points in this stack and points that do not belong to any stack (if there are any). |
See Also
zIndex
Type:
| undefined
Default Value: undefined
If the UI component's container has the CSS z-index property specified, and tooltips are displayed incorrectly, configure their z-index using this property.
Feedback