Skip to content

docs: custom viz chart types, customization and converting to Vega-Lite - #10029

Open
nishantmonu51 wants to merge 4 commits into
mainfrom
nishant/custom-viz-docs
Open

nishantmonu51 wants to merge 4 commits into
mainfrom
nishant/custom-viz-docs

Conversation

@nishantmonu51

@nishantmonu51 nishantmonu51 commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Docs for the custom viz components added in #9850.

  • Turns the Custom Viz page into a section under Canvas Widgets with three pages: Custom Viz, Chart Types and Vega-Lite. The first keeps the existing URL.
  • Custom Viz covers the gallery, the component editor and test values, params, the query, the chart spec (encodings, field semantics, colors, chartProperties) and adding a custom viz to a canvas.
  • Chart Types lists the 32 chart types by gallery family, with their channels and chartProperties from Flint 0.4.1 and a rendered example per family.
  • Vega-Lite covers converting a chart spec, what converting writes, the rules and .fields templating for a vega_spec (including the JSON escaping from fix: JSON-escape values templated into a component's vega_spec #10042), and six examples: reference line, target highlight, second axis, running total, theme palette and legend selection.
  • Uses the Convert to Vega-Lite wording and the viz/ folder from feat: say "Convert to Vega-Lite" and create custom viz under viz/ #10044.
  • Screenshots are from Rill Developer with the OpenRTB example project, and every YAML example was run there.
  • Also adds custom_components to the feature flag list, links from the canvas pages and the component reference (schema descriptions, component.md regenerated), and a rule in the developer agent's component instructions to keep vega_spec placeholders inside JSON strings.

Checklist:

  • Covered by tests
  • Ran it and it works as intended
  • Reviewed the diff before requesting a review
  • Checked for unhandled edge cases
  • Linked the issues it closes
  • Checked if the docs need to be updated. If so, create a separate Linear DOCS issue
  • Intend to cherry-pick into the release branch
  • I'm proud of this work!

…tom viz docs

Matches the product wording and folder change on main. The confirmation screenshot is renamed to `convert-confirm.png` and still shows the old copy; it needs re-capturing.
Since #10042, a component's vega_spec is resolved with JSON-escaped template
data. Say so where vega_spec is documented: the Templating section of the
Vega-Lite page, the vega_spec schema description (and the generated component
reference), and the developer agent's Vega-Lite rules, which now tell it to
keep every placeholder inside a JSON string.
@nishantmonu51
nishantmonu51 force-pushed the nishant/custom-viz-docs branch from 59847aa to d5cb819 Compare October 21, 2026 06:54
@nishantmonu51 nishantmonu51 changed the title docs: custom viz chart types, customization and Vega-Lite ejection docs: custom viz chart types, customization and converting to Vega-Lite Oct 21, 2026
…move

The query rules said not to rename fields with AS, right above a time
dimension example that needs an alias. Say that an expression aliased back
to its field's name is the exception. The theme palette example now shows
the converted color encoding with the scale to remove.

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