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

Abierto
#376 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
55/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript, node.js, react

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
JavaScript
Estrellas
1
Forks
1
Merge medio
3 h 34 min
PR fusionados (30 d)
213

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de eizedev/pivotkit

Todos los issues de eizedev/pivotkit

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.