Initialize Selections #4139

arvind · 2018-08-20T02:38:38Z

This PR relies on the refactoring introduced by #4068, so please merge that one first.

This PR adds an init property to selection definitions to initialize them using the fields or encoding channels a selection is projected over. For example, here is an updated version of our interactive_query_widgets example that initializes the selection to select cars with 8 cylinders manufactured in 1971.

{
  "$schema": "https://vega.github.io/schema/vega-lite/v2.json",
  "description": "Drag the sliders to highlight points.",
  "data": {"url": "data/cars.json"},
  "transform": [{"calculate": "year(datum.Year)", "as": "Year"}],
  "layer": [{
    "selection": {
      "CylYr": {
        "type": "single", "fields": ["Cylinders", "Year"],
        "init": {"Cylinders": 4, "Year": 1977},
        "bind": {
          "Cylinders": {"input": "range", "min": 3, "max": 8, "step": 1},
          "Year": {"input": "range", "min": 1969, "max": 1981, "step": 1}
        }
      }
    },
    "mark": "circle",
    "encoding": {
      "x": {"field": "Horsepower", "type": "quantitative"},
      "y": {"field": "Miles_per_Gallon", "type": "quantitative"},
      "color": {
        "condition": {"selection": "CylYr", "field": "Origin", "type": "nominal"},
        "value": "grey"
      }
    }
  }, {
    "transform": [{"filter": {"selection": "CylYr"}}],
    "mark": "circle",
    "encoding": {
      "x": {"field": "Horsepower", "type": "quantitative"},
      "y": {"field": "Miles_per_Gallon", "type": "quantitative"},
      "color": {"field": "Origin", "type": "nominal"},
      "size": {"value": 100}
    }
  }]
}

Similarly, an updated interactive_brush example to initialize the brush selection is as follows:

{
  "$schema": "https://vega.github.io/schema/vega-lite/v2.json",
  "description": "Drag out a rectangular brush to highlight points.",
  "data": {"url": "data/cars.json"},
  "selection": {
    "brush": {
      "type": "interval",
      "init": {"x": [55, 160], "y": [13, 37]}
    }
  },
  "mark": "point",
  "encoding": {
    "x": {"field": "Horsepower", "type": "quantitative"},
    "y": {"field": "Miles_per_Gallon", "type": "quantitative"},
    "color": {
      "condition": {"selection": "brush", "field": "Cylinders", "type": "ordinal"},
      "value": "grey"
    }
  }
}

Fixes #3409, #3431, and vega/altair#599.

/cc @jakevdp

arvind · 2018-08-20T18:28:56Z

Tagged as blocked until #4068 is merged (which itself is blocked by vega/vega-parser#89). But, once the upstream PRs are merged, this one should be good to go. Compile- and runtime tests are passing locally.

arvind · 2018-08-22T14:24:08Z

With this spec, an infinite loop occurs when initializing the interval selection. I suspect something to do with scale triggers on the filter. Marked this PR as WIP until I have a chance to resolve this bug.

{
  "layer": [
    {
      "mark": {"type": "point", "color": "lightgray"},
      "selection": {
        "box": {
          "type": "interval", 
          "init": {"x": [50, 100], "y": [5, 10]
          }
        }
      }
    },
    {
      "mark": "point",
      "encoding": {
        "color": {
          "type": "quantitative", "field": "Cylinders", 
          "legend": false
        }
      },
      "transform": [{"filter": {"selection": "box"}}]
    }
  ],
  "encoding": {
    "x": {"type": "quantitative", "field": "Horsepower"},
    "y": {"type": "quantitative", "field": "Acceleration"}
  },
  "data": {"url": "data/cars.json"},
  "$schema": "https://vega.github.io/schema/vega-lite/v2.4.1.json"
}

arvind · 2018-10-11T17:19:30Z

After investigating this issue, I suspect there may be a bug in Vega (vega/vega#1428) where signals continue to listen for scale updates even if they're marked as react: false.

arvind · 2018-10-12T15:45:40Z

Hooray, with Vega 4.3, this PR is no longer blocked and ready for review as well @domoritz, @kanitw! And I've verified that the infinite loop bug observed/discussed above has also been fixed in Vega (and doesn't require any changes in Vega-Lite).

domoritz

Please update the documentation as well.

I'll make a full review after #4068 has been merged.

arvind · 2018-10-13T19:38:04Z

@domoritz: As there'll be several documentation updates related to all the new selections work, I wanted to do all of it in a separate more comphreneisve pass/PR rather than piecemeal if that's ok.

domoritz · 2018-10-13T20:14:53Z

That makes sense. If you think this will take more than a week, please create an issue that describes what needs to be documented.

domoritz · 2018-10-13T20:21:50Z

Does this PR support initialization of selections with dates? What about booleans? I think it would be great if we supported the same types that are supported as values in encodings.

domoritz · 2018-10-13T20:51:24Z

examples/specs/interactive_brush.vl.json

@@ -4,7 +4,8 @@
  "data": {"url": "data/cars.json"},
  "selection": {
    "brush": {
-      "type": "interval"
+      "type": "interval",
+      "init": {"x": [55, 160], "y": [13, 37]}


Shouldn't we see the brush in the SVG as well? See https://github.com/vega/vega-lite/pull/4139/files?short_path=b21ff41#diff-b21ff41954cf78b8b1141416d74085d5

domoritz · 2018-10-17T07:29:30Z

Let me know when you get the chance to update the PR. I'd like to make a release soon so we can test these changes thoroughly.

arvind · 2018-10-17T21:04:10Z

Supporting datetime objects proved trickier than I expected since it involves juggling expression strings with regular JSON primitives. But, I think I got it working. And also extended initialization to support initializing multi selections with an array of values.

Unfortunately, merging this issue is blocked by three issues/PRs in Vega:

Signal scale updates on initialization vega#1433 which results in a bug where the brush mark doesn't appear for initialized interval selections (introduced, ironically, when React: false continues to listen for scale updates vega#1428 fixed our infinite loop bug above)
Initialize a bound signal with expression vega#1435 which results in a bug when initializing a bound selection (introduced as datetimes can currently only be initialized via an expression function in update)
Fix identity typing vega-util#10 which provides correct typings for the identity function, and without which the CI will not run succesfully.

domoritz · 2018-10-17T21:37:45Z

Okay, let's wait for a Vega release then. Luckily, no other PR is blocked by this and we can make a new Vega-Lite rc release without this PR.

eharkins · 2018-11-01T01:12:36Z

To clarify, the solution involving the init property, that will solve problems like vega/vega#1435, will also be added to Vega in addition to Vega-Lite once you have a chance to merge this and/or a Vega version of the same PR? Looking forward to having this functionality in Vega! Thanks

kanitw · 2019-02-23T17:41:57Z

I just resolved conflicts and clean up the typings (while trying to preserve the logic).

@domoritz and @arvind -- can one of you double check so we can merge this for 3.0?

kanitw · 2019-02-23T18:17:42Z

src/compile/selection/transforms/project.ts

+        if (isIntervalSelection(selDef)) {
+          selCmpt.init = parseInit(selDef.init);
+        } else {
+          const init = isArray(selDef.init) ? selDef.init : [selDef.init];


We could use array again here once we have vega/vega#1618 in, but I'd say let's just merge this.

That relies on the Vega 5 transition to let's do it later.

Need another review.

src/selection.ts

test/compile/selection/inputs.test.ts

domoritz · 2019-02-23T22:27:17Z

Not sure why the yarn lockfile needs to change but okay.

kanitw · 2019-02-23T22:33:08Z

Not sure why the yarn lockfile needs to change but okay.

Good catch! I think that's a result of auto-conflict merge. I'll remove it.

kanitw · 2019-02-23T22:54:03Z

🎉

domoritz · 2020-01-25T04:21:27Z

src/compile/selection/selection.ts

+    const str = init.map(v => assembleInit(v, wrap)).join(', ');
+    return `[${str}]`;
+  } else if (isDateTime(init)) {
+    return wrap(dateTimeExpr(init));


Shouldn't this be dateTimeExpr(init, true)?

arvind force-pushed the as/initSelections branch from c5c5c44 to c475bb3 Compare August 20, 2018 18:22

arvind changed the title ~~[WIP] Initialize Selections~~ Initialize Selections Aug 20, 2018

arvind added the Blocked 🕐 For issues that are blocked by other issues label Aug 20, 2018

arvind requested review from domoritz and kanitw August 20, 2018 18:28

arvind changed the title ~~Initialize Selections~~ [WIP] Initialize Selections Aug 22, 2018

This was referenced Aug 24, 2018

Binding documentation vega/altair#1113

Merged

Default Binding Selection vega/altair#1121

Closed

arvind force-pushed the as/initSelections branch from 130a791 to a0f4bc9 Compare October 12, 2018 15:35

arvind removed the Blocked 🕐 For issues that are blocked by other issues label Oct 12, 2018

arvind changed the title ~~[WIP] Initialize Selections~~ Initialize Selections Oct 12, 2018

arvind force-pushed the as/initSelections branch from a0f4bc9 to 018fea0 Compare October 12, 2018 20:50

domoritz reviewed Oct 13, 2018

View reviewed changes

arvind force-pushed the as/initSelections branch 3 times, most recently from 9a54954 to d787382 Compare October 13, 2018 19:12

domoritz reviewed Oct 13, 2018

View reviewed changes

arvind added the Blocked 🕐 For issues that are blocked by other issues label Oct 17, 2018

arvind force-pushed the as/initSelections branch from 59101af to 6914fe2 Compare October 17, 2018 20:59

kanitw force-pushed the as/initSelections branch from 329c30e to b968296 Compare February 23, 2019 17:39

kanitw previously approved these changes Feb 23, 2019

View reviewed changes

kanitw force-pushed the as/initSelections branch from b968296 to d110f89 Compare February 23, 2019 17:40

kanitw requested a review from domoritz February 23, 2019 17:40

kanitw force-pushed the as/initSelections branch 2 times, most recently from 763fce2 to 835e440 Compare February 23, 2019 17:50

kanitw added 3 commits February 23, 2019 09:52

Fix typings while preserving logic + Add stricter type for selectionCmpt

4f96f97

Fix init description

abdc534

Rename multiSignals => singleOrMultiSignals

bd1b707

kanitw force-pushed the as/initSelections branch from 835e440 to bd1b707 Compare February 23, 2019 17:52

Travis CI added 2 commits February 23, 2019 17:58

[Travis] Update schema (build: 21313)

5f45378

[Travis] Update examples (build: 21313)

2c81e16

kanitw reviewed Feb 23, 2019

View reviewed changes

domoritz reviewed Feb 23, 2019

View reviewed changes

src/selection.ts Show resolved Hide resolved

domoritz reviewed Feb 23, 2019

View reviewed changes

test/compile/selection/inputs.test.ts Show resolved Hide resolved

Remove unnecessary change to yarn.lock

9c0f544

kanitw merged commit 07fcab9 into master Feb 23, 2019

kanitw deleted the as/initSelections branch February 23, 2019 22:53

kanitw mentioned this pull request Feb 23, 2019

Make selection init work without projection #4575

Closed

arvind mentioned this pull request Mar 8, 2019

[FR] Defining initial state in query widgets #3431

Closed

cwickham mentioned this pull request Mar 14, 2019

Seat map should initialize to most recent year or-house-vis/party#1

Open

saulshanabrook mentioned this pull request Aug 21, 2019

Initial value for interval scales selection #5319

Closed

arvind mentioned this pull request Aug 29, 2019

feat: enable initialization of scale-bound selections. #5352

Merged

domoritz reviewed Jan 25, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initialize Selections #4139

Initialize Selections #4139

arvind commented Aug 20, 2018 •

edited

Loading

arvind commented Aug 20, 2018

arvind commented Aug 22, 2018

arvind commented Oct 11, 2018

arvind commented Oct 12, 2018 •

edited

Loading

domoritz left a comment

arvind commented Oct 13, 2018

domoritz commented Oct 13, 2018

domoritz commented Oct 13, 2018

domoritz Oct 13, 2018

domoritz commented Oct 17, 2018

arvind commented Oct 17, 2018 •

edited

Loading

domoritz commented Oct 17, 2018

eharkins commented Nov 1, 2018

kanitw commented Feb 23, 2019

kanitw Feb 23, 2019 •

edited

Loading

domoritz Feb 23, 2019

domoritz commented Feb 23, 2019

kanitw commented Feb 23, 2019

kanitw commented Feb 23, 2019

domoritz Jan 25, 2020

Initialize Selections #4139

Initialize Selections #4139

Conversation

arvind commented Aug 20, 2018 • edited Loading

arvind commented Aug 20, 2018

arvind commented Aug 22, 2018

arvind commented Oct 11, 2018

arvind commented Oct 12, 2018 • edited Loading

domoritz left a comment

Choose a reason for hiding this comment

arvind commented Oct 13, 2018

domoritz commented Oct 13, 2018

domoritz commented Oct 13, 2018

domoritz Oct 13, 2018

Choose a reason for hiding this comment

domoritz commented Oct 17, 2018

arvind commented Oct 17, 2018 • edited Loading

domoritz commented Oct 17, 2018

eharkins commented Nov 1, 2018

kanitw commented Feb 23, 2019

kanitw Feb 23, 2019 • edited Loading

Choose a reason for hiding this comment

domoritz Feb 23, 2019

Choose a reason for hiding this comment

domoritz commented Feb 23, 2019

kanitw commented Feb 23, 2019

kanitw commented Feb 23, 2019

domoritz Jan 25, 2020

Choose a reason for hiding this comment

arvind commented Aug 20, 2018 •

edited

Loading

arvind commented Oct 12, 2018 •

edited

Loading

arvind commented Oct 17, 2018 •

edited

Loading

kanitw Feb 23, 2019 •

edited

Loading