Charts: add scatter charts (chartType "scatter")

Open
#622 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
68/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
python

Research direction

Start with _add_chart in sdpm/sdpm/engine/builder/elements/chart.py and the named chart round-trip tests in tests/test_chart_roundtrip.py; check how chart data and series colors are currently built. Then trace chart extraction in sdpm/sdpm/engine/converter/chart.py and scatter validation in sdpm/sdpm/engine/schema/lint.py. Done when the listed scatter round-trip, lint, and edit-rebuild cases pass, along with make lint and uv run pytest tests/test_chart_roundtrip.py -v.

Written by the indexing model from the issue text.

Description

enhancement good first issue
What problem would this solve?

Native charts support chartType bar, line, pie and donut only, and all of them plot values against categories. A scatter chart plots two numeric variables against each other (latency vs. payload size, cost vs. throughput, before/after benchmarks), which a category chart cannot show. python-pptx builds scatter charts natively (XL_CHART_TYPE.XY_SCATTER with XyChartData). Today a chartType: "scatter" silently becomes a bar chart (see TestInvalidInput::test_unknown_chart_type_degrades_to_bar).

Proposed solution

Add chartType: "scatter". Its series carry points ([x, y] pairs) instead of values, and it takes no categories:

{
  "type": "chart", "chartType": "scatter",
  "x": 192, "y": 216, "width": 1536, "height": 700,
  "series": [
    {"name": "Lambda", "points": [[128, 45], [256, 30], [512, 22], [1024, 18]], "color": "#FF9900"},
    {"name": "Fargate", "points": [[128, 60], [512, 35], [1024, 25]], "color": "#41B3FF"}
  ],
  "legend": true,
  "valueAxis": {"min": 0},
  "title": "Latency (ms) by memory (MB)"
}
  • Markers only (XL_CHART_TYPE.XY_SCATTER); series color is the marker colour; style.markerSize applies. Connecting lines (XY_SCATTER_LINES*, XY_SCATTER_SMOOTH*) are out of scope for this issue.
  • valueAxis applies to the Y axis as it does today. X-axis options can come in a follow-up; keep the default X axis in this issue.

Files to touch:

  • sdpm/sdpm/engine/builder/elements/chart.py (_add_chart): build the data with XyChartData (add_series(name) then series.add_data_point(x, y)) when chartType is scatter, add it to the type_map, and colour the series markers. The current code always builds CategoryChartData and generates placeholder categories, so this is the main change.
  • sdpm/sdpm/engine/converter/chart.py (extract_chart_element): map XY_SCATTER in type_map and read each series' points. python-pptx's series.values gives the Y values only; read X from the series' c:xVal element. Write points, not categories / values.
  • sdpm/sdpm/engine/schema/lint.py: add scatter to _CHART_TYPES, update the "Specify bar, line, pie, or donut" message, skip the categories/values length check for scatter, and flag a scatter series without points.
  • Docs: the chart section of sdpm/references/guides/slide-json-media.md (chartType list, the points shape, guide list), and a new sdpm/references/guides/chart-scatter.md modelled on chart-line.md. If you add the guide, also add it next to chart-bar / chart-line / chart-pie in sdpm/references/guides/slide-json-spec.md and sdpm/references/workflows/composer.md.
  • CHANGELOG.md: an entry under [Unreleased] → Added.

Done when

  • chartType: "scatter" builds a c:scatterChart, and pptx_to_json reads it back as chartType: "scatter" with series names, points (in order) and colours intact.
  • An edited scatter chart (a changed point) is rebuilt from its JSON, not restored from _chartXml.
  • TestInvalidInput::test_unknown_chart_type_degrades_to_bar uses another unknown type name instead of scatter.
  • Lint accepts scatter and still rejects unknown types.
  • make lint and uv run pytest tests/test_chart_roundtrip.py -v pass.

Tests to copy: TestChartTypes::test_line_markers, TestSeriesAndCategories::test_non_ascii_and_float_values and TestColors::test_line_series_color in tests/test_chart_roundtrip.py (they use _one_chart / _built_chart, no LibreOffice needed).

Which area?

Slide generation / engine (layouts, elements, charts)

🤖 Created by Kiro Crew

Dominant language
Python
Stars
136
Forks
13
Avg merge
7h 43m
Merged PRs (30d)
180

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws-samples/sample-spec-driven-presentation-maker

All issues in aws-samples/sample-spec-driven-presentation-maker

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.