microsoft / microsoft/SandDance

Pass Vega specification to Vega Editor for preview and edits

Open
#152 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
TypeScript
Stars
7.1k
Forks
573
Avg merge
8d 9h
Merged PRs (30d)
4

Description

This is a feature request to improve online version of SandDance integration with online Vega Editor.

Synopsis:

Currently, SandDance online version has an option to Open Vega Editor for a chart in Chart Settings -> Tools section, Show Vega spec dialog. However, that dialog only links to online Vega Editor and doesn't pass the generated chart Vega spec for edits and preview in that tool.

Feature request:

Create compact Vega spec json string and Url encode generated Vega json for your chart using json-stringify-pretty-compact and lz-string libraries to pass it as a parameter to Vega Editor.

You can glean some info on how Vega Editor encodes vega specs in this vega-unfurl dev to post: https://dev.to/tarasnovak/vega-unfurl-take-2-5fnb

The general patern is: https://vega.github.io/editor/#/url/vega/<lz-vega-json-compact-compressed-string>

@danmarshall Let me know if you have questions about this integration proposal.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the online SandDance Chart Settings → Tools section and the existing Show Vega spec dialog link. Trace how the generated chart Vega specification reaches that dialog, then verify that the Vega Editor URL contains the compact, encoded specification and opens it for preview and edits.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data-visualization
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.