Skip to content

Commit cff1b2d

Browse files
committed
update README
1 parent 07b3e05 commit cff1b2d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1439,47 +1439,47 @@ In addition to the **y1** and **y2** output channels, Plot.stackY computers a **
14391439

14401440
If two arguments are passed to the stack transform functions below, the stack-specific options (**offset**, **order**, and **reverse**) are pulled exclusively from the first *options* argument, while any channels (*e.g.*, **x**, **y**, and **z**) are pulled from second *options* argument. Options from the second argument that are not consumed by the stack transform will be passed through. Using two arguments is sometimes necessary is disambiguate the option recipient when chaining transforms.
14411441

1442-
#### Plot.stackY([*options*, ]*inputs*)
1442+
#### Plot.stackY(*options*, *inputs*)
14431443

14441444
```js
14451445
Plot.stackY({x: "year", y: "revenue", z: "format", fill: "group"})
14461446
```
14471447

14481448
Creates new channels **y1** and **y2**, obtained by stacking the original **y** channel for data points that share a common **x** (and possibly **z**) value. A new **y** channel is also returned, which lazily computes the middle value of **y1** and **y2**. The input **y** channel defaults to a constant 1, resulting in a count of the data points. The stack options (*offset*, *order*, and *reverse*) may be specified as part of the *inputs* or as a separate *options* argument.
14491449

1450-
#### Plot.stackY1([*options*, ]*inputs*)
1450+
#### Plot.stackY1(*options*, *inputs*)
14511451

14521452
```js
14531453
Plot.stackY1({x: "year", y: "revenue", z: "format", fill: "group"})
14541454
```
14551455

14561456
Equivalent to [Plot.stackY](#plotstackyoptions-inputs), except that the **y1** channel is returned as the **y** channel. This can be used, for example, to draw a line at the bottom of each stacked area.
14571457

1458-
#### Plot.stackY2([*options*, ]*inputs*)
1458+
#### Plot.stackY2(*options*, *inputs*)
14591459

14601460
```js
14611461
Plot.stackY2({x: "year", y: "revenue", z: "format", fill: "group"})
14621462
```
14631463

14641464
Equivalent to [Plot.stackY](#plotstackyoptions-inputs), except that the **y2** channel is returned as the **y** channel. This can be used, for example, to draw a line at the top of each stacked area.
14651465

1466-
#### Plot.stackX([*options*, ]*inputs*)
1466+
#### Plot.stackX(*options*, *inputs*)
14671467

14681468
```js
14691469
Plot.stackX({y: "year", x: "revenue", z: "format", fill: "group"})
14701470
```
14711471

14721472
See Plot.stackY, but with *x* as the input value channel, *y* as the stack index, *x1*, *x2* and *x* as the output channels.
14731473

1474-
#### Plot.stackX1([*options*, ]*inputs*)
1474+
#### Plot.stackX1(*options*, *inputs*)
14751475

14761476
```js
14771477
Plot.stackX1({y: "year", x: "revenue", z: "format", fill: "group"})
14781478
```
14791479

14801480
Equivalent to [Plot.stackX](#plotstackxoptions-inputs), except that the **x1** channel is returned as the **x** channel. This can be used, for example, to draw a line at the left edge of each stacked area.
14811481

1482-
#### Plot.stackX2([*options*, ]*inputs*)
1482+
#### Plot.stackX2(*options*, *inputs*)
14831483

14841484
```js
14851485
Plot.stackX2({y: "year", x: "revenue", z: "format", fill: "group"})

0 commit comments

Comments
 (0)