Charts: port the tooltip and hover behaviour of the ECharts module

オープン
#376 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
55/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript, node.js, react

調査の方向性

Start with packages/pivotkit-core/src/chart.js, chart-style.js, packages/pivotkit-react/src/chart.jsx and chart-tooltip.js; compare the tooltip state flow with the linked ECharts module files. Add pure tooltip reduction tests with node --test, then run the browser tests in all three engines with real pointer input and the strict CSP page. Done when the listed hover cases pass, empty series are omitted, pie and donut tooltips remain unchanged, and the report SVG golden output is unchanged.

索引モデルが issue の本文から書いたものです。

説明

area:core area:react enhancement

The ECharts module of powershell-universal-components got a better tooltip in 0.3.0 (#80, review fixes in #85, decision in #79). pivotkit still lists every series at the category, wherever the pointer is: on the sales playground's stacked bars, pointing at the Software segment of Austria shows all three series and no total. I want the same behaviour here.

Today: chart.js sets tooltip.trigger: "axis" for bar, line and area; chart-style.js sets emphasis.focus: "series" for bars and lines; chart-tooltip.js prints one line per series, also for series without a value (an empty value).

Behaviour to port

  • The element under the pointer wins (bar, line, area): a bar, a stacked segment or a line point shows that element alone. How the module does it: trigger stays axis; mouseover/mouseout with a dataIndex set a per-instance hover state, then hideTip + showTip at the pointer (ECharts does not call the formatter again at the same axis position otherwise); the formatter reduces the axis items to the hovered one (tooltipMode.js, EChart.jsx).
  • A stacked segment shows its value plus a "Total" row for its stack.
  • Between elements (the gap between bars, the line or the area fill itself, which have no dataIndex): every series at the category. Between stacked bars: the total only.
  • Stacked area and stacked line: every series plus the total.
  • Series without a value at that category are left out instead of an empty line.
  • A hovered bar lights up alone: emphasis.focus: "self" for bars and axisPointer.triggerEmphasis: false, so the axis position does not light up every bar. Lines keep focus: "series".
  • Pie, donut and heatmap keep the item tooltip; no hover tracking there.

What differs in pivotkit

  • The tooltip stays DOM nodes from chart-tooltip.js (no inline style attributes, text as textContent), so the strict CSP pages keep passing. The total row is a node like the others; its weight and its rule line come from --pk-* tokens (--pk-weight-strong, --pk-border), text at --pk-chart-text-size, no new literal (tokens.test.js).
  • The hover state lives per chart instance in chart.jsx and reaches the formatter through decorate(); the reduction (hovered item, gap, totals) is a pure function in chart-tooltip.js, tested with node --test.
  • Only category axes and at most 50 categories, so the module's fixes for time/value axes (totals by x value), lines above 200 points, -SecondaryY, -Group, the toolbox's line/bar/stack switch and -TooltipTemplate have nothing to port. When 100 % stacked (#36) lands, the total adds the original values, as the module's -Normalize does.
  • The HTML report's SVG has no hover: decorateOption is called there without a tooltip formatter; the emphasis change must leave pivotkit-report's golden output unchanged.
  • Keyboard: the chart has no keyboard tooltip, the text summary and the table stay the way to read every value. The totals per category are in the table; nothing new is reachable by hover only.
  • A switch between this and "every series" is #106's Display setting (chart.tooltip); this issue makes the default. #106's proposed default (item only for grouped bars) is replaced by the element-under-the-pointer rule above.
  • docs/use/charts.md (the tooltip paragraph) and its screenshots.

Tests

Browser tests in the three engines with real pointer input (page.mouse.move onto the drawn element, positions from the chart's own pixel conversion, not fixed fractions):

  • Stacked bar: a segment shows its series and the total; the gap between two bars the total only; the hovered segment lights up alone.
  • Grouped bar: a bar shows its series only.
  • Stacked area (a view with type: "area", stacked: true): the fill shows every series and the total; a point shows that point and the total.
  • Line: a point shows that point; the line between points shows every series; a series without a value is left out.
  • Pie and donut: a slice shows that slice, as today.
  • Every case on the strict CSP page without a CSP violation, and the markup test in usability.spec.js still passes.
主要言語
JavaScript
スター
1
フォーク
1
平均マージ
3時間 34分
マージ済み PR(30日)
213

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

eizedev/pivotkit のほかの issue

eizedev/pivotkit の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。