如何以编程方式调用Highcharts的chart.events.selection事件
Highcharts 主动编程触发已配置的
chart.events.selection事件实现 核心逻辑说明:selection是Highcharts为图表框选交互绑定的事件,默认仅在用户鼠标拖拽框选时触发,要主动触发不需要模拟用户操作,直接调用已绑定的事件回调、传入符合规范的模拟事件参数即可。
前置准备
首先需要把图表初始化的实例存为当前作用域可访问的变量,同时确保配置中开启了对应框选能力(否则原生selection事件默认无触发路径,但不影响手动调用回调),基础初始化代码调整为:
// 存储可全局访问的chart实例 const chartInstance = Highcharts.chart('container', { chart: { // 如需匹配原生框选逻辑,可按需开启轴选择能力 zoomType: 'x', events: { selection: function (event) { // 你原本写入的selection业务逻辑,比如根据选中范围调整轴极值、渲染统计信息等 if (event.xAxis?.length) { this.xAxis[0].setExtremes(event.xAxis[0].min, event.xAxis[0].max) } } } } })
具体触发实现
方式1:直接调用已绑定的事件回调(无额外依赖)
Highcharts初始化时,会把你在chart.events下配置的所有事件处理函数,完整存储在chartInstance.options.chart.events配置对象上,调用时手动绑定this指向当前chart实例,传入模拟事件参数即可:
// 手动构造符合Highcharts selection事件结构的参数 // 结构完全对齐原生框选生成的event,根据你实际用到的字段按需补充 const mockSelectionEvent = { xAxis: [{ min: Date.UTC(2023, 0, 1), // 模拟选中范围的最小值 max: Date.UTC(2023, 11, 31), // 模拟选中范围的最大值 axis: chartInstance.xAxis[0] }], // 若业务逻辑中用到y轴范围,补充对应yAxis字段即可 type: 'selection', preventDefault: () => {} } // 调用绑定的selection函数,绑定this为当前chart实例,传入模拟事件 chartInstance.options.chart.events.selection.call(chartInstance, mockSelectionEvent)
方式2:使用Highcharts内置事件触发工具
如果你的业务逻辑中绑定了额外的selection事件监听,可以直接用Highcharts官方提供的fireEvent方法全量派发事件:
// 向chart实例派发selection事件,传入构造的mock参数 Highcharts.fireEvent(chartInstance, 'selection', mockSelectionEvent)
注意事项
- 不要空传事件参数触发:原生selection回调逻辑大概率会读取事件携带的轴范围、选中状态等字段,空参数会直接引发字段读取报错,需要把你业务逻辑中用到的所有事件字段都在mock参数里补齐
- 如果你的selection逻辑包含取消选中的分支判断,需要在mock参数中补充对应的方法,例如在mock事件对象上挂载
resetSelection方法,和原生事件结构保持一致 - 两种触发方式效果有细微差异:直接调用方式只触发你在
chart.events.selection中绑定的那一个回调;fireEvent方式会触发所有绑定到chart实例上的selection类型事件监听
内容的提问来源于stack exchange,提问作者Vinoth Balaji
相关产品推荐
相关产品推荐

