fix: automatically add steps if density transform is grouped (#8088)

* fix: automatically add steps if density transform is grouped * chore: update examples [ci skip] Co-authored-by: GitHub Actions Bot <vega-actions-bot@users.noreply.github.com>
vega · Apr 4, 2022 · c95806f · c95806f
1 parent 2ed3b1d
commit c95806f
Show file tree

Hide file tree

Showing 29 changed files with 38 additions and 16 deletions.
diff --git a/examples/compiled/area_density.png b/examples/compiled/area_density.png
diff --git a/examples/compiled/area_density.svg b/examples/compiled/area_density.svg
diff --git a/examples/compiled/area_density_facet.png b/examples/compiled/area_density_facet.png
diff --git a/examples/compiled/area_density_facet.svg b/examples/compiled/area_density_facet.svg
diff --git a/examples/compiled/area_density_facet.vg.json b/examples/compiled/area_density_facet.vg.json
@@ -14,7 +14,8 @@
           "field": "Body Mass (g)",
           "groupby": ["Species"],
           "extent": [2500, 6500],
-          "as": ["value", "density"]
+          "as": ["value", "density"],
+          "steps": 200
         },
         {
           "type": "impute",

diff --git a/examples/compiled/area_density_stacked.png b/examples/compiled/area_density_stacked.png
diff --git a/examples/compiled/area_density_stacked.svg b/examples/compiled/area_density_stacked.svg
diff --git a/examples/compiled/area_density_stacked.vg.json b/examples/compiled/area_density_stacked.vg.json
@@ -17,7 +17,8 @@
           "field": "Body Mass (g)",
           "groupby": ["Species"],
           "extent": [2500, 6500],
-          "as": ["value", "density"]
+          "as": ["value", "density"],
+          "steps": 200
         },
         {
           "type": "impute",

diff --git a/examples/compiled/errorband_2d_horizontal_color_encoding.png b/examples/compiled/errorband_2d_horizontal_color_encoding.png
diff --git a/examples/compiled/errorband_2d_horizontal_color_encoding.svg b/examples/compiled/errorband_2d_horizontal_color_encoding.svg
diff --git a/examples/compiled/errorband_2d_vertical_borders.png b/examples/compiled/errorband_2d_vertical_borders.png
diff --git a/examples/compiled/errorband_2d_vertical_borders.svg b/examples/compiled/errorband_2d_vertical_borders.svg
diff --git a/examples/compiled/errorbar_2d_vertical_ticks.png b/examples/compiled/errorbar_2d_vertical_ticks.png
diff --git a/examples/compiled/errorbar_2d_vertical_ticks.svg b/examples/compiled/errorbar_2d_vertical_ticks.svg
diff --git a/examples/compiled/layer_line_errorband_2d_horizontal_borders_strokedash.png b/examples/compiled/layer_line_errorband_2d_horizontal_borders_strokedash.png
diff --git a/examples/compiled/layer_line_errorband_2d_horizontal_borders_strokedash.svg b/examples/compiled/layer_line_errorband_2d_horizontal_borders_strokedash.svg
diff --git a/examples/compiled/layer_line_errorband_ci.png b/examples/compiled/layer_line_errorband_ci.png
diff --git a/examples/compiled/layer_line_errorband_ci.svg b/examples/compiled/layer_line_errorband_ci.svg
diff --git a/examples/compiled/layer_line_window.svg b/examples/compiled/layer_line_window.svg
diff --git a/examples/compiled/layer_point_errorbar_2d_horizontal_ci.png b/examples/compiled/layer_point_errorbar_2d_horizontal_ci.png
diff --git a/examples/compiled/layer_point_errorbar_2d_horizontal_ci.svg b/examples/compiled/layer_point_errorbar_2d_horizontal_ci.svg
diff --git a/examples/compiled/layer_point_errorbar_ci.png b/examples/compiled/layer_point_errorbar_ci.png
diff --git a/examples/compiled/layer_point_errorbar_ci.svg b/examples/compiled/layer_point_errorbar_ci.svg
diff --git a/examples/compiled/sample_scatterplot.png b/examples/compiled/sample_scatterplot.png
diff --git a/examples/compiled/sample_scatterplot.svg b/examples/compiled/sample_scatterplot.svg
diff --git a/examples/compiled/trellis_selections.svg b/examples/compiled/trellis_selections.svg
diff --git a/examples/compiled/vega_version b/examples/compiled/vega_version
@@ -1 +1 @@
-vega: 5.21.0
+vega: 5.22.1
diff --git a/src/compile/data/density.ts b/src/compile/data/density.ts
@@ -16,6 +16,11 @@ export class DensityTransformNode extends DataFlowNode {
     this.transform = duplicate(transform); // duplicate to prevent side effects
     const specifiedAs = this.transform.as ?? [undefined, undefined];
     this.transform.as = [specifiedAs[0] ?? 'value', specifiedAs[1] ?? 'density'];
+
+    // set steps when we are grouping so that we get consitent sampling points for imputing and grouping
+    if (transform.groupby && transform.minsteps == null && transform.maxsteps == null && transform.steps == null) {
+      this.transform.steps = 200;
+    }
   }
 
   public dependentFields() {

diff --git a/test/compile/data/density.test.ts b/test/compile/data/density.test.ts
@@ -56,6 +56,21 @@ describe('compile/data/fold', () => {
         as: ['A', 'density']
       });
     });
+
+    it('should add steps if we group', () => {
+      const transform: Transform = {
+        density: 'v',
+        groupby: ['a']
+      };
+      const density = new DensityTransformNode(null, transform);
+      expect(density.assemble()).toEqual({
+        type: 'kde',
+        groupby: ['a'],
+        field: 'v',
+        steps: 200,
+        as: ['value', 'density']
+      });
+    });
   });
 
   describe('dependentFields', () => {