Skip to content

Errors in Custom Tooltips documentation code example and related samples #5122

Description

@InhumanSoul

In the code example under External (Custom) Tooltips in the documentation the lines

tooltipEl.style.fontFamily = tooltipModel._fontFamily;
tooltipEl.style.fontSize = tooltipModel.fontSize;
tooltipEl.style.fontStyle = tooltipModel._fontStyle;

should presumably be

tooltipEl.style.fontFamily = tooltipModel._bodyFontFamily;
tooltipEl.style.fontSize = tooltipModel.bodyFontSize + 'px';
tooltipEl.style.fontStyle = tooltipModel._bodyFontStyle;

since tooltipModel doesn't contain _fontFamily, fontSize or _fontStyle.

These errors also exist in the samples for line and pie charts with HTML tooltips.

I would also like to suggest that this code example in the documentation should disable the standard tooltips like the samples do, adding:
enabled: false
By the way, the description of this enabled option isn't clear whether it enables/disables only the standard tooltips (excluding custom tooltips) or tooltips altogether (including custom tooltips). Currently it is the former.

Another problem with the example code for custom tooltips in the documentation is that it defines an element with a non-existent CSS class which some people could find a bit confusing:
var span = '<span class="chartjs-tooltip-key" style="' + style + '">
The easiest solution is probably just to remove the class attribute in the documentation example and keep it in the samples where that class is actually defined.

Finally, I would also like to point out that the "link" to the sample mentioned just after the code example is wrong. The correct "link" to that sample should be samples/tooltips/custom-line.html (or http://www.chartjs.org/samples/latest/tooltips/custom-line.html for the live example). However, since there are several relevant examples possibly all should be listed. Alternatively just a link to the page for all the samples could suffice.

(At the time of this issue the current latest documentation/samples are for chart.js 2.7.1.)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions