Skip to content

docs: document ES|QL support in Vega visualizations (#4953)#6022

Merged
florent-leborgne merged 6 commits intomainfrom
docs-issue-4953-vega-esql
Apr 23, 2026
Merged

docs: document ES|QL support in Vega visualizations (#4953)#6022
florent-leborgne merged 6 commits intomainfrom
docs-issue-4953-vega-esql

Conversation

@florent-leborgne
Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne commented Apr 21, 2026

Summary

This PR addresses #4953 with the following changes:

  • explore-analyze/visualize/custom-visualizations-with-vega.md: Adds a new reference subsection Writing ES|QL queries in Vega that explains how to use "%type%": "esql" as a data source in Vega and Vega-Lite. Covers the supported url parameters ("query", "%context%", "%timefield%", "dropNullColumns", "params"), the ?_tstart / ?_tend time parameters, and includes a complete, copy-paste-ready Vega-Lite time series spec lifted from the implementation PR.
  • explore-analyze/query-filter/languages/esql-kibana.md: Adds a version-scoped link to the new Vega section in the Related pages list so readers on the {{esql}} page can discover Vega support.

Snippets use JSON with fully quoted keys (including "%type%", "%context%", "%timefield%") to match the verified examples in elastic/kibana#247186 and ensure reliable copy-paste.

Both additions are scoped to stack: ga 9.4 and serverless: ga, matching the delivery of elastic/kibana#247186.

Resolves

Closes #4953


AI-generated draft - created with Claude Opus 4.7.
Review all generated content for factual accuracy before merging.

Add a reference subsection on the custom Vega visualizations page
explaining how to use ES|QL queries as a data source via the
`%type%: esql` url configuration, and link to it from the ES|QL
in Kibana page.

Made-with: Cursor
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 21, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 21, 2026

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)
File Line Rule Message
explore-analyze/visualize/custom-visualizations-with-vega.md 1323 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

Use JSON-style quoted keys (e.g. "%type%": "esql") in the new Vega
snippets so they can be copy-pasted directly, matching the verified
examples from elastic/kibana#247186.

Made-with: Cursor
Replace the partial data-only snippet with the complete time series
example from elastic/kibana#247186 so readers can copy-paste a working
spec into the custom visualization editor.

Made-with: Cursor
Comment thread explore-analyze/visualize/custom-visualizations-with-vega.md Outdated
@florent-leborgne
Copy link
Copy Markdown
Member Author

I assigned this task to AI, reviewed it, and made any required changes.

Ready for formal review.

elky says go!

@florent-leborgne florent-leborgne marked this pull request as ready for review April 21, 2026 09:24
@florent-leborgne florent-leborgne requested review from a team as code owners April 21, 2026 09:24
Copy link
Copy Markdown
Member

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good! I did want to point out that the first tutorial might be one header level too low - https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6022/explore-analyze/visualize/custom-visualizations-with-vega#_tutorials_create_custom_panels

@florent-leborgne
Copy link
Copy Markdown
Member Author

florent-leborgne commented Apr 22, 2026

@nastasha-solomon yes, this page is way too long and should be broken down anyways - thanks! (That's for later)

@florent-leborgne florent-leborgne enabled auto-merge (squash) April 23, 2026 14:42
@florent-leborgne florent-leborgne merged commit 099c731 into main Apr 23, 2026
7 checks passed
@florent-leborgne florent-leborgne deleted the docs-issue-4953-vega-esql branch April 23, 2026 14:49
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.

Vega now supports ES|QL

3 participants