Repository navigation
docs: fix tooltip titleSpacing, bodySpacing and footerSpacing descriptions - #12393
Open
adityajai119 wants to merge 1 commit into
Open
adityajai119 wants to merge 1 commit into
adityajai119 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #11459
The tooltip docs and the
TooltipOptionsJSDoc describetitleSpacing,bodySpacingandfooterSpacingas spacing added to the top and bottom of each line or item. The tooltip plugin only adds this spacing between consecutive lines:getTooltipSize()adds(lineCount - 1) * spacing, anddrawTitle()/drawBody()remove the spacing after the last line. A single-line title, body or footer gets no extra space, which is why the option appears to have no effect.This changes the three descriptions in
docs/configuration/tooltip.mdand the matching JSDoc insrc/types/index.d.tsto say the spacing is added between lines. No code changes.Checked by measuring
chart.tooltip.heightwith each option set to 0 and 30:titleSpacingbodySpacingfooterSpacingbodySpacingalso applies between the lines of a single multi-line label.AI-assisted: drafted with an AI coding agent; the measurements above were run locally.