Add support for converting Vega and Vega-Lite specs to Vega editor UR…

…Ls (#104) * Add support for converting vega/vega-lite specs to vega editor URLs * Add fullscreen option * README update
vega · Sep 14, 2023 · 06d6d4c · 06d6d4c
1 parent 416b592
commit 06d6d4c
Show file tree

Hide file tree

Showing 10 changed files with 301 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/thirdparty_rust.yaml b/thirdparty_rust.yaml
diff --git a/vl-convert-python/src/lib.rs b/vl-convert-python/src/lib.rs
@@ -439,6 +439,40 @@ fn vegalite_to_pdf(
     }))
 }
 
+/// Convert a Vega-Lite spec to a URL that opens the chart in the Vega editor
+///
+/// Args:
+///     vl_spec (str | dict): Vega-Lite JSON specification string or dict
+///     fullscreen (bool): Whether to open the chart in full screen in the editor
+/// Returns:
+///     str: URL string
+#[pyfunction]
+#[pyo3(text_signature = "(vl_spec, fullscreen)")]
+fn vegalite_to_url(vl_spec: PyObject, fullscreen: Option<bool>) -> PyResult<String> {
+    let vl_spec = parse_json_spec(vl_spec)?;
+    Ok(vl_convert_rs::converter::vegalite_to_url(
+        &vl_spec,
+        fullscreen.unwrap_or(false),
+    )?)
+}
+
+/// Convert a Vega spec to a URL that opens the chart in the Vega editor
+///
+/// Args:
+///     vg_spec (str | dict): Vega JSON specification string or dict
+///     fullscreen (bool): Whether to open the chart in full screen in the editor
+/// Returns:
+///     str: URL string
+#[pyfunction]
+#[pyo3(text_signature = "(vg_spec, fullscreen)")]
+fn vega_to_url(vg_spec: PyObject, fullscreen: Option<bool>) -> PyResult<String> {
+    let vg_spec = parse_json_spec(vg_spec)?;
+    Ok(vl_convert_rs::converter::vega_to_url(
+        &vg_spec,
+        fullscreen.unwrap_or(false),
+    )?)
+}
+
 /// Helper function to parse an input Python string or dict as a serde_json::Value
 fn parse_json_spec(vl_spec: PyObject) -> PyResult<serde_json::Value> {
     Python::with_gil(|py| -> PyResult<serde_json::Value> {
@@ -535,10 +569,12 @@ fn vl_convert(_py: Python, m: &PyModule) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(vegalite_to_png, m)?)?;
     m.add_function(wrap_pyfunction!(vegalite_to_jpeg, m)?)?;
     m.add_function(wrap_pyfunction!(vegalite_to_pdf, m)?)?;
+    m.add_function(wrap_pyfunction!(vegalite_to_url, m)?)?;
     m.add_function(wrap_pyfunction!(vega_to_svg, m)?)?;
     m.add_function(wrap_pyfunction!(vega_to_png, m)?)?;
     m.add_function(wrap_pyfunction!(vega_to_jpeg, m)?)?;
     m.add_function(wrap_pyfunction!(vega_to_pdf, m)?)?;
+    m.add_function(wrap_pyfunction!(vega_to_url, m)?)?;
     m.add_function(wrap_pyfunction!(register_font_directory, m)?)?;
     m.add_function(wrap_pyfunction!(get_local_tz, m)?)?;
     m.add_function(wrap_pyfunction!(get_themes, m)?)?;

diff --git a/vl-convert-python/thirdparty_rust.yaml b/vl-convert-python/thirdparty_rust.yaml
diff --git a/vl-convert-rs/Cargo.toml b/vl-convert-rs/Cargo.toml
@@ -32,6 +32,7 @@ log = "0.4.20"
 env_logger = "0.10.0"
 http = "0.2.9"
 image = {version="0.24.7", features=["jpeg"]}
+lz-str = "0.2.1"
 
 [dev-dependencies]
 tokio = {version="1.32", features=["macros", "rt"]}

diff --git a/vl-convert-rs/src/converter.rs b/vl-convert-rs/src/converter.rs
@@ -987,6 +987,32 @@ pub fn encode_png(pixmap: Pixmap, ppi: f32) -> Result<Vec<u8>, AnyError> {
     Ok(data)
 }
 
+pub fn vegalite_to_url(vl_spec: &serde_json::Value, fullscreen: bool) -> Result<String, AnyError> {
+    let spec_str = serde_json::to_string(vl_spec)?;
+    let compressed_data = lz_str::compress_to_encoded_uri_component(&spec_str);
+    let view = if fullscreen {
+        "/view".to_string()
+    } else {
+        String::new()
+    };
+    Ok(format!(
+        "https://vega.github.io/editor/#/url/vega-lite/{compressed_data}{view}"
+    ))
+}
+
+pub fn vega_to_url(vg_spec: &serde_json::Value, fullscreen: bool) -> Result<String, AnyError> {
+    let spec_str = serde_json::to_string(vg_spec)?;
+    let compressed_data = lz_str::compress_to_encoded_uri_component(&spec_str);
+    let view = if fullscreen {
+        "/view".to_string()
+    } else {
+        String::new()
+    };
+    Ok(format!(
+        "https://vega.github.io/editor/#/url/vega/{compressed_data}{view}"
+    ))
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -1057,4 +1083,138 @@ mod tests {
             .unwrap();
         println!("vg_spec2: {}", vg_spec2);
     }
+
+    #[test]
+    fn test_convert_vegalite_to_url() {
+        let vl_spec: serde_json::Value = serde_json::from_str(r#"
+{
+    "data": {"url": "https://raw.githubusercontent.com/vega/vega-datasets/master/data/seattle-weather.csv"},
+    "mark": "bar",
+    "encoding": {
+        "x": {"timeUnit": "month", "field": "date", "type": "ordinal"},
+        "y": {"aggregate": "mean", "field": "precipitation"}
+    }
+}
+        "#).unwrap();
+
+        let url = vegalite_to_url(&vl_spec, false).unwrap();
+        let expected = concat!(
+            "https://vega.github.io/editor/#/url/vega-lite/",
+            "N4IgJghgLhIFygK4CcA28QAspQA4Gc4B6I5CAdwDoBzASyk0QCNF8BTZAYwHsA7KNv0o8AtkQBubahAlSIAWkg",
+            "x2UfERER8A5ESUz20KKjbzybaJg7D84kAF8ANCA3IA1hiYRkIJ4J5haXmp4UAAPEJAoWhE2AFVeegwRPgYfEAA",
+            "zWjZUMAwlNjSoAE9cArgQbmQA3gh0RxAiiIhqamQ5ASTzXjTM7Nzy3DbOWlx6aFo+ezs7IA",
+        );
+        println!("{url}");
+        assert_eq!(url, expected);
+    }
+
+    #[test]
+    fn test_convert_vega_to_url() {
+        let vl_spec: serde_json::Value = serde_json::from_str(
+            r#"
+{
+  "$schema": "https://vega.github.io/schema/vega/v5.json",
+  "description": "A basic stacked bar chart example.",
+  "width": 500,
+  "height": 200,
+  "padding": 5,
+
+  "data": [
+    {
+      "name": "table",
+      "values": [
+        {"x": 0, "y": 28, "c": 0}, {"x": 0, "y": 55, "c": 1},
+        {"x": 1, "y": 43, "c": 0}, {"x": 1, "y": 91, "c": 1},
+        {"x": 2, "y": 81, "c": 0}, {"x": 2, "y": 53, "c": 1},
+        {"x": 3, "y": 19, "c": 0}, {"x": 3, "y": 87, "c": 1},
+        {"x": 4, "y": 52, "c": 0}, {"x": 4, "y": 48, "c": 1},
+        {"x": 5, "y": 24, "c": 0}, {"x": 5, "y": 49, "c": 1},
+        {"x": 6, "y": 87, "c": 0}, {"x": 6, "y": 66, "c": 1},
+        {"x": 7, "y": 17, "c": 0}, {"x": 7, "y": 27, "c": 1},
+        {"x": 8, "y": 68, "c": 0}, {"x": 8, "y": 16, "c": 1},
+        {"x": 9, "y": 49, "c": 0}, {"x": 9, "y": 15, "c": 1}
+      ],
+      "transform": [
+        {
+          "type": "stack",
+          "groupby": ["x"],
+          "sort": {"field": "c"},
+          "field": "y"
+        }
+      ]
+    }
+  ],
+
+  "scales": [
+    {
+      "name": "x",
+      "type": "band",
+      "range": "width",
+      "domain": {"data": "table", "field": "x"}
+    },
+    {
+      "name": "y",
+      "type": "linear",
+      "range": "height",
+      "nice": true, "zero": true,
+      "domain": {"data": "table", "field": "y1"}
+    },
+    {
+      "name": "color",
+      "type": "ordinal",
+      "range": "category",
+      "domain": {"data": "table", "field": "c"}
+    }
+  ],
+
+  "axes": [
+    {"orient": "bottom", "scale": "x", "zindex": 1},
+    {"orient": "left", "scale": "y", "zindex": 1}
+  ],
+
+  "marks": [
+    {
+      "type": "rect",
+      "from": {"data": "table"},
+      "encode": {
+        "enter": {
+          "x": {"scale": "x", "field": "x"},
+          "width": {"scale": "x", "band": 1, "offset": -1},
+          "y": {"scale": "y", "field": "y0"},
+          "y2": {"scale": "y", "field": "y1"},
+          "fill": {"scale": "color", "field": "c"}
+        },
+        "update": {
+          "fillOpacity": {"value": 1}
+        },
+        "hover": {
+          "fillOpacity": {"value": 0.5}
+        }
+      }
+    }
+  ]
+}
+        "#,
+        )
+        .unwrap();
+
+        let url = vega_to_url(&vl_spec, true).unwrap();
+        println!("{url}");
+        let expected = concat!(
+            "https://vega.github.io/editor/#/url/vega/",
+            "N4IgJAzgxgFgpgWwIYgFwhgF0wBwqgegIDc4BzJAOjIEtMYBXAI0poHsDp5kTykSArJQBWENgDsQAGhAATONA",
+            "BONHJnaT0AQQAETJBBpRtETEigBrOLN1JF22Lcza4ADyQIcAGziVpIAO40svRoAgAMYTLwNGRYaABMETI4SLK",
+            "yNOJkoTKySKZoANqg4u5waCCmTN5+xEieDAqFoC5okSAAngkAHDJQrQC+Us2tMp2oAgK9aACMg8Oo06NoACwA",
+            "zFOoYXMgLQtLqACciyB9C9u78ftdx6dbQzsJ+wLrJzPnaC9j0wcbd-OfaC6AHYNrN7rtlk9Lq9Nu9UJCOisej",
+            "CwfNJojUPEEbc4eixssfii4QA2K4gmF-B6oUkY4k006oqnkr7knHgtDMhKst7s1DIsbE5Fs+b8mb0nnzQn4wn",
+            "CqlSmbohn9AC6MkwiiQ4ggADM2IoEE0Ku0cGV0CYzOY-GRFGwGDgmGMCg9VSAxIpMGhQNqaHBPLJyn1BiBvb7",
+            "-ehOiqVTJoHVGqgiiASghTQ81caU3pxP6ZBrMinAsEYH5ZGxkBlPXI8ih0JVqjIQ37yi1+tskynOmmTeVPBk4L",
+            "Y-LmyCnorEPTJxIZTeqGjIAF5wG1oadwHKlpDl1CgXL5GtIKples+xvh6YgFv3NsBtiePV+TDp8p69IlTwDzVD",
+            "gN5ch6jtyNcbrcq3KWsD2DI8w1eFsXSQFw4wTPUfXED10CYNhsFLPwY2qdAWjnDJ5F2RkELgJDuzgbUx1dKBY3",
+            "KX9Z3w1w3hdZBFHMCBDXvLt0EUOAoEo7UbQNTdKx3Co92qIMSKgNh5ArEjMAXCtdlALCU1wsDQybM8ZALEJhNU",
+            "rSZEzMNjjYbVtQgOBkIAWjBDEVOo7DEUPTTwzCbSOniCsDPDPwGwg9pTyDb1PFffTHJTaSb0UPzwIDM8gztbdT",
+            "S9GhQoAeRSKA6DGUBanqU1ZiDGA2FIGLhJCzxMrMHKK3yhpWkoAQWyg-ogA/view",
+        );
+        assert_eq!(url, expected);
+    }
 }