Skip to content

Commit f604868

Browse files
committed
document insets
1 parent 57e6ad3 commit f604868

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1107,7 +1107,7 @@ Equivalent to [Plot.dot](#plotdotdata-options) except that the **symbol** option
11071107
11081108
### Grid
11091109
1110-
The grid mark draw a line for each tick of the *x* or *y* axis. Specify a number to generate new ticks from the scale, or an explicit array of tick values. The [standard mark options](#marks) can be specified as a constant, or a function of the tick value and tick index, with a *stroke* which defaults to currentColor, and a strokeOpacity which defaults to 0.1. If the ticks are specified as an array of tick values, they will be considered as a channel when building the default domain.
1110+
The grid mark draw a line for each tick of the *x* or *y* axis. Specify a number to generate new ticks from the scale, or an explicit array of tick values. The [standard mark options](#marks) can be specified as a constant, or a function of the tick value and tick index, with a *stroke* which defaults to currentColor, and a *strokeOpacity* which defaults to 0.1. If the ticks are specified as an array of tick values, they will be considered as a channel when building the default domain.
11111111
11121112
#### Plot.gridX([*options*])
11131113
@@ -1117,6 +1117,12 @@ Plot.gridX([3, 4, 5], {stroke: "red"})
11171117
11181118
Returns a new grid along the *x* axis with the given *options*. The *ticks* option can be specified as the first argument.
11191119
1120+
In addition to the [standard mark options](#marks), the following optional channels are supported:
1121+
1122+
* **insetTop** - insets the top edge
1123+
* **insetBottom** - insets the bottom edge
1124+
* **inset** - shorthand for insetTop and insetBottom
1125+
11201126
#### Plot.gridY([*options*])
11211127
11221128
```js
@@ -1125,6 +1131,11 @@ Plot.gridY([3, 4, 5], {stroke: "red"})
11251131
11261132
Returns a new grid along the *y* axis with the given *options*. The *ticks* option can be specified as the first argument.
11271133
1134+
In addition to the [standard mark options](#marks), the following optional channels are supported:
1135+
1136+
* **insetLeft** - insets the left edge
1137+
* **insetRight** - insets the right edge
1138+
* **inset** - shorthand for insetLeft and insetRight
11281139
11291140
### Hexgrid
11301141

0 commit comments

Comments
 (0)