docs: add plotly gallery examples for the experimental trace types - #693
docs: add plotly gallery examples for the experimental trace types#693jooyoungseo wants to merge 1 commit into
Conversation
The plotly gallery covered none of the experimental types, so thirteen
readings the package supports had nowhere a user could see them work.
Grouped under one "Experimental Plot Types" heading with a single
prototype callout, since every type below it carries the same caveat.
Several are not x-against-y charts at all, so each section says what a
reader actually walks: a gauge is one value against a range, a sankey is
flows between named nodes, a hierarchy is nodes carrying an ancestor path.
Every chunk was extracted from the committed file and run against an
installed build. Two claims came from that pass rather than from
assumption:
- a waterfall's `measure=` is resolved to what the bar does, so a
`relative` bar announces as an increase or a decrease from its sign,
and each point carries start, end and delta.
- treemap, sunburst and icicle produce byte-identical readings, each
node carrying a `path` of its ancestors. They share one section
because the choice between them is visual and does not change what a
reader is told.
The 100% stacked area is deliberately absent: it emits raw values under a
normalized type (#691), and an example would document that as intended.
Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015TFhhzxcMetSHV7z9NCrJ8
ReviewWent through the diff, cross-checked the doc's technical claims against the actual Bug: Choropleth example's
|
What
Adds gallery examples for the experimental plotly trace types.
docs/examples-plotly.qmdpreviously had no experimental types at all — thirteen readings the package supports with nowhere a user could see them work.New
## Experimental Plot Typessection with 14 chunks across 12 subsections, carrying one prototype callout for the whole block rather than repeating it per type.go.Waterfallwaterfallgo.Funnelfunnelgo.Indicatorgaugego.Sankeysankeygo.Treemap/go.Sunburst/go.Icicletreemap/sunburst/iciclego.Parcoordsparallel_coordinatesgo.Parcatsalluvialgo.Choroplethchoroplethgo.Barpolarpolar_areago.Scatterpolarradarbarnorm="percent"stacked_normalized_bargo.ContourcontourNot the usual x-against-y
Several of these have no series to walk in the ordinary sense, so each section says what a reader actually gets rather than assuming left/right over points. A gauge is one value against the range that bounds it. A sankey is flows between named nodes. A hierarchy is nodes each carrying a
pathof ancestors.Measured, not asserted
Every chunk was extracted from the committed file and executed against an installed build:
Two claims came out of that pass rather than from assumption:
A waterfall's
measure=is resolved to what the bar does. Arelativebar is not announced as "relative" — it becomes anincreaseor adecreasefrom its sign, and each point carriesstart,endanddelta. The section gives the measured five-bar table.Treemap, sunburst and icicle produce byte-identical readings. Same node list, same values, same
path. They share one section because the choice between them is a visual one and should not change what a reader is told.Also confirmed rather than assumed:
barnorm="percent"really does announce shares — raw inputs of 30 against 10 come through as 75 and 25, not as the inputs.Deliberately absent
The 100% stacked area is not here. A plotly
groupnormarea emits raw values under astacked_normalized_areatype (#691), so an example would present that as intended behaviour. Worth adding once that is fixed.Checked for overlap first
Before writing, I grepped the existing page's content — not just its headings — for every type below. The only near-hit was the word "percent" in the Pie section, which is about pie percentages. None of these duplicates existing coverage.
That check exists because the previous PR (#690) shipped a stacked area section that duplicated the existing "Area Plot" section, which I had missed by enumerating headings without reading them. The heading there is named for the function family rather than the type, so the name never matched.
This is a docs-only change; no package code is touched.
Generated by Claude Code