Skip to content

Commit babb7bf

Browse files
committed
Update README
1 parent 1c6f6bc commit babb7bf

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -619,13 +619,11 @@ In addition to the [standard mark options](#marks), the following optional chann
619619
* **y** - the vertical position; bound to the *y* scale
620620
* **r** - the radius (area); bound to the *radius* scale
621621

622-
If the **x** channel is not specified, the dot will be horizontally centered in the plot (or facet). Likewise if the **y** channel is not specified, the dot will vertically centered in the plot (or facet). (Typically either *x*, *y*, or both are specified.)
622+
If the **x** channel is not specified, dots will be horizontally centered in the plot (or facet). Likewise if the **y** channel is not specified, dots will vertically centered in the plot (or facet). (Typically either *x*, *y*, or both are specified.)
623623

624-
The **r** option can be specified as either a channel or constant. When the radius is specified as a number, it is interpreted as a constant; otherwise it is interpreted as a channel.
624+
The **r** option defaults to 3 (three pixels) and can be specified as either a channel or constant. When the radius is specified as a number, it is interpreted as a constant; otherwise it is interpreted as a channel. Dots with a nonpositive radius are not drawn. The **stroke** defaults to none. The **fill** defaults to currentColor if stroke is none, and to none otherwise. The **strokeWidth** defaults to 1.5.
625625

626-
**stroke** defaults to none, and **fill** defaults to currentColor if stroke is none, and to none otherwise.
627-
628-
TODO Dots with a nonpositive radius are not drawn.
626+
Dots are drawn in input order, with the last data drawn on top. If sorting is needed, say to mitigate overplotting by drawing the smallest dots on top, consider a [sort and reverse transform](#transforms).
629627

630628
#### Plot.dot(*data*, *options*)
631629

@@ -774,7 +772,7 @@ Equivalent to [Plot.rect](#plotrectdata-options), except that the *x* option spe
774772

775773
[Source](./src/marks/rule.js) · [Examples](https://observablehq.com/@data-workflows/plot-rule) · Draws an orthogonal line at the given horizontal ([Plot.ruleX](#plotrulexdata-options)) or vertical ([Plot.ruleY](#plotruleydata-options)) position, either across the entire plot (or facet) or bounded in the opposite dimension. Rules are often used with hard-coded data to annotate special values such as *y* = 0, though they can also be used to visualize data as in a lollipop chart.
776774

777-
For the required channels, see [Plot.ruleX](#plotrulexdata-options) and [Plot.ruleY](#plotruleydata-options). The rule mark supports the [standard mark options](#marks), including insets along its secondary dimension. The **stroke** option defaults to currentColor.
775+
For the required channels, see [Plot.ruleX](#plotrulexdata-options) and [Plot.ruleY](#plotruleydata-options). The rule mark supports the [standard mark options](#marks), including insets along its secondary dimension. The **stroke** defaults to currentColor.
778776

779777
#### Plot.ruleX(*data*, *options*)
780778

@@ -860,7 +858,7 @@ Equivalent to [Plot.text](#plottextdata-options), except **y** defaults to the i
860858

861859
[Source](./src/marks/tick.js) · [Examples](https://observablehq.com/@data-workflows/plot-tick) · Draws an orthogonal line at the given horizontal ([Plot.tickX](#plottickxdata-options)) or vertical ([Plot.tickY](#plottickydata-options)) position, with an optional secondary position dimension along a band scale. (If the secondary dimension is quantitative instead of ordinal, use a [rule](#rule).) Ticks are often used to visualize distributions as in a “barcode” plot.
862860

863-
For the required channels, see [Plot.tickX](#plottickxdata-options) and [Plot.tickY](#plottickydata-options). The tick mark supports the [standard mark options](#marks), including insets. The **stroke** option defaults to currentColor.
861+
For the required channels, see [Plot.tickX](#plottickxdata-options) and [Plot.tickY](#plottickydata-options). The tick mark supports the [standard mark options](#marks), including insets. The **stroke** defaults to currentColor.
864862

865863
#### Plot.tickX(*data*, *options*)
866864

0 commit comments

Comments
 (0)