Skip to content

Commit cfe58ce

Browse files
committed
Update README
1 parent a46e874 commit cfe58ce

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
@@ -512,15 +512,15 @@ Returns a new area with the given *data* and *options*. Plot.area is rarely used
512512
Plot.areaX(aapl, {y: "Date", x: "Close"})
513513
```
514514

515-
Equivalent to [Plot.area](#plotareadata-options), except that the *y* option specifies the *y1* channel, and if the *x* option is specified, it corresponds to the *x2* channel while the *x1* channel defaults to zero. This constructor is typically used for vertically-oriented area charts (*e.g.*, when time goes up↑).
515+
Returns a new area with the given *data* and *options*. This constructor is used when the baseline and topline share *y* values, as in a time-series area chart where time goes up↑. If neither the **x1** nor **x2** option is specified, a **x** option may be specified as shorthand to apply an implicit [stackX transform](#plotstackxoptions); this is the typical configuration for an area chart with a baseline at *x* = 0. If the **x** option is not specified, it defaults to the identity function. The **y** option specifies the **y1** channel; and the **y1** and **y2** options are ignored.
516516

517517
#### Plot.areaY(*data*, *options*)
518518

519519
```js
520520
Plot.areaY(aapl, {x: "Date", y: "Close"})
521521
```
522522

523-
Equivalent to [Plot.area](#plotareadata-options), except that the *x* option specifies the *x1* channel, and if the *y* option is specified, it corresponds to the *y2* channel while the *y1* channel defaults to zero. This constructor is typically used for horizontally-oriented area charts (*e.g.*, when time goes right→).
523+
Returns a new area with the given *data* and *options*. This constructor is used when the baseline and topline share *x* values, as in a time-series area chart where time goes right→. If neither the **y1** nor **y2** option is specified, a **y** option may be specified as shorthand to apply an implicit [stackY transform](#plotstackyoptions); this is the typical configuration for an area chart with a baseline at *y* = 0. If the **y** option is not specified, it defaults to the identity function. The **x** option specifies the **x1** channel; and the **x1** and **x2** options are ignored.
524524

525525
### Bar
526526

0 commit comments

Comments
 (0)