函数式组件中react-jsx-highcharts的Tooltip formatter类型适配
react-jsx-highcharts 纯函数式组件下Tooltip富文本的TypeScript适配方案
核心报错根因
类型校验不通过的核心原因,是对Highcharts原生Tooltip.formatter的类型签名理解偏差:
- Highcharts的官方类型定义中,
TooltipFormatterCallbackFunction对应的上下文对象(即社区示例中常用的this.x、this.value、this.points的承载对象)是通过运行时this绑定传递的,并不是作为第一个显式入参传入。 - 把
TooltipFormatterContextObject当成第一个入参传入的写法,和官方定义的函数签名结构不匹配,自然无法通过TS校验。
正确实现方式(完全适配纯函数组件,无类、无React侧this依赖)
只要按照TS的规范给函数补全this类型标注,既可以通过类型校验,又能正常拿到Highcharts注入的运行时上下文,同时不会打断函数组件的作用域访问,具体写法:
// 从Highcharts类型定义中引入需要的类型,仅做类型校验使用,不引入运行时依赖 import type Tooltip from 'highcharts'; import type { TooltipFormatterContextObject } from 'highcharts'; // 组件内直接定义格式化函数,不要写在类里 const YourPolarChart = () => { // 注意:这里用普通函数声明,不要用箭头函数(箭头函数的this是词法绑定,会导致Highcharts无法注入运行时上下文) const tooltipFormatter = function ( // 这是TS专属的this类型标注,编译期做类型校验,运行时不会真的传入这个参数 this: TooltipFormatterContextObject, // 第二个参数才是Highcharts实际传入的Tooltip实例 tooltipInstance: Tooltip ): string { // 直接通过this拿极坐标图的tooltip上下文数据即可 const angleValue = this.x; // 极坐标下对应角度值 const sharedSeriesPoints = this.points; // 因为开了shared属性,这里会拿到当前位置下所有系列的数值 // 直接拼富文本,这里可以无限制访问组件作用域里的props、state、自定义工具函数 return ` <div style="padding: 8px;"> <div>角度值:${angleValue}</div> ${sharedSeriesPoints?.map(point => ` <div style="margin-top: 4px;"> <span style="display:inline-block;width:10px;height:10px;background:${point.color};margin-right:4px"></span> <span>${point.series.name}:${point.y}</span> </div> `).join('')} </div> `; }; return ( <HighchartsProvider Highcharts={Highcharts}> <HighchartsChart polar plotOptions={plotOptions}> <Tooltip shared formatter={tooltipFormatter} /> </HighchartsChart> </HighchartsProvider> ) }
注:上述写法完全符合纯函数式组件的开发约束,代码中不存在任何来自React组件实例的this调用,函数上的this类型标注是TypeScript的编译期语法,仅用于和Highcharts的类型定义做匹配,运行时的this绑定完全由Highcharts内部的图表逻辑完成,和React组件的上下文没有任何耦合。
常见避坑点
- 禁止用箭头函数定义formatter:箭头函数的this是定义时的词法上下文,Highcharts运行时无法覆盖绑定this,会导致读不到this上的tooltip数据,即使临时绕过类型校验,运行时也会出现属性undefined的问题。
- 不需要强行把Highcharts的上下文通过闭包传参:很多人为了绕开this写一堆适配逻辑,其实只要按照TS的this标注规则写,完全不需要额外封装,既符合类型要求,又不依赖类组件写法。
- 极坐标场景不需要做额外类型适配:
TooltipFormatterContextObject上的所有属性在polar模式下完全兼容,x对应角度值、y对应半径值,开了shared后points数组结构和直角坐标系完全一致。
内容的提问来源于stack exchange,提问作者SmeagolGollum
相关产品推荐
相关产品推荐

