Skip to content

Commit 0c81b16

Browse files
committed
Update README
1 parent 3213c4c commit 0c81b16

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1964,47 +1964,47 @@ In addition to the **y1** and **y2** output channels, Plot.stackY computes a **y
19641964
19651965
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.
19661966
1967-
#### Plot.stackY([*stackOptions*, ]*options*)
1967+
#### Plot.stackY([*stack*, ]*options*)
19681968
19691969
```js
19701970
Plot.stackY({x: "year", y: "revenue", z: "format", fill: "group"})
19711971
```
19721972
1973-
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 *options* object, if the only argument, or as a separate *stackOptions* argument.
1973+
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 *options* object, if the only argument, or as a separate *stack* options argument.
19741974
1975-
#### Plot.stackY1([*stackOptions*, ]*options*)
1975+
#### Plot.stackY1([*stack*, ]*options*)
19761976
19771977
```js
19781978
Plot.stackY1({x: "year", y: "revenue", z: "format", fill: "group"})
19791979
```
19801980
19811981
Equivalent to [Plot.stackY](#plotstackystack-options), 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.
19821982
1983-
#### Plot.stackY2([*stackOptions*, ]*options*)
1983+
#### Plot.stackY2([*stack*, ]*options*)
19841984
19851985
```js
19861986
Plot.stackY2({x: "year", y: "revenue", z: "format", fill: "group"})
19871987
```
19881988
19891989
Equivalent to [Plot.stackY](#plotstackystack-options), 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.
19901990
1991-
#### Plot.stackX([*stackOptions*, ]*options*)
1991+
#### Plot.stackX([*stack*, ]*options*)
19921992
19931993
```js
19941994
Plot.stackX({y: "year", x: "revenue", z: "format", fill: "group"})
19951995
```
19961996
19971997
See Plot.stackY, but with *x* as the input value channel, *y* as the stack index, *x1*, *x2* and *x* as the output channels.
19981998
1999-
#### Plot.stackX1([*stackOptions*, ]*options*)
1999+
#### Plot.stackX1([*stack*, ]*options*)
20002000
20012001
```js
20022002
Plot.stackX1({y: "year", x: "revenue", z: "format", fill: "group"})
20032003
```
20042004
20052005
Equivalent to [Plot.stackX](#plotstackxstack-options), 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.
20062006
2007-
#### Plot.stackX2([*stackOptions*, ]*options*)
2007+
#### Plot.stackX2([*stack*, ]*options*)
20082008
20092009
```js
20102010
Plot.stackX2({y: "year", x: "revenue", z: "format", fill: "group"})

0 commit comments

Comments
 (0)