In {ProductName}, the data tooltip of the igCategoryChart displays values and titles of series as well as legend badges of series in a tooltip. In addition, it provides many configuration properties of the igDataLegend for filtering series rows and values columns, styling, and formatting values. This tooltip type updates while moving the mouse inside of the plot area of the igCategoryChart.
The data tooltip of the igCategoryChart displays content using a set of three types of rows and four types of columns.
The rows of the data tooltip include the header row, series row(s), and the summary row.
The header row displays the axis label of the point that is hovered, and can be changed using the dataToolTipHeaderText property.
The series row can actually be a set of rows corresponding to each series plotted in the chart. These rows will display the legend badge, series title, actual/abbreviated value of the the series, and abbreviation symbol and unit, if specified.
Finally, there is a summary row that displays the total of all series values. The default summary title can be changed using the dataToolTipSummaryTitleText property of the series. Also, you can use the dataToolTipSummaryType property to customize whether you display the Total, Min, Max, or Average of series values in the summary row.
The following code snippet demonstrates setting the properties mentioned above to have a data tooltip with a Total summary type with a custom title for the summary and a custom header:
In JavaScript:
$("#chart").igCategoryChart({
dataSource: data,
chartType: "column",
toolTipType: "data",
dataToolTipHeaderText: "My Custom Data Tooltip Header",
dataToolTipSummaryType: "total",
dataToolTipSummaryTitleText: "Grand Total:"
});
The columns of the data tooltip include the title, label, value, and units columns. Each series in the chart can have multiple columns for label, value, and units depending on the dataToolTipIncludedColumns or dataToolTipExcludedColumns collections of the chart.
The title column displays legend badges and series titles, which come from the title property of the different series plotted in the chart.
The label column displays the name or abbreviation of the different property paths in the dataToolTipIncludedColumns or dataToolTipExcludedColumns collections of the chart.
The value column displays series values as abbreviated text which can be formatted using the dataToolTipValueFormatAbbreviation property to apply the same abbreviation for all numbers by setting this property to Auto or Shared. Alternatively, a user can select other abbreviations such as Independent, Kilo, Million, etc. Precision of abbreviated values is controlled using the dataToolTipValueFormatMinFractions and dataToolTipValueFormatMaxFractions for minimum and maximum digits, respectively.
The units column displays an abbreviation symbol and/or unit text, which can be set on the tooltip by setting the dataToolTipUnitsText.
The following code snippet demonstrates the unitText and the minimum/maximum fractions set for the data tooltip on the igCategoryChart:
In JavaScript:
$("#chart").igCategoryChart({
dataSource: data,
chartType: "column",
toolTipType: "data",
dataToolTipUnitsText: "K",
dataToolTipValueFormatMinFractions: 2,
dataToolTipValueFormatMaxFractions: 4
});
The igCategoryChart provides properties for styling each type of column in its data tooltip. Each of these properties begins with Title, Label, Value, or Units, and you can style the text's color, font, and margin. For example, if you wanted to set the text color of each of these, you would set the dataToolTipTitleTextColor, dataToolTipLabelTextColor, dataToolTipValueTextColor, and dataToolTipUnitsTextColor properties.
The following code snippet demonstrates how to set the styling properties mentioned above:
In JavaScript:
$("#chart").igCategoryChart({
dataSource: data,
chartType: "column",
toolTipType: "data",
dataToolTipTitleTextColor: "lightgray",
dataToolTipLabelTextColor: "lightgray",
dataToolTipValueTextColor: "green",
dataToolTipUnitsTextColor: "green",
dataToolTipUnitsText: "K"
});
You can set the dataToolTipGroupingMode property to either Grouped or Individual to group content for multiple series into single tooltip or separate content for each series in multiple tooltips. In the Grouped mode, you can customize where the tooltip is shown by setting the dataToolTipGroupedPositionModeX and dataToolTipGroupedPositionModeY properties. This essentially allows you to customize the horizontal and vertical alignments of the tooltip and whether you want it to track to the closest series points to the mouse position or pin the tooltip to edge of plot area.
The following code snippet demonstrates a data tooltip that will be pinned to the top-left of the igCategoryChart as you scroll:
In JavaScript:
$("#chart").igCategoryChart({
dataSource: data,
chartType: "column",
toolTipType: "data",
dataToolTipGroupingMode: "grouped",
dataToolTipGroupedPositionModeX: "pinLeft",
dataToolTipGroupedPositionModeY: "pinTop"
});
The igCategoryChart provides automatic abbreviation of large numbers for its data tooltip using its dataToolTipValueFormatAbbreviation property. This adds a multiplier in the units column such as kilo, million, billion, etc. You can customize the number of fractional digits that are displayed by setting the dataToolTipValueFormatMinFractions and dataToolTipValueFormatMaxFractions. This will allow you to determine the minimum and maximum number of digits that appear after the decimal point, respectively.
The following code snippet demonstrates how to set the minimum and maximum fractions of the data tooltip of the igCategoryChart:
In JavaScript:
$("#chart").igCategoryChart({
dataSource: data,
chartType: "column",
toolTipType: "data",
dataToolTipValueFormatMinFractions: 2,
dataToolTipValueFormatMaxFractions: 4
});
You can change the default decimal display of values within the data tooltip to be currency by changing the dataToolTipValueFormatMode property of the chart. The igCategoryChart also exposes the ability to modify the culture of the displayed currency symbol in the tooltip by using its dataToolTipValueFormatCulture property and setting it to its corresponding culture tag.
For example, the following code snippet will create a chart with the dataToolTipValueFormatCulture set to "en-GB" and the dataToolTipValueFormatMode set to "Currency":
In JavaScript:
$("#chart").igCategoryChart({
dataSource: data,
chartType: "column",
toolTipType: "data",
dataToolTipValueFormatCulture: "en-GB",
dataToolTipValueFormatMode: "currency"
});
View on GitHub