Skip to content

docs: fix tooltip titleSpacing, bodySpacing and footerSpacing descriptions #12393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adityajai119 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix tooltip titleSpacing, bodySpacing and footerSpacing descriptions #12393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/configuration/tooltip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ The `titleFont`, `bodyFont` and `footerFont` options default to the `Chart.defau
| `titleColor` | [`Color`](../general/colors.md) | `'#fff'` | Color of title text.
| `titleFont` | `Font` | `{weight: 'bold'}` | See [Fonts](../general/fonts.md).
| `titleAlign` | `string` | `'left'` | Horizontal alignment of the title text lines. [more...](#text-alignment)
| `titleSpacing` | `number` | `2` | Spacing to add to top and bottom of each title line.
| `titleSpacing` | `number` | `2` | Spacing to add between title lines.
| `titleMarginBottom` | `number` | `6` | Margin to add on bottom of title section.
| `bodyColor` | [`Color`](../general/colors.md) | `'#fff'` | Color of body text.
| `bodyFont` | `Font` | `{}` | See [Fonts](../general/fonts.md).
| `bodyAlign` | `string` | `'left'` | Horizontal alignment of the body text lines. [more...](#text-alignment)
| `bodySpacing` | `number` | `2` | Spacing to add to top and bottom of each tooltip item.
| `bodySpacing` | `number` | `2` | Spacing to add between body lines.
| `footerColor` | [`Color`](../general/colors.md) | `'#fff'` | Color of footer text.
| `footerFont` | `Font` | `{weight: 'bold'}` | See [Fonts](../general/fonts.md).
| `footerAlign` | `string` | `'left'` | Horizontal alignment of the footer text lines. [more...](#text-alignment)
| `footerSpacing` | `number` | `2` | Spacing to add to top and bottom of each footer line.
| `footerSpacing` | `number` | `2` | Spacing to add between footer lines.
| `footerMarginTop` | `number` | `6` | Margin to add before drawing the footer.
| `padding` | [`Padding`](../general/padding.md) | `6` | Padding inside the tooltip.
| `caretPadding` | `number` | `2` | Extra distance to move the end of the tooltip arrow away from the tooltip point.
Expand Down
6 changes: 3 additions & 3 deletions src/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2841,7 +2841,7 @@ export interface TooltipOptions<TType extends ChartType = ChartType> extends Cor
*/
titleFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>;
/**
* Spacing to add to top and bottom of each title line.
* Spacing to add between title lines.
* @default 2
*/
titleSpacing: Scriptable<number, ScriptableTooltipContext<TType>>;
Expand All @@ -2856,7 +2856,7 @@ export interface TooltipOptions<TType extends ChartType = ChartType> extends Cor
*/
titleAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>;
/**
* Spacing to add to top and bottom of each tooltip item.
* Spacing to add between body lines.
* @default 2
*/
bodySpacing: Scriptable<number, ScriptableTooltipContext<TType>>;
Expand All @@ -2876,7 +2876,7 @@ export interface TooltipOptions<TType extends ChartType = ChartType> extends Cor
*/
bodyAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>;
/**
* Spacing to add to top and bottom of each footer line.
* Spacing to add between footer lines.
* @default 2
*/
footerSpacing: Scriptable<number, ScriptableTooltipContext<TType>>;
Expand Down