Skip to content

Commit

Permalink
Use latest Vega from esm.sh and pin Vega-Lite to the version Altair i…
Browse files Browse the repository at this point in the history
…s expecting.

Add note to NOTES_FOR_MAINTAINERS.md to update the Vega-Lite version in JupyterChart.
  • Loading branch information
jonmmease committed Nov 23, 2023
1 parent 29d6b38 commit fd4d54d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
9 changes: 9 additions & 0 deletions NOTES_FOR_MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ of some docstrings.
Major version updates (e.g. Vega-Lite 1.X->2.X) have required substantial
rewrites, because the internal structure of the schema changed appreciably.

## Updating the Vega-Lite in JupyterChart
To update the Vega-Lite version used in JupyterChart, update the version in the esm.sh URL in `altair/jupyter/js/index.js`.

For example, to update to Vega-Lite 5.15.1, Vega 5 and Vega-Embed 6, the URL should be:

```javascript
import embed from "https://esm.sh/vega-embed@6?deps=vega@5&[email protected]";
```

### Updating vl-convert version bound
When updating the version of Vega-Lite, it's important to ensure that
[vl-convert](https://github.com/vega/vl-convert) includes support for the new Vega-Lite version.
Expand Down
4 changes: 2 additions & 2 deletions altair/jupyter/js/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import embed from "https://esm.sh/vega-embed@6?deps=vega@5.26.1";
import debounce from "https://cdn.jsdelivr.net/npm/[email protected]/debounce/+esm";
import embed from "https://esm.sh/vega-embed@6?deps=vega@5&[email protected].1";
import debounce from "https://esm.sh/[email protected]/debounce";

export async function render({ model, el }) {
let finalize;
Expand Down

0 comments on commit fd4d54d

Please sign in to comment.