date scale interval & warning #852

Fil · 2022-04-19T15:08:13Z

Specifying a scale interval shows the intent of having ordinal numerical or ordinal dates: suppress warning.

Side note: if a numeric interval was specified, string numerics have already been coerced to numbers by the scale transform; so this in fact only has consequences for ordinal dates, such as in the downloads-ordinal test plot.

…cal or ordinal dates: suppress warning. Side note: if a numeric interval was specified, string numerics have already been coerced to numbers by the scale transform; so this in fact only has consequences for ordinal dates, such as in the downloads-ordinal test plot.

src/scales.js

Co-authored-by: Mike Bostock <[email protected]>

Fil · 2022-04-19T21:06:15Z

this should be good to go

… the ticks with the interval; also set the tickFormat so that we don't show 1.0, 2.0, 3.0 if the interval is an integer.

Fil · 2022-04-26T21:40:52Z

759c46f fixes a bug in the original feature branch (the scale was not reusable since the transform was not exposed)
fffe736 helps with When all the values are integers, skip fractional ticks? #355

mbostock · 2022-06-09T00:29:36Z

src/axes.js

+function tickInterval(scale, axis) {
+  const interval = maybeInterval(scale.interval);
+  if (interval != null) {
+    const [min, max] = extent(scale.scale.domain());


This should only be computed if axis.ticks is undefined.

mbostock · 2022-06-09T00:36:29Z

src/axes.js

+  if (interval != null) {
+    const [min, max] = extent(scale.scale.domain());
+    if (axis.ticks === undefined) axis.ticks = interval.range(interval.floor(min), interval.offset(interval.floor(max)));
+    if (scale.type !== "point" && scale.type !== "band" && axis.tickFormat === undefined && typeof scale.interval === "number") axis.tickFormat = ",";


This should be using the isBandScale helper probably. Or maybe isOrdinalScale?

More to the point, what is this doing? We shouldn’t assume that a numeric interval is an integer; you can say interval: 0.5 (though maybe fractional intervals are not really recommended—it would probably be better for us to use interval: -2 like we do for d3.tickIncrement). In any case, rather than this default, maybe we should simply default tickFormat to formatDefault so that it works with number and date ticks?

This is trying to address one specific case: if the domain is [1, 3], the scale linear, the default tickFormat is going to show "1.0", "1.5",… "3.0". If you specify interval: 1, it shows an intent to have integer values, and the ticks should be "1", "2", "3", and not "1.0", "2.0", "3.0". So we're not just indicating that we want integer ticks, but also an integer tick format. Using formatDefault is OK in this case.

However formatDefault fails in the case of years on a utc scale with a d3.utcYear interval: in that case we would prefer to format years as "2001", and not "2001-01-01" (which is what formatDefault does).

Another case that I'm trying to think about is #768, when numbers are in the range [0, 2499] and we prefer to format them as "1999" rather than "1,999".

I'm not sure how to hold all of this together—it seems that we need both the domain's extent and the interval "type" (or maybe the interval should give a preferred tickFormat : utcYear wants to format as "2001", and utcMonth as "2001-01", maybe…).

src/scales/ordinal.js

src/scales/quantitative.js

mbostock · 2022-06-09T00:40:40Z

src/scales.js

  if (options.type === undefined
      && options.domain === undefined
      && options.range === undefined
+      && options.interval == null


Suggested change

&& options.interval == null

&& options.interval === undefined

Assuming we do maybeInterval on scale construction (per other comments) we don’t have to worry about null vs. undefined here, too.

lists a few TODOs re: the default tick format: - we don't want decimal notation if the interval is specified as an integer - we don't want months to appear if the interval is specified as d3.utcYear - we don't want years to appear with commas (#768)

mbostock

I made some changes here:

I changed the default tickFormat for all ordinal scales to be Plot’s default formatter. This way, if you specify numbers or dates as your ordinal ticks (or domain), you’ll get nice localized formatting by default. I figure this shouldn’t depend on whether the scale has an interval or not, and also because I don’t think Plot’s default formatter should override the default tick format on quantitative scales. (Maybe that could change in the future if we have a default tick format that is specific to the interval you’ve specified, but that’s for future.)
I changed the default fontVariant for ordinal scales with an interval to use tabular-nums so that you get better tick labels (just like you would with a quantitative scale).
I moved to interval coercion (maybeInterval call) slightly earlier in scale initialization.
I augmented one of the tests to ensure that the scale transform defaults to interval.floor.
I added a comment to the test saying that using a transform to parse dates is not recommended. (You should do that earlier when you load data.)
I adopted more shorthand in the tests where possible.

* Specifying a scale interval shows the intent of having ordinal numerical or ordinal dates: suppress warning. Side note: if a numeric interval was specified, string numerics have already been coerced to numbers by the scale transform; so this in fact only has consequences for ordinal dates, such as in the downloads-ordinal test plot. * document scale intervals * test plot with year intervals * Update src/scales.js Co-authored-by: Mike Bostock <[email protected]> * Update src/scales.js Co-authored-by: Mike Bostock <[email protected]> * Update src/scales.js Co-authored-by: Mike Bostock <[email protected]> * d3.utcDay-like intervals do not parse string dates * reusable interval option * When the interval option is applied on a quantitative scale, generate the ticks with the interval; also set the tickFormat so that we don't show 1.0, 2.0, 3.0 if the interval is an integer. * tests * normalize intervals lists a few TODOs re: the default tick format: - we don't want decimal notation if the interval is specified as an integer - we don't want months to appear if the interval is specified as d3.utcYear - we don't want years to appear with commas (#768) * formatDefault for ordinal scales * Update README * call maybeInterval sooner * tabular-nums for interval’d ordinal axes Co-authored-by: Mike Bostock <[email protected]>

* ordinal interval * fix test (913629f) * date scale interval & warning (#852) * Specifying a scale interval shows the intent of having ordinal numerical or ordinal dates: suppress warning. Side note: if a numeric interval was specified, string numerics have already been coerced to numbers by the scale transform; so this in fact only has consequences for ordinal dates, such as in the downloads-ordinal test plot. * document scale intervals * test plot with year intervals * Update src/scales.js Co-authored-by: Mike Bostock <[email protected]> * Update src/scales.js Co-authored-by: Mike Bostock <[email protected]> * Update src/scales.js Co-authored-by: Mike Bostock <[email protected]> * d3.utcDay-like intervals do not parse string dates * reusable interval option * When the interval option is applied on a quantitative scale, generate the ticks with the interval; also set the tickFormat so that we don't show 1.0, 2.0, 3.0 if the interval is an integer. * tests * normalize intervals lists a few TODOs re: the default tick format: - we don't want decimal notation if the interval is specified as an integer - we don't want months to appear if the interval is specified as d3.utcYear - we don't want years to appear with commas (#768) * formatDefault for ordinal scales * Update README * call maybeInterval sooner * tabular-nums for interval’d ordinal axes Co-authored-by: Mike Bostock <[email protected]> * Update README * options.interval is not normalized here Co-authored-by: Philippe Rivière <[email protected]>

Fil requested a review from mbostock April 19, 2022 15:08

mbostock reviewed Apr 19, 2022

View reviewed changes

src/scales.js Show resolved Hide resolved

mbostock reviewed Apr 19, 2022

View reviewed changes

src/scales.js Outdated Show resolved Hide resolved

mbostock reviewed Apr 19, 2022

View reviewed changes

src/scales.js Outdated Show resolved Hide resolved

mbostock reviewed Apr 19, 2022

View reviewed changes

src/scales.js Outdated Show resolved Hide resolved

Fil and others added 6 commits April 19, 2022 18:22

document scale intervals

ffd1f53

test plot with year intervals

e912814

Update src/scales.js

7c74dbf

Co-authored-by: Mike Bostock <[email protected]>

Update src/scales.js

eb488ea

Co-authored-by: Mike Bostock <[email protected]>

Update src/scales.js

62e0035

Co-authored-by: Mike Bostock <[email protected]>

d3.utcDay-like intervals do not parse string dates

26ee70b

Fil added 3 commits April 26, 2022 14:24

reusable interval option

759c46f

When the interval option is applied on a quantitative scale, generate…

fffe736

… the ticks with the interval; also set the tickFormat so that we don't show 1.0, 2.0, 3.0 if the interval is an integer.

tests

2eeb68a

mbostock reviewed Jun 9, 2022

View reviewed changes

src/scales/ordinal.js Show resolved Hide resolved

mbostock reviewed Jun 9, 2022

View reviewed changes

src/scales/quantitative.js Show resolved Hide resolved

mbostock reviewed Jun 9, 2022

View reviewed changes

normalize intervals

d419c44

lists a few TODOs re: the default tick format: - we don't want decimal notation if the interval is specified as an integer - we don't want months to appear if the interval is specified as d3.utcYear - we don't want years to appear with commas (#768)

Fil force-pushed the fil/ordinal-interval branch from 390725d to d419c44 Compare June 9, 2022 20:10

mbostock added 4 commits June 10, 2022 08:04

formatDefault for ordinal scales

dc79105

Update README

bd00521

call maybeInterval sooner

4e77cf4

tabular-nums for interval’d ordinal axes

7c565d9

mbostock approved these changes Jun 10, 2022

View reviewed changes

mbostock merged commit 48166af into mbostock/ordinal-interval Jun 10, 2022

mbostock deleted the fil/ordinal-interval branch June 10, 2022 15:35

Fil mentioned this pull request Jun 10, 2022

Interval-aware default ticks/tick formats #932

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

date scale interval & warning #852

date scale interval & warning #852

Uh oh!

Fil commented Apr 19, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fil commented Apr 19, 2022

Uh oh!

Fil commented Apr 26, 2022

Uh oh!

mbostock Jun 9, 2022

Uh oh!

mbostock Jun 9, 2022

Uh oh!

Fil Jun 9, 2022

Uh oh!

Uh oh!

Uh oh!

mbostock Jun 9, 2022

Uh oh!

mbostock left a comment

Uh oh!

Uh oh!

	&& options.interval == null
	&& options.interval === undefined

date scale interval & warning #852

date scale interval & warning #852

Uh oh!

Conversation

Fil commented Apr 19, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fil commented Apr 19, 2022

Uh oh!

Fil commented Apr 26, 2022

Uh oh!

mbostock Jun 9, 2022

Choose a reason for hiding this comment

Uh oh!

mbostock Jun 9, 2022

Choose a reason for hiding this comment

Uh oh!

Fil Jun 9, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mbostock Jun 9, 2022

Choose a reason for hiding this comment

Uh oh!

mbostock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!