https://github.com/vega/vega-render-service
A service to render Vega visualizations
https://github.com/vega/vega-render-service
renderer vega vega-lite
Last synced: 6 months ago
JSON representation
A service to render Vega visualizations
- Host: GitHub
- URL: https://github.com/vega/vega-render-service
- Owner: vega
- Archived: true
- Created: 2019-10-12T19:04:17.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T14:33:34.000Z (almost 2 years ago)
- Last Synced: 2025-01-13T00:47:43.943Z (9 months ago)
- Topics: renderer, vega, vega-lite
- Language: TypeScript
- Homepage: https://render-vega.vercel.app
- Size: 2.31 MB
- Stars: 18
- Watchers: 6
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vega Service to Generate Images
[](https://github.com/vega/vega-render-service/actions)
**Deprecated. Please use https://github.com/vega/vl-convert-service.**
Deployed at https://render-vega.vercel.app/. We will update the service with new version of Vega and Vega-Lite and change the API.
## Dev Setup
Install dependencies with `yarn`.
## Development Instructions
1. Clone the repository.
```
$ git clone git@github.com:vega/vega-render-service.git
```
2. Install all dependencies.
```
$ yarn install
```
3. Run the back-end server.
```
$ yarn start
```
4. Run sample test command
```
$ scripts/savePdf.sh
```
6. Go to the home route (which usually is `http://localhost:8090/`). Otherwise
it will be mentioned in the console where the above command is run.
## Documentation
You can find examples at in [`scripts`](https://github.com/vega/vega-render-service/tree/master/scripts).
```
/handle : to return a pdf/png/svg file
Params:
++ Request Body:
A JSON spec with the form of
{
"specs": {
"$schema": "https://vega.github.io/schema/vega/v5.json",
"width": 400,
"height": 200,
...
}
}
++ Request Headers:
Content-Type: application/json
Accept: image/png OR application/pdf or image/svg
```