Skip to content

docs(heatmap): document cell cursor options - #540

Draft
diysimon wants to merge 1 commit into
apache:masterfrom
diysimon:docs-heatmap-cursor-20569
Draft

diysimon wants to merge 1 commit into
apache:masterfrom
diysimon:docs-heatmap-cursor-20569

Conversation

@diysimon

Copy link
Copy Markdown

Summary

Document heatmap cell cursor configuration in English and Chinese for the implementation in apache/echarts#21798 (draft), addressing apache/echarts#20569.

  • Reuse the shared series.cursor documentation and describe per-item data.cursor overrides and inheritance.
  • Cover Cartesian, calendar, and matrix cells, including progressive rendering; explicitly exclude silent geo raster heatmaps.
  • Add version markers for 6.1.0, the current development version of the companion implementation. The release version can be adjusted during maintainer review.

Validation

  • npm ci --ignore-scripts --no-audit --no-fund: passed.
  • npm run build:site: passed (webpack compiled successfully).
  • node build.js --env dev: passed; both languages' generated option JSON and Markdown contain the new cursor sections.
  • git diff --check: passed.
  • npm run format: blocked by the existing formatter's missing ../editor/common/blockHelper module. Neither that module nor editor/common/parseBlocks is present in the checked-out upstream tree. The two documentation files follow the surrounding template style; no formatter changes are included.

Validation ran locally on macOS with Node 22.14.0. The repository's Node 18 CI environment was not run locally. Generated site assets are excluded from this change.

Other information

Documentation and this description were prepared with OpenAI Codex. Submitted as a draft alongside the code change for maintainer review.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant