fix(types): Fix types for the tooltip contents callback

Fix tooltip.contents callback params types. Close #2693
naver · May 23, 2022 · a0c0355 · stof · Jul 6, 2022 · stof
1 parent 40f4b66
commit a0c0355
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/src/ChartInternal/internals/color.ts b/src/ChartInternal/internals/color.ts
@@ -8,6 +8,7 @@ import {document, window} from "../../module/browser";
 import {$ARC, $COLOR, $SHAPE} from "../../config/classes";
 import {KEY} from "../../module/Cache";
 import {notEmpty, isFunction, isObject, isString} from "../../module/util";
+import {IArcData, IDataRow} from "../data/IData";
 
 /**
  * Set pattern's background color
@@ -103,8 +104,8 @@ export default {
 			$$.patterns = colorizedPatterns;
 		}
 
-		return function(d) {
-			const id: string = d.id || d.data?.id || d;
+		return function(d: IDataRow | IArcData | string): string {
+			const id: string = (d as IDataRow).id || (d as IArcData).data?.id || d as string;
 			const isLine = $$.isTypeOf(id, ["line", "spline", "step"]) || !config.data_types[id];
 			let color;
 

diff --git a/src/config/Options/common/tooltip.ts b/src/config/Options/common/tooltip.ts
@@ -39,7 +39,7 @@ export default {
 	 *  - **Note:**
 	 *    - defaultTitleFormat:
 	 *      - if `axis.x.tick.format` option will be used if set.
-	 *      - otherwise, will return funciton based on tick format type(category, timeseries).
+	 *      - otherwise, will return function based on tick format type(category, timeseries).
 	 *    - defaultValueFormat:
 	 *	    - for Arc type (except gauge, radar), the function will return value from `(ratio * 100).toFixed(1)`.
 	 *	    - for Axis based types, will be used `axis.[y|y2].tick.format` option value if is set.

diff --git a/types/options.d.ts b/types/options.d.ts
@@ -8,7 +8,7 @@ import Bubblecompare from "./plugin/bubblecompare/index";
 import Stanford from "./plugin/stanford/index";
 import TextOverlap from "./plugin/textoverlap/index";
 import {Chart} from "./chart";
-import {IData} from "../src/ChartInternal/data/IData";
+import {IArcData, IData, IDataRow} from "../src/ChartInternal/data/IData";
 
 export interface ChartOptions {
 	/**
@@ -1082,10 +1082,10 @@ export interface TooltipOptions {
 	 */
 	contents?: ((
 		this: Chart,
-		data: any,
-		defaultTitleFormat: string,
-		defaultValueFormat: string,
-		color: any
+		data: IDataRow[],
+		defaultTitleFormat: (x: Date|number|string) => number|string,
+		defaultValueFormat: (value: number, ratio: number|undefined, id: string) => number|string,
+		color: (d: IDataRow|IArcData|string) => string
 	) => string) | {
 		/**
 		 * Set CSS selector or element reference to bind tooltip.