feat(Higcharts plugin): add type for manageTooltipConfig (#139)

* feat(Higcharts plugin): add type for manageTooltipConfig * fix(Higcharts plugin): fix manageTooltipConfig
gravity-ui · Mar 21, 2023 · f781cca · f781cca
1 parent 07f610e
commit f781cca
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 5 deletions.
diff --git a/src/plugins/highcharts/mocks/line.ts b/src/plugins/highcharts/mocks/line.ts
@@ -91,6 +91,13 @@ export const data: HighchartsWidgetData = {
         hideHolidays: false,
         normalizeDiv: false,
         normalizeSub: false,
+        manageTooltipConfig: (config) => {
+            config.lines.forEach((line, index) => {
+                line.commentText = `Some comment ${index + 1}`;
+            });
+
+            return config;
+        },
     },
     libraryConfig: {
         chart: {

diff --git a/src/plugins/highcharts/renderer/helpers/config/config.js b/src/plugins/highcharts/renderer/helpers/config/config.js
@@ -1226,7 +1226,7 @@ function fixTooltip(tooltip, options, event) {
             tooltip.preFixationHeight = height;
         }
 
-        tooltip.lastVisibleRowIndex = null;
+        tooltip.lastVisibleRowIndex = undefined;
         tooltip.update({
             style: {
                 ...tooltip.style,

diff --git a/src/plugins/highcharts/renderer/helpers/highcharts/highcharts.js b/src/plugins/highcharts/renderer/helpers/highcharts/highcharts.js
@@ -267,7 +267,7 @@ function initHighcharts({isMobile}) {
 
     Highcharts.wrap(Highcharts.Tooltip.prototype, 'hide', function (proceed, ...rest) {
         if (this.lastVisibleRowIndex) {
-            this.lastVisibleRowIndex = null;
+            this.lastVisibleRowIndex = undefined;
         }
 
         if (this.scrollHandler && !this.fixed) {
@@ -311,7 +311,7 @@ function initHighcharts({isMobile}) {
 
         if ((!this.fixed || isFixation) && points) {
             if (isFixation) {
-                this.lastVisibleRowIndex = null;
+                this.lastVisibleRowIndex = undefined;
             }
 
             proceed.apply(this, [points, ...rest]);
@@ -366,7 +366,7 @@ function initHighcharts({isMobile}) {
                     `.${TOOLTIP_LIST_CLASS_NAME} .${TOOLTIP_ROW_CLASS_NAME}`,
                 );
 
-                let lastVisibleRowIndex = null;
+                let lastVisibleRowIndex;
 
                 const selectedSeriesIndex = this.chart.hoverPoints.indexOf(this.chart.hoverPoint);
 

diff --git a/src/plugins/highcharts/renderer/helpers/tooltip/index.ts b/src/plugins/highcharts/renderer/helpers/tooltip/index.ts
@@ -249,7 +249,9 @@ export const formatTooltip = (
         cellsRenderers,
         useCompareFrom: data.useCompareFrom,
         isSelectedLine: true,
-        allowComment: selectedLineIndex > tooltip.lastVisibleRowIndex,
+        allowComment:
+            typeof tooltip.lastVisibleRowIndex === 'number' &&
+            selectedLineIndex > tooltip.lastVisibleRowIndex,
     };
 
     // @ts-ignore

diff --git a/src/plugins/highcharts/types/widget.ts b/src/plugins/highcharts/types/widget.ts
@@ -1,13 +1,39 @@
 import type {Highcharts} from './lib';
 import type {HighchartsComment} from './comments';
 import type {DrillDownConfig, StringParams} from './misc';
+import type {TooltipData, TooltipLine} from '../renderer/helpers/tooltip/types';
 
 export type CkHighchartsSeriesOptionsType = Highcharts.SeriesOptionsType & {
     title?: string;
     sname?: string;
     fname?: string;
 };
 
+export type HighchartsManageTooltipConfigOptions = {
+    count: number;
+    lines: TooltipLine[];
+    shared: boolean;
+    this: {
+        x: string;
+        y: number;
+        points: Highcharts.Point[];
+    };
+    activeRowAlwaysFirstInTooltip?: boolean;
+    hiddenRowsNumber?: number;
+    hiddenRowsSum?: string;
+    splitTooltip?: boolean;
+    tooltipHeader?: string;
+    unsafe?: boolean;
+    useCompareFrom?: boolean;
+    withPercent?: boolean;
+    xComments?: TooltipData['xComments'];
+};
+
+export type HighchartsManageTooltipConfig = (
+    options: HighchartsManageTooltipConfigOptions,
+    chart: Highcharts.Chart,
+) => HighchartsManageTooltipConfigOptions;
+
 export type HighchartsWidgetData = {
     data: (
         | CkHighchartsSeriesOptionsType[]
@@ -63,6 +89,10 @@ export type HighchartsWidgetData = {
         drillDown?: DrillDownConfig;
         enableSum?: boolean;
         unsafe?: boolean;
+        /**
+         * Used to modify tooltip data
+         */
+        manageTooltipConfig?: HighchartsManageTooltipConfig;
     };
     libraryConfig: Highcharts.Options;
     params?: StringParams;