feat: top-level selections (#6919)

* refactor: rename unit `selection` property to `params`. * feat: define selections at the top-level spec * feat: handle partial/nested paths for top-level selection `views`. * chore: update schema [CI] * chore: update examples [CI] * fix: add Parameter to unit params type signature for schema validation. * chore: update schema [CI] * Add comment about separate code path for assembling selection signals. Co-authored-by: GitHub Actions Bot <vega-actions-bot@users.noreply.github.com>
vega · Nov 16, 2020 · 9299a83 · 9299a83
1 parent 3018f51
commit 9299a83
Show file tree

Hide file tree

Showing 132 changed files with 929 additions and 245 deletions.
diff --git a/build/vega-lite-schema.json b/build/vega-lite-schema.json
diff --git a/examples/specs/airport_connections.vl.json b/examples/specs/airport_connections.vl.json
@@ -59,7 +59,7 @@
         },
         {"filter": "datum.state !== 'PR' && datum.state !== 'VI'"}
       ],
-      "selection": [{
+      "params": [{
         "name": "org",
         "select": {
           "type": "single",

diff --git a/examples/specs/bar_count_minimap.vl.json b/examples/specs/bar_count_minimap.vl.json
@@ -22,7 +22,7 @@
   }, {
     "height": 200,
     "width": 50,
-    "selection": [{
+    "params": [{
       "name": "brush",
       "select": {
         "type": "interval",

diff --git a/examples/specs/brush_table.vl.json b/examples/specs/brush_table.vl.json
@@ -6,7 +6,7 @@
     "window": [{"op": "row_number", "as": "row_number"}]
   }],
   "hconcat": [{
-    "selection": [{"name": "brush", "select": "interval"}],
+    "params": [{"name": "brush", "select": "interval"}],
     "mark": "point",
     "encoding": {
       "x": {"field": "Horsepower", "type": "quantitative"},

diff --git a/examples/specs/circle_bubble_health_income.vl.json b/examples/specs/circle_bubble_health_income.vl.json
@@ -5,7 +5,7 @@
   "data": {
     "url": "data/gapminder-health-income.csv"
   },
-  "selection": [{
+  "params": [{
     "name": "view",
     "select": "interval",
     "bind": "scales"

diff --git a/examples/specs/concat_bar_layer_circle.vl.json b/examples/specs/concat_bar_layer_circle.vl.json
@@ -46,7 +46,7 @@
       "width": 330,
       "height": 120,
       "mark": "bar",
-      "selection": [{
+      "params": [{
         "name": "pts",
         "select": {"type": "single", "encodings": ["x"]}
       }],

diff --git a/examples/specs/concat_hover.vl.json b/examples/specs/concat_hover.vl.json
@@ -3,7 +3,7 @@
   "description": "Drag out a rectangular brush to highlight points.",
   "data": {"url": "data/cars.json"},
   "hconcat": [{
-    "selection": [{
+    "params": [{
       "name": "hover",
       "select": {
         "type": "single",
@@ -21,7 +21,7 @@
       }
     }
   },{
-    "selection": [{
+    "params": [{
       "name": "hover",
       "select": {
         "type": "single",

diff --git a/examples/specs/concat_hover_filter.vl.json b/examples/specs/concat_hover_filter.vl.json
@@ -9,7 +9,7 @@
     },
     "layer": [
       {
-        "selection": [{
+        "params": [{
           "name": "hover",
           "select": {
             "type": "single",
@@ -32,7 +32,7 @@
     "layer": [
       {
 
-        "selection": [{
+        "params": [{
           "name": "hover",
           "select": {
             "type": "single",

diff --git a/examples/specs/interactive_area_brush.vl.json b/examples/specs/interactive_area_brush.vl.json
@@ -6,7 +6,7 @@
       "y": {"aggregate": "sum", "field": "count"}
   },
   "layer": [{
-    "selection": [{
+    "params": [{
       "name": "brush",
       "select": {"type": "interval", "encodings": ["x"]}
     }],

diff --git a/examples/specs/interactive_bar_select_highlight.vl.json b/examples/specs/interactive_bar_select_highlight.vl.json
@@ -8,7 +8,7 @@
       {"a": "G", "b": 19}, {"a": "H", "b": 87}, {"a": "I", "b": 52}
     ]
   },
-  "selection": [
+  "params": [
     {
       "name": "highlight",
       "select": {

diff --git a/examples/specs/interactive_bin_extent.vl.json b/examples/specs/interactive_bin_extent.vl.json
@@ -8,7 +8,7 @@
   "vconcat": [{
     "width": 963,
     "height": 100,
-    "selection": [{
+    "params": [{
       "name": "brush",
       "select": {"type": "interval", "encodings": ["x"]}
     }],

diff --git a/examples/specs/interactive_brush.vl.json b/examples/specs/interactive_brush.vl.json
@@ -2,7 +2,7 @@
   "$schema": "https://vega.github.io/schema/vega-lite/v4.json",
   "description": "Drag out a rectangular brush to highlight points.",
   "data": {"url": "data/cars.json"},
-  "selection": [{
+  "params": [{
     "name": "brush",
     "select": "interval",
     "value": {"x": [55, 160], "y": [13, 37]}

diff --git a/examples/specs/interactive_concat_layer.vl.json b/examples/specs/interactive_concat_layer.vl.json
@@ -51,7 +51,7 @@
       "width": 330,
       "height": 120,
       "mark": "bar",
-      "selection": [{
+      "params": [{
         "name": "pts",
         "select": {"type": "single", "encodings": ["x"]}
       }],

diff --git a/examples/specs/interactive_dashboard_europe_pop.vl.json b/examples/specs/interactive_dashboard_europe_pop.vl.json
@@ -308,7 +308,7 @@
     {
       "mark": "bar",
       "height": 700,
-      "selection": [{
+      "params": [{
         "name": "brush",
         "select": {"type": "interval", "encodings": ["y"]}
       }],
@@ -331,7 +331,7 @@
     {
       "mark": "bar",
       "height": 700,
-      "selection": [{
+      "params": [{
         "name": "brush",
         "select": {"type": "interval", "encodings": ["y"]}
       }],
@@ -355,7 +355,7 @@
       "mark": "point",
       "width": 260,
       "height": 260,
-      "selection": [{"name": "brush", "select": "interval"}],
+      "params": [{"name": "brush", "select": "interval"}],
       "encoding": {
         "y": {
           "field": "Population_ages_15_64_of_total",

diff --git a/examples/specs/interactive_global_development.vl.json b/examples/specs/interactive_global_development.vl.json
@@ -76,7 +76,7 @@
           }
         },
         {
-          "selection": [
+          "params": [
             {
               "name": "year",
               "value": {"year": 1955},

diff --git a/examples/specs/interactive_index_chart.vl.json b/examples/specs/interactive_index_chart.vl.json
@@ -8,7 +8,7 @@
   "height": 300,
   "layer": [
     {
-      "selection": [{
+      "params": [{
         "name": "index",
         "value": {"x": {"year": 2005, "month": 1, "date": 1}},
         "select": {

diff --git a/examples/specs/interactive_layered_crossfilter.vl.json b/examples/specs/interactive_layered_crossfilter.vl.json
@@ -8,7 +8,7 @@
   "repeat": {"column": ["distance", "delay", "time"]},
   "spec": {
     "layer": [{
-      "selection": [{
+      "params": [{
         "name": "brush",
         "select": {"type": "interval", "encodings": ["x"]}
       }],

diff --git a/examples/specs/interactive_layered_crossfilter_discrete.vl.json b/examples/specs/interactive_layered_crossfilter_discrete.vl.json
@@ -8,7 +8,7 @@
   "repeat": {"column": ["distance", "delay", "time"]},
   "spec": {
     "layer": [{
-      "selection": [{
+      "params": [{
         "name": "brush",
         "select": {"type": "multi", "encodings": ["x"]}
       }],

diff --git a/examples/specs/interactive_legend.vl.json b/examples/specs/interactive_legend.vl.json
@@ -3,7 +3,7 @@
   "width": 300, "height": 200,
   "data": {"url": "data/unemployment-across-industries.json"},
   "mark": "area",
-  "selection": [{
+  "params": [{
     "name": "industry",
     "select": {"type": "multi", "fields": ["series"]},
     "bind": "legend"

diff --git a/examples/specs/interactive_legend_dblclick.vl.json b/examples/specs/interactive_legend_dblclick.vl.json
@@ -3,7 +3,7 @@
   "width": 300, "height": 200,
   "data": {"url": "data/unemployment-across-industries.json"},
   "mark": "area",
-  "selection": [{
+  "params": [{
     "name": "industry",
     "select": {"type": "multi", "fields": ["series"]},
     "bind": {"legend": "dblclick"}

diff --git a/examples/specs/interactive_line_brush_cursor.vl.json b/examples/specs/interactive_line_brush_cursor.vl.json
@@ -17,7 +17,7 @@
       "type": "quantitative"
     }
   },
-  "selection": [{
+  "params": [{
     "name": "brush",
     "select": {
       "type": "interval",

diff --git a/examples/specs/interactive_line_hover.vl.json b/examples/specs/interactive_line_hover.vl.json
@@ -25,7 +25,7 @@
   },
   "layer": [{
     "description": "transparent layer to make it easier to trigger selection",
-    "selection": [{
+    "params": [{
       "name": "hover",
       "value": {"symbol": "AAPL"},
       "select": {

diff --git a/examples/specs/interactive_multi_line_label.vl.json b/examples/specs/interactive_multi_line_label.vl.json
@@ -15,7 +15,7 @@
       "layer": [
         {"mark": "line"},
         {
-          "selection": [{
+          "params": [{
             "name": "label",
             "select": {
               "type": "single",

diff --git a/examples/specs/interactive_multi_line_pivot_tooltip.vl.json b/examples/specs/interactive_multi_line_pivot_tooltip.vl.json
@@ -31,7 +31,7 @@
           {"field": "MSFT", "type": "quantitative"}
         ]
       },
-      "selection": [{
+      "params": [{
         "name": "hover",
         "select": {
           "type": "single",

diff --git a/examples/specs/interactive_multi_line_tooltip.vl.json b/examples/specs/interactive_multi_line_tooltip.vl.json
@@ -21,7 +21,7 @@
     }
   }, {
     "mark": "rule",
-    "selection": [{
+    "params": [{
       "name": "hover",
       "select": {"type": "single", "on": "mouseover", "empty": "none"}
     }],

diff --git a/examples/specs/interactive_overview_detail.vl.json b/examples/specs/interactive_overview_detail.vl.json
@@ -17,7 +17,7 @@
     "width": 480,
     "height": 60,
     "mark": "area",
-    "selection": [{
+    "params": [{
       "name": "brush",
       "select": {"type": "interval", "encodings": ["x"]}
     }],

diff --git a/examples/specs/interactive_paintbrush.vl.json b/examples/specs/interactive_paintbrush.vl.json
@@ -2,7 +2,7 @@
   "$schema": "https://vega.github.io/schema/vega-lite/v4.json",
   "description": "Select multiple points with the shift key.",
   "data": {"url": "data/cars.json"},
-  "selection": [{
+  "params": [{
     "name": "paintbrush",
     "select": {"type": "multi", "on": "mouseover", "nearest": true}
   }],

diff --git a/examples/specs/interactive_paintbrush_color.vl.json b/examples/specs/interactive_paintbrush_color.vl.json
@@ -2,7 +2,7 @@
   "$schema": "https://vega.github.io/schema/vega-lite/v4.json",
   "description": "Select multiple points with the shift key.",
   "data": {"url": "data/cars.json"},
-  "selection": [{
+  "params": [{
     "name": "paintbrush",
     "select": {
       "type": "multi",

diff --git a/examples/specs/interactive_paintbrush_color_nearest.vl.json b/examples/specs/interactive_paintbrush_color_nearest.vl.json
@@ -2,7 +2,7 @@
   "$schema": "https://vega.github.io/schema/vega-lite/v4.json",
   "description": "Select multiple points with the shift key.",
   "data": {"url": "data/cars.json"},
-  "selection": [{
+  "params": [{
     "name": "paintbrush",
     "select": {
       "type": "multi",

diff --git a/examples/specs/interactive_paintbrush_interval.vl.json b/examples/specs/interactive_paintbrush_interval.vl.json
@@ -2,7 +2,7 @@
   "$schema": "https://vega.github.io/schema/vega-lite/v4.json",
   "description": "Select multiple points by dragging an interval.",
   "data": {"url": "data/cars.json"},
-  "selection": [{"name": "paintbrush", "select": "interval"}],
+  "params": [{"name": "paintbrush", "select": "interval"}],
   "mark": "point",
   "encoding": {
     "x": {"field": "Horsepower", "type": "quantitative"},

diff --git a/examples/specs/interactive_paintbrush_simple_all.vl.json b/examples/specs/interactive_paintbrush_simple_all.vl.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://vega.github.io/schema/vega-lite/v4.json",
   "data": {"url": "data/cars.json"},
-  "selection": [{
+  "params": [{
     "name": "paintbrush",
     "select": {"type": "multi", "on": "mouseover", "empty": "all"}
   }],

diff --git a/examples/specs/interactive_paintbrush_simple_none.vl.json b/examples/specs/interactive_paintbrush_simple_none.vl.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://vega.github.io/schema/vega-lite/v4.json",
   "data": {"url": "data/cars.json"},
-  "selection": [{
+  "params": [{
     "name": "paintbrush",
     "select": {"type": "multi", "on": "mouseover", "empty": "none"}
   }],

diff --git a/examples/specs/interactive_panzoom_splom.vl.json b/examples/specs/interactive_panzoom_splom.vl.json
@@ -6,7 +6,7 @@
     "column": ["Miles_per_Gallon", "Acceleration", "Horsepower"]
   },
   "spec": {
-    "selection": [{
+    "params": [{
       "name": "grid",
       "select": "interval",
       "bind": "scales"

diff --git a/examples/specs/interactive_panzoom_vconcat_shared.vl.json b/examples/specs/interactive_panzoom_vconcat_shared.vl.json
@@ -3,7 +3,7 @@
   "data": {"url": "data/cars.json"},
   "vconcat": [
     {
-      "selection": [{
+      "params": [{
         "name": "region",
         "select": "interval",
         "bind": "scales"

diff --git a/examples/specs/interactive_query_widgets.vl.json b/examples/specs/interactive_query_widgets.vl.json
@@ -4,7 +4,7 @@
   "data": {"url": "data/cars.json"},
   "transform": [{"calculate": "year(datum.Year)", "as": "Year"}],
   "layer": [{
-    "selection": [{
+    "params": [{
       "name": "CylYr",
       "value": {"Cylinders": 4, "Year": 1977},
       "select": {"type": "single", "fields": ["Cylinders", "Year"]},

diff --git a/examples/specs/interactive_seattle_weather.vl.json b/examples/specs/interactive_seattle_weather.vl.json
@@ -42,7 +42,7 @@
       "width": 600,
       "height": 300,
       "mark": "point",
-      "selection": [{
+      "params": [{
         "name": "brush",
         "select": {"type": "interval", "encodings": ["x"]}
       }],
@@ -66,7 +66,7 @@
       },
       "width": 600,
       "mark": "bar",
-      "selection": [{
+      "params": [{
         "name": "click",
         "select": {"type": "multi", "encodings": ["color"]}
       }],

diff --git a/examples/specs/interactive_splom.vl.json b/examples/specs/interactive_splom.vl.json
@@ -7,7 +7,7 @@
   "spec": {
     "data": {"url": "data/cars.json"},
     "mark": "point",
-    "selection": [
+    "params": [
       {
         "name": "brush",
         "select": {

diff --git a/examples/specs/interactive_stocks_nearest_index.vl.json b/examples/specs/interactive_stocks_nearest_index.vl.json
@@ -15,7 +15,7 @@
       }
     },
     {
-      "selection": [{
+      "params": [{
         "name": "index",
         "select": {
           "type": "single",

diff --git a/examples/specs/isotype_grid.vl.json b/examples/specs/isotype_grid.vl.json
@@ -124,5 +124,5 @@
     },
     "size": {"value": 90}
   },
-  "selection": [{"name": "highlight", "select": "interval"}]
+  "params": [{"name": "highlight", "select": "interval"}]
 }
diff --git a/examples/specs/normalized/airport_connections_normalized.vl.json b/examples/specs/normalized/airport_connections_normalized.vl.json
@@ -61,7 +61,7 @@
         },
         {"filter": "datum.state !== 'PR' && datum.state !== 'VI'"}
       ],
-      "selection": [
+      "params": [
         {
           "name": "org",
           "select": {