Skip to content

Commit 3bb3da3

Browse files
committed
Update README
1 parent a26981d commit 3bb3da3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ 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-
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.
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, the **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

@@ -541,7 +541,7 @@ Returns a new horizontal bar↔︎ with the given *data* and *options*. The foll
541541
* **x1** - the starting horizontal position; bound to the *x* scale
542542
* **x2** - the ending horizontal position; bound to the *x* scale
543543

544-
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 a horizontal bar chart with bars aligned at *x* = 0. If the **x** option is not specified, it defaults to the identity function.
544+
If neither the **x1** nor **x2** option is specified, the **x** option may be specified as shorthand to apply an implicit [stackX transform](#plotstackxoptions); this is the typical configuration for a horizontal bar chart with bars aligned at *x* = 0. If the **x** option is not specified, it defaults to the identity function.
545545

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

@@ -750,15 +750,15 @@ Returns a new rect with the given *data* and *options*.
750750
Plot.rectX(athletes, Plot.binY({x: "count"}, {y: "weight"}))
751751
```
752752

753-
Equivalent to [Plot.rect](#plotrectdata-options), except that 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 histograms (*e.g.*, where bins extend right→).
753+
Equivalent to [Plot.rect](#plotrectdata-options), except that if neither the **x1** nor **x2** option is specified, the **x** option may be specified as shorthand to apply an implicit [stackX transform](#plotstackxoptions); this is the typical configuration for a histogram with rects aligned at *x* = 0. If the **x** option is not specified, it defaults to the identity function.
754754

755755
#### Plot.rectY(*data*, *options*)
756756

757757
```js
758758
Plot.rectY(athletes, Plot.binX({y: "count"}, {x: "weight"}))
759759
```
760760

761-
Equivalent to [Plot.rect](#plotrectdata-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 histograms (*e.g.*, where bins extend up↑).
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.
762762

763763
### Rule
764764

@@ -800,7 +800,7 @@ Returns a new rule↔︎ with the given *data* and *options*. In addition to the
800800
* **x1** - the starting horizontal position; bound to the *x* scale
801801
* **x2** - the ending horizontal position; bound to the *x* scale
802802

803-
If the **y** option is not specified, it defaults to the identity function and assumes that *data* = [*y₀*, *y₁*, *y₂*, …]. If a **x** option is specified, it is shorthand for the **x2** option with **x1** equal to zero; this is the typical configuration for a horizontal lollipop chart with rules aligned at *x* = 0. If the **x1** channel is not specified, the rule will start at the left edge of the plot (or facet). If the **x2** channel is not specified, the rule will end at the right edge of the plot (or facet).
803+
If the **y** option is not specified, it defaults to the identity function and assumes that *data* = [*y₀*, *y₁*, *y₂*, …]. If the **x** option is specified, it is shorthand for the **x2** option with **x1** equal to zero; this is the typical configuration for a horizontal lollipop chart with rules aligned at *x* = 0. If the **x1** channel is not specified, the rule will start at the left edge of the plot (or facet). If the **x2** channel is not specified, the rule will end at the right edge of the plot (or facet).
804804

805805
### Text
806806

0 commit comments

Comments
 (0)