feat: make timeunit for bar/rect behaves more like bin #5096

kanitw · 2019-06-18T06:25:29Z

In this PR, we only make timeUnit like binning for bar and rect.
We do not center other marks (e.g., point/line/area) in the middle of the timeUnit band by default for a few reasons:

Area will be ugly, leaving empty spaces on the side
Centering all marks so will cause breaking changes to all plots with timeUnit.
By only making timeUnit behave like bin for just bars and rects, we only change the behaviors for plots that currently look terrible.
Doing so will cause the plots with and without timeUnit look quite different.
For example, if there is a date field with only year information. Using no timeUnit and timeUnit=year will produce dramatically different results.

When needed, users can easily set the band or mark config's timeUnitBand to 0.5 to center the data point in the middle of a time unit band. See line_month_center_band for example.

FWIW, Tableau also does NOT center the data point in the middle of a time unit band by default.

~~default alignment~~ -- from an experiment the current one is already good
distinguish between band's width and position
- pointBandSize, bandSize, bandPosition?
stack with impute case
document band
revise timeUnit docs
~~make band work for bar with temporal timeUnit~~ will do in Band should also work with bar with bin / timeUnit #5243

Note that we don't include support for a field that has already been "prebinned" with a time unit transform. Let's handle that later in #5242.

