Skip to content

Commit 9aeeda2

Browse files
committed
minor api description change
1 parent a1fbcb5 commit 9aeeda2

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

src/__tests__/__snapshots__/documenter.test.ts.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ This property corresponds to "normal" stacking type in Highcharts ([plotOptions.
313313
},
314314
{
315315
"description": "Defines tooltip options of the chart, including:
316-
* \`enabled\` - (optional, boolean) - Hides the tooltip.
316+
* \`enabled\` - (optional, boolean) - Hides the tooltip when set to false.
317317
* \`size\` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
318318
* \`placement\` - (optional, "middle" | "outside") - Specifies preferred tooltip placement.
319319
* \`point\` - (optional, function) - Customizes tooltip series point rendering.
@@ -866,7 +866,7 @@ Supported series types:
866866
},
867867
{
868868
"description": "Defines tooltip options of the chart, including:
869-
* \`enabled\` - (optional, boolean) - Hides the tooltip.
869+
* \`enabled\` - (optional, boolean) - Hides the tooltip when set to false.
870870
* \`size\` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
871871
* \`details\` - (optional, function) - Provides a list of key-value pairs as tooltip's body.
872872
* \`header\` - (optional, function) - Renders a custom tooltip header.

src/cartesian-chart/interfaces.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface CartesianChartProps
4343

4444
/**
4545
* Defines tooltip options of the chart, including:
46-
* * `enabled` - (optional, boolean) - Hides the tooltip.
46+
* * `enabled` - (optional, boolean) - Hides the tooltip when set to false.
4747
* * `size` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
4848
* * `placement` - (optional, "middle" | "outside") - Specifies preferred tooltip placement.
4949
* * `point` - (optional, function) - Customizes tooltip series point rendering.

src/pie-chart/interfaces.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface PieChartProps extends CoreTypes.BaseChartOptions, CoreTypes.Wit
2121

2222
/**
2323
* Defines tooltip options of the chart, including:
24-
* * `enabled` - (optional, boolean) - Hides the tooltip.
24+
* * `enabled` - (optional, boolean) - Hides the tooltip when set to false.
2525
* * `size` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
2626
* * `details` - (optional, function) - Provides a list of key-value pairs as tooltip's body.
2727
* * `header` - (optional, function) - Renders a custom tooltip header.

0 commit comments

Comments
 (0)