observablehq / observablehq/plot

Multi-line format helper?

Open
#1,766 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
HTML
Stars
5.4k
Forks
244
PR merge metrics
No merged PRs in 30d

Description

Should we expose a multi-line format helper? You can do it yourself but it’s a bit verbose:

tickFormat(x, i, X) {
  const format1 = (x) => x.toLocaleString("it", { day: "numeric" });
  const format2 = (x) => x.toLocaleString("it", { month: "short" });
  const f1 = format1(x);
  const f2 = format2(x);
  return i > 0 && f2 === format2(X[i - 1]) ? f1 : [f1, f2].join("\n");
}

Maybe:

tickFormat: Plot.formatConditional({ day: "numeric" }, { month: "short" })

But, you’d also need a way to pass in the locale, perhaps the template.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing formatting API and the proposed Plot.formatConditional entry point. Compare the examples for repeated tick labels, multiple format specifications, and locale handling; done should mean a documented, agreed-upon API that supports the intended multi-line formatting behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
data-visualization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.