Skip to content

Commit 86be65e

Browse files
committed
Update README
1 parent 3223bc7 commit 86be65e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ Returns a new area with the given *data* and *options*. This constructor is used
520520
Plot.areaY(aapl, {x: "Date", y: "Close"})
521521
```
522522

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.
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, the **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

@@ -560,7 +560,7 @@ Returns a new vertical bar↕︎ with the given *data* and *options*. The follow
560560
* **y1** - the starting vertical position; bound to the *y* scale
561561
* **y2** - the ending vertical position; bound to the *y* scale
562562

563-
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 a vertical bar chart with bars aligned at *y* = 0. If the **y** option is not specified, it defaults to the identity function.
563+
If neither the **y1** nor **y2** option is specified, the **y** option may be specified as shorthand to apply an implicit [stackY transform](#plotstackyoptions); this is the typical configuration for a vertical bar chart with bars aligned at *y* = 0. If the **y** option is not specified, it defaults to the identity function.
564564

565565
In addition to the [standard bar channels](#bar), the following optional channels are supported:
566566

@@ -758,7 +758,7 @@ Equivalent to [Plot.rect](#plotrectdata-options), except that if neither the **x
758758
Plot.rectY(athletes, Plot.binX({y: "count"}, {x: "weight"}))
759759
```
760760

761-
Equivalent to [Plot.rect](#plotrectdata-options), except that 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 a histogram with rects aligned at *y* = 0. If the **y** option is not specified, it defaults to the identity function.
761+
Equivalent to [Plot.rect](#plotrectdata-options), except that if neither the **y1** nor **y2** option is specified, the **y** option may be specified as shorthand to apply an implicit [stackY transform](#plotstackyoptions); this is the typical configuration for a histogram with rects aligned at *y* = 0. If the **y** option is not specified, it defaults to the identity function.
762762

763763
### Rule
764764

@@ -1174,7 +1174,7 @@ These two methods do not ensure consistency of the series order across the stack
11741174
The **reverse** option reverses the order.
11751175

11761176
The stacking algorithm tracks two values, *lo* and *hi*, both starting at zero for each stack. Considering the values in the given *order*, it progresses by adding non-negative values to the current *hi*, and negative values to the current *lo*. The value of *lo* or *hi* before adding is saved in *y1*, and the new value is saved in *y2*.
1177-
1177+
11781178
When all the values have been added in all the stacks, an optional **offset** strategy is applied to rescale *y1* and *y2*.
11791179

11801180
The following **offset** options are supported:

0 commit comments

Comments
 (0)