[Feature] Public API to get the laid-out rectangle of a grid

未关闭
#21,780 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

@adityamukesh 已经在做这个了。

开始于 2026年10月7日。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
70/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
typescript

调研方向

Start in src/core/echarts.ts at the implementations of containPixel and convertToPixel, which already resolve a finder object like { gridIndex } to a component. Follow that path to the grid coordinate system's getRect() and expose it as a documented public method returning chart pixels or null before layout. Done means the new API is typed, documented alongside convertToPixel/containPixel, and covered by a test in test/ that checks containLabel and outerBoundsMode shrinking the returned rectangle.

由索引模型根据 Issue 内容生成。

描述

en pending
What problem does this feature solve?

The pixel rectangle of a grid (the plot, where the axes are drawn) is known only after ECharts has laid the chart out, and there is no public way to read it. Apps that draw HTML or SVG over a chart (hover labels, a crosshair line, markers, annotations) need it to put the overlay exactly on the plot.

This has been asked before (#16898, #16480) and answered with the private chart.getModel().getComponent('grid').coordinateSystem.getRect(); #16479 says getModel is private and may change. Everything public falls short:

  • chart.getOption().grid[0] holds the configured values (left, right, outerBoundsMode, ...), not the result of the layout, so it is wrong as soon as containLabel or outerBoundsMode: 'auto' shrink the plot.
  • chart.convertToPixel({ xAxisIndex: 0 }, extreme) needs the axis extent. After a dataZoom, or with scale / automatic ranges, only the model knows it (#17919); getOption().xAxis[0].min/max still holds the configured values after a zoom.
  • chart.containPixel('grid', [x, y]) can find the edges by probing, but that is about log2(size) calls per edge on every layout change.
  • chart.getOption() deep-clones the whole option, data included, on every call, so it cannot be used on every mouse move.

Our case: a pointer drawn in HTML over several synced charts with a few thousand points each (labels at the points nearest to the mouse, a line across the plot and the time under it). It needs the plot's rectangle on every mouse move, so the read has to be cheap, and today it depends on a private method.

What does the proposed API look like?

A getter that mirrors the finders of containPixel and convertToPixel:

chart.getRect({ gridIndex: 0 });
// -> { x: 70, y: 32, width: 460, height: 204 } in chart pixels, or null when the chart has no such grid or is not laid out yet

Or chart.getGridRect(gridIndex?); the name is open. What matters is that it is documented and stable, and that it gives the result of the layout (including outerBoundsMode and containLabel), which is what getRect() of the grid coordinate system holds today.

主要语言
TypeScript
星标
67.7k
派生
19.9k
PR 合并指标
30 天内没有已合并 PR

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

apache/echarts 的其他 Issue

查看 apache/echarts 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。