Skip to content

Commit cc8ce36

Browse files
Filmbostock
andauthored
document grid: string etc. (#1408)
* document grid: string etc. note: there are tests in aapl-close.ts. closes #1372 * Update README.md --------- Co-authored-by: Mike Bostock <[email protected]>
1 parent e829ede commit cc8ce36

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ Plot automatically generates [axis](#axis) and optionally [grid](#grid) marks fo
296296
* *scale*.**tickPadding** - the separation between the tick and its label (in pixels; default 3)
297297
* *scale*.**tickFormat** - either a function or specifier string to format tick values; see [Formats](#formats)
298298
* *scale*.**tickRotate** - whether to rotate tick labels (an angle in degrees clockwise; default 0)
299-
* *scale*.**grid** - if true, draw grid lines across the plot for each tick
299+
* *scale*.**grid** - whether to draw grid lines across the plot for each tick
300300
* *scale*.**line** - if true, draw the axis line (only for *x* and *y*)
301301
* *scale*.**label** - a string to label the axis
302302
* *scale*.**labelAnchor** - the label anchor: *top*, *right*, *bottom*, *left*, or *center*
@@ -305,7 +305,7 @@ Plot automatically generates [axis](#axis) and optionally [grid](#grid) marks fo
305305
* *scale*.**ariaLabel** - a short label representing the axis in the accessibility tree
306306
* *scale*.**ariaDescription** - a textual description for the axis
307307

308-
Top-level options are also supported as shorthand: **grid** (for *x* and *y* only; see [facet.grid](#facet-options)), **label**, **axis**, **inset**, **round**, **align**, and **padding**.
308+
Top-level options are also supported as shorthand: **grid** (for *x* and *y* only; see [facet.grid](#facet-options)), **label**, **axis**, **inset**, **round**, **align**, and **padding**. If the **grid** option is true, show a grid with the currentColor stroke; if specified as a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
309309

310310
### Projection options
311311

0 commit comments

Comments
 (0)