…o avoid overflow This is especially important for temporal in a follow up PR (#5096).

…o avoid overflow (#5204) This is especially important for temporal in a follow up PR (#5096).

kanitw · 2019-07-26T02:55:48Z

examples/compiled/interactive_multi_line_tooltip.vg.json

@@ -13,6 +13,16 @@
      "format": {"type": "csv", "parse": {"date": "date"}},
      "transform": [
        {"type": "identifier", "as": "_vgsid_"},
+        {


I don't know if we generate the best time format here.

examples/compiled/interactive_seattle_weather.vg.json

examples/compiled/layer_falkensee.vg.json

examples/compiled/layer_line_errorband_2d_horizontal_borders_strokedash.vg.json

examples/compiled/layer_line_errorband_ci.vg.json

examples/compiled/area.vg.json

examples/compiled/area_vertical.vg.json

examples/compiled/bar_month.vg.json

examples/compiled/bar_month_temporal.vg.json

examples/compiled/bar_yearmonth.vg.json

examples/compiled/line_color_binned.vg.json

kanitw · 2019-07-27T18:28:24Z

src/channeldef.ts

@@ -361,16 +363,50 @@ export interface PositionFieldDef<F extends Field>
  impute?: ImputeParams;

  /**
-   * For rect-based marks (`rect`, `bar`, and `image`), mark size relative to bandwidth of [band scales](https://vega.github.io/vega-lite/docs/scale.html#band). If set to `1`, the mark size is set to the bandwidth. If set to `0.5`, the mark size is half of the bandwidth.
+   * For rect-based marks (`rect`, `bar`, and `image`), mark size relative to bandwidth of [band scales](https://vega.github.io/vega-lite/docs/scale.html#band) or time units. If set to `1`, the mark size is set to the bandwidth or the time unit interval. If set to `0.5`, the mark size is half of the bandwidth or the time unit interval.


rect/bar can be band position too, if size property is explicitly specified.

kanitw · 2019-07-28T03:28:40Z

src/compile/mark/rect.ts

@@ -55,15 +55,16 @@ export function rectPosition(model: UnitModel, channel: 'x' | 'y', mark: 'bar' |
  // x, x2, and width -- we must specify two of these in all conditions
  if (
    isFieldDef(fieldDef) &&
-    (isBinning(fieldDef.bin) || isBinned(fieldDef.bin)) &&
+    // FIXME use band to determine condition here


FYI, this will be fixed later in #5244

BREAKING CHANGE: bar/rect with timeUnit would look differently

domoritz

Should we remove the grid so that it looks like in bins?

domoritz · 2019-07-29T19:29:12Z

src/mark.ts

+  /**
+   * Default band position for a time unit.
+   */
+  timeUnitBandPosition?: 0 | 0.5;


Why can this only be two values? Please document.

Technically it doesn't have to be either 0 or 0.5. But in practice, these numbers won't make sense if they are not 0 (beginning of the timeUnit interval or 0.5 (middle of the timeUnit interval).

I can relax it to number.

domoritz · 2019-07-29T19:30:49Z

examples/compiled/bar_yearmonth_custom_format.vg.json

@@ -17,9 +17,14 @@
          "as": "yearmonth_date",


Looking at the chart, it's really hard to know what the values for axis ticks are. Please revise this example.

This PR doesn't change anything about the label.

it's really hard to know what the values for axis ticks are

This example is only there for explaining that you can customize the format. (See format.md.) So if you strongly think this should be change, please submit a separate PR for it.

kanitw · 2019-07-30T03:25:58Z

Should we remove the grid so that it looks like in bins?

No. Grid in time actually usually represent year / month boundaries, which are helpful to readers. (Grid in bins do not mean much.)

In a follow up PR, I'll even make the default band different between bin and timeUnit.

hoclun-rigsep · 2020-10-09T14:34:40Z

New user, trying to follow the discussion here. With a known domain resolution of e.g. yearmonth, wouldn't you want the tick mark of the x-axis to be centered under the bar?

kanitw force-pushed the kw/timeunit branch from 9bca99e to 5d828d3 Compare June 18, 2019 06:39

domoritz changed the title ~~feat!: make timeunit behaves more like bin~~ feat!: make timeunit behave more like bin Jun 19, 2019

kanitw force-pushed the kw/timeunit branch from 5d828d3 to 500032b Compare June 19, 2019 18:29

kanitw added the P1 Critical -- to fix ASAP label Jul 6, 2019

kanitw force-pushed the kw/timeunit branch 2 times, most recently from bfda0fd to d275131 Compare July 19, 2019 23:44

kanitw mentioned this pull request Jul 20, 2019

fix: use 0.5*a + 0.5*b for stack mid formula instead of (a+b)/2 to avoid overflow #5204

Merged

kanitw added a commit that referenced this pull request Jul 20, 2019

fix: use 0.5*a + 0.5*b for stack mid formula instead of (a+b)/2 t…

292e8ee

…o avoid overflow This is especially important for temporal in a follow up PR (#5096).

kanitw force-pushed the kw/timeunit branch from d275131 to 351adc6 Compare July 20, 2019 00:13

kanitw added a commit that referenced this pull request Jul 20, 2019

fix: use 0.5*a + 0.5*b for stack mid formula instead of (a+b)/2 t…

8fed9b5

…o avoid overflow (#5204) This is especially important for temporal in a follow up PR (#5096).

kanitw mentioned this pull request Jul 20, 2019

feat: add band property for position field def #5206

Merged

kanitw force-pushed the kw/timeunit branch 2 times, most recently from 4ce82fe to 84c91a2 Compare July 26, 2019 00:30

kanitw commented Jul 26, 2019

View reviewed changes

kanitw force-pushed the kw/timeunit branch 9 times, most recently from cfc0497 to 68db08b Compare July 27, 2019 16:25

kanitw commented Jul 27, 2019

View reviewed changes

kanitw mentioned this pull request Jul 27, 2019

Improve timeUnit positioning #4868

Closed

This comment has been minimized.

Sign in to view

kanitw mentioned this pull request Jul 28, 2019

feat: make band work for bar with bin or timeUnit + add config.mark.timeUnitBand #5244

Merged

kanitw commented Jul 28, 2019

View reviewed changes

kanitw marked this pull request as ready for review July 28, 2019 03:29

This comment has been minimized.

Sign in to view

kanitw and others added 4 commits July 27, 2019 20:34

feat: make timeunit for bar/rect behaves more like bin

8095ca8

BREAKING CHANGE: bar/rect with timeUnit would look differently

docs: update documentation

538ddd4

feat(example): line_month_center_band.vl.json

62b56f5

[Travis] Update examples (build: 24826)

4e8c54e

kanitw force-pushed the kw/timeunit branch from 44a0c6b to 4e8c54e Compare July 28, 2019 03:40

kanitw requested review from domoritz, Saba9 and znation and removed request for domoritz July 28, 2019 03:40

[Travis] Update schema (build: 24897)

6f37ec0

domoritz approved these changes Jul 29, 2019

View reviewed changes

docs: improve docs

35cd7d6

kanitw changed the title ~~feat!: make timeunit behave more like bin~~ feat: make timeunit for bar/rect behaves more like bin Jul 30, 2019

kanitw merged commit 539299d into master Jul 30, 2019

kanitw deleted the kw/timeunit branch July 30, 2019 03:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make timeunit for bar/rect behaves more like bin #5096

feat: make timeunit for bar/rect behaves more like bin #5096

kanitw commented Jun 18, 2019 •

edited

kanitw Jul 26, 2019

kanitw Jul 27, 2019

This comment has been minimized.

This comment has been minimized.

kanitw Jul 28, 2019

This comment has been minimized.

domoritz left a comment

domoritz Jul 29, 2019

kanitw Jul 30, 2019

domoritz Jul 29, 2019

kanitw Jul 30, 2019

kanitw commented Jul 30, 2019

hoclun-rigsep commented Oct 9, 2020

feat: make timeunit for bar/rect behaves more like bin #5096

feat: make timeunit for bar/rect behaves more like bin #5096

Conversation

kanitw commented Jun 18, 2019 • edited

kanitw Jul 26, 2019

Choose a reason for hiding this comment

kanitw Jul 27, 2019

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

kanitw Jul 28, 2019

Choose a reason for hiding this comment

This comment has been minimized.

domoritz left a comment

Choose a reason for hiding this comment

domoritz Jul 29, 2019

Choose a reason for hiding this comment

kanitw Jul 30, 2019

Choose a reason for hiding this comment

domoritz Jul 29, 2019

Choose a reason for hiding this comment

kanitw Jul 30, 2019

Choose a reason for hiding this comment

kanitw commented Jul 30, 2019

hoclun-rigsep commented Oct 9, 2020

kanitw commented Jun 18, 2019 •

edited