Angular Chart - tooltip
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
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
The pointInfo object has different fields for different series types. The following fields are available for all series types:
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 the 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 tooltip's shared option is set to true. |
size (for bubble series only) |
The size of the bubble being hovered over as it is set in the data source. |
The following pointInfo fields are available for stacked series such as the full-stacked bar or full-stacked area:
Field name | Description |
---|---|
percent |
The percentage value of the point being hovered over. |
percentText |
The percentage value of the point being hovered over. | total |
The total value of all the points with the same argument as the point being hovered over. |
totalText |
The total value of all the points with the same argument as the point being hovered over. This value is displayed with applied formatting if the format option is specified. |
The following pointInfo fields are available for the range-like series, such as range area or range bar:
Field name | Description |
---|---|
originalMinValue |
The value of the first range the point being hovered over as it is set in the data source. |
rangeValue1 |
The first range value of the point being hovered over. Differs from the originalMinValue when the axis value type is specified explicitly. In this instance, the rangeValue1 field contains the first range value of the specified type. |
rangeValue1Text |
The first range value of the point being hovered over with applied formatting if the format property is specified. |
originalValue |
The value of the second range the point being hovered over as it is set in the data source. |
rangeValue2 |
The second range value of the point being hovered over. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the rangeValue2 field contains the second range value in the specified type. |
rangeValue2Text |
The second range value of the point being hovered over with applied formatting if the format property is specified. |
valueText |
A string that contains the following values of the represented point: rangeValue1Text and rangeValue2Text. The format of the string is the following: "*%rangeValue1Text%* - *%rangeValue2Text%*". |
The following pointInfo fields are available for the financial chart series, such as candle stick or stock:
Field name | Description |
---|---|
originalOpenValue |
The open value of the point being hovered over as it is set in the data source. |
openValue |
The open value of the point being hovered over. Differs from the originalOpenValue when the value in the data source is not in a numeric format. |
openValueText |
The open value of the point being hovered over with applied formatting if the format option is specified. |
originalCloseValue |
The close value of the point being hovered over as it is set in the data source. |
closeValue |
The close value of the point being hovered over. Differs from the originalCloseValue when the value in the data source is not in a numeric format. |
closeValueText |
The close value of the point being hovered over with applied formatting if the format option is specified. |
originalHighValue |
The high value of the point being hovered over as it is set in the data source. |
highValue |
The high value of the point being hovered over. Differs from the originalHighValue when the value in the data source is not in a numeric format. |
highValueText |
The high value of the point being hovered over with applied formatting if the format option is specified. |
originalLowValue |
The low value of the point being hovered over as it is set in the data source. |
lowValue |
The low value of the point being hovered over. Differs from the originalLowValue when the value in the data source is not in a numeric format. |
lowValueText |
The low value of the point being hovered over with applied formatting if the format option is specified. |
reductionValue |
The reduction value of the point being hovered over. |
reductionValueText |
The reduction value of the point being hovered over with applied formatting if the format option is specified. |
valueText |
A string that contains the following values of the represented point: highValueText, openValueText, closeValueText and lowValueText. The format of the string is the following: "h: %highValueText% o: %openValueText% c: %closeValueText% l: %lowValueText%". |
this
keyword.Display a Tooltip Demo Tooltip HTML Support Demo
See Also
customizeTooltip
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. |
The pointInfo object has different fields for the different series types. The following fields are available for all the series types:
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 the 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. |
size (for bubble series only) |
The size of the bubble being hovered over as it is set in the data source. |
The folllowing pointInfo fields are available for the stacked-like series such as full-stacked bar or full-stacked area:
Field name | Description |
---|---|
percent |
The percent value of the point being hovered over. |
percentText |
The percent value of the point being hovered over. | total |
The total value of all the points with the same argument as the point being hovered over. |
totalText |
The total value of all the points with the same argument as the point being hovered over. This value is displayed with applied formatting if the format option is specified. |
The folllowing pointInfo fields are available for the range-like series, such as range area or range bar:
Field name | Description |
---|---|
originalMinValue |
The value of the first range the point being hovered over as it is set in the data source. |
rangeValue1 |
The first range value of the point being hovered over. Differs from the originalMinValue when the axis value type is specified explicitly. In this instance, the rangeValue1 field contains the first range value of the specified type. |
rangeValue1Text |
The first range value of the point being hovered over with applied formatting if the format property is specified. |
originalValue |
The value of the second range the point being hovered over as it is set in the data source. |
rangeValue2 |
The second range value of the point being hovered over. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the rangeValue2 field contains the second range value in the specified type. |
rangeValue2Text |
The second range value of the point being hovered over with applied formatting if the format property is specified. |
valueText |
A string that contains the following values of the represented point: rangeValue1Text and rangeValue2Text. The format of the string is the following: "*%rangeValue1Text%* - *%rangeValue2Text%*". |
The folllowing pointInfo fields are available for the financial chart series, such as candle stick or stock:
Field name | Description |
---|---|
originalOpenValue |
The open value of the point being hovered over as it is set in the data source. |
valueText |
A string that contains the following values of the represented point: highValueText, openValueText, closeValueText and lowValueText. The format of the string is the following: "h: %highValueText% o: %openValueText% c: %closeValueText% l: %lowValueText%". |
openValue |
The open value of the point being hovered over. Differs from the originalOpenValue when the value in the data source is not in a numeric format. |
openValueText |
The open value of the point being hovered over with applied formatting if the format option is specified. |
originalCloseValue |
The close value of the point being hovered over as it is set in the data source. |
closeValue |
The close value of the point being hovered over. Differs from the originalCloseValue when the value in the data source is not in a numeric format. |
closeValueText |
The close value of the point being hovered over with applied formatting if the format option is specified. |
originalHighValue |
The high value of the point being hovered over as it is set in the data source. |
highValue |
The high value of the point being hovered over. Differs from the originalHighValue when the value in the data source is not in a numeric format. |
highValueText |
The high value of the point being hovered over with applied formatting if the format option is specified. |
originalLowValue |
The low value of the point being hovered over as it is set in the data source. |
lowValue |
The low value of the point being hovered over. Differs from the originalLowValue when the value in the data source is not in a numeric format. |
lowValueText |
The low value of the point being hovered over with applied formatting if the format option is specified. |
reductionValue |
The reduction value of the point being hovered over. |
reductionValueText |
The reduction value of the point being hovered over with applied formatting if the format option is specified. |
this
keyword.Display a Tooltip Demo Tooltip HTML Support Demo
See Also
location
Specifies whether the tooltip must be located in the center of a series point or on its edge. Applies to bar-like and bubble series only.
Use the ChartTooltipLocation
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Center
and Edge
.
shared
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
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.