You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*`missing`: Determines how layers behave when the faceting column is missing. It can take two values: `'repeat'` (default), and `'null'`. If `'repeat'` is set, then the layer data is repeated in each panel. If `'null'`, then such layers are only displayed if a null panel is shown, as controlled by the facet scale.
37
-
*`ncol`/`nrow`: The dimensions of the layout when faceting by a single variable. Only one of these can be given, as the other is derived based on the number of panels to draw. Default is 3 columns when fewer than 6 categories are present, 4 columns when fewer than 12 categories are present and otherwise 5 columns. When the `BY`-clause is used to set a second faceting variable, the `ncol` and `nrow` setting are not allowed.
37
+
*`ncol`/`nrow`: The dimensions of the layout when faceting by a single variable (whole number >= 1). Only one of these can be given, as the other is derived based on the number of panels to draw. Default is 3 columns when fewer than 6 categories are present, 4 columns when fewer than 12 categories are present and otherwise 5 columns. When the `BY`-clause is used to set a second faceting variable, the `ncol` and `nrow` setting are not allowed.
38
38
39
39
### Facet variables as aesthetics
40
40
When you apply faceting to a plot you are creating new aesthetics you can control. For 1-dimensional faceting (no `BY` clause) the aesthetic is called `panel` and for 2-dimensional faceting the aesthetics are called `row` and `column`. You can read more about these aesthetics in [their documentation](../scale/aesthetic/Z_faceting.qmd)
Copy file name to clipboardExpand all lines: doc/syntax/clause/project.qmd
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,6 @@ This clause behaves much like the `SETTINGS` clause in `DRAW`, in that it allows
32
32
If you do not provide a `PROJECT` clause then the coordinate system will be picked for you based on the mappings in your query. The logic is as follows
33
33
34
34
* If `x`, `y` or any of their variants are mapped to, a Cartesian coordinate system is used
35
-
* If `theta`, `radius` or any of their variants are mapped to, a polar coordinate system is used
35
+
* If `angle`, `radius` or any of their variants are mapped to, a polar coordinate system is used
36
36
* If none of the above applies, the plot defaults to a Cartesian coordinate system
37
-
* If multiple applies (e.g. mapping to both x and theta) an error is thrown
37
+
* If multiple applies (e.g. mapping to both x and angle) an error is thrown
Copy file name to clipboardExpand all lines: doc/syntax/coord/cartesian.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ assuming they do not try to use a name that is already being used by any facet o
20
20
21
21
## Settings
22
22
*`clip`: Should data be removed if it appears outside the bounds of the coordinate system. Defaults to `true`
23
-
*`ratio`: The aspect ratio between the steps on the vertical and horizontal axis. Defaults to `null` (no enforced aspect ratio)
23
+
*`ratio`: The aspect ratio between the steps on the vertical and horizontal axis (must be > 0 if specified). Defaults to `null` (no enforced aspect ratio)
Copy file name to clipboardExpand all lines: doc/syntax/coord/polar.qmd
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -8,32 +8,32 @@ The polar coordinate system interprets its primary aesthetic as the angular posi
8
8
The polar coordinate system has the following default positional aesthetics which will be used if no others have been provided:
9
9
10
10
***Primary**: `radius` (distance from center)
11
-
***Secondary**: `theta` (angular position)
11
+
***Secondary**: `angle` (angular position)
12
12
13
13
Users can provide their own aesthetic names if needed. For example, if using `x` and `y` aesthetics:
14
14
15
15
```ggsql
16
16
PROJECT y, x TO polar
17
17
```
18
18
19
-
This maps `y` to radius and `x` to theta (angle). This is useful when converting from a cartesian coordinate system without editing all the mappings.
19
+
This maps `y` to radius and `x` to angle. This is useful when converting from a cartesian coordinate system without editing all the mappings.
20
20
21
21
## Settings
22
22
*`clip`: Should data be removed if it appears outside the bounds of the coordinate system. Defaults to `true`
23
-
*`start`: The starting angle in degrees for the theta scale. Controls where "0" on the angular axis begins. Defaults to `0` (12 o'clock position).
23
+
*`start`: The starting angle in degrees for the theta scale (-360 to 360). Controls where "0" on the angular axis begins. Defaults to `0` (12 o'clock position).
24
24
-`0` = 12 o'clock position (top)
25
25
-`90` = 3 o'clock position (right)
26
26
-`-90` or `270` = 9 o'clock position (left)
27
27
-`180` = 6 o'clock position (bottom)
28
-
*`end`: The ending angle in degrees for the theta scale. Defaults to `start + 360` (a full circle). Use this with `start` to create partial polar plots like gauge charts or half-circle visualizations.
28
+
*`end`: The ending angle in degrees for the theta scale (-360 to 360). Defaults to `start + 360` (a full circle). Use this with `start` to create partial polar plots like gauge charts or half-circle visualizations.
29
29
*`inner`: The inner radius as a proportion (0 to 1) of the outer radius. Defaults to `0` (no hole). Setting this creates a donut chart where the inner portion is empty.
Copy file name to clipboardExpand all lines: doc/syntax/layer/position/dodge.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Dodge doesn't have specific requirements to the scale type of the plot, but will
12
12
## Settings
13
13
Apart from the settings of the layer type, setting `position => 'dodge'` will allow these additional settings:
14
14
15
-
*`width`: The total width the dodging will occupy as a proportion of the space available on the scale. Defaults to 0.9 but any defaults from the layer will take precedence.
15
+
*`width`: The total width the dodging will occupy as a proportion of the space available on the scale (0 to 1). Defaults to 0.9 but any defaults from the layer will take precedence.
Copy file name to clipboardExpand all lines: doc/syntax/layer/position/jitter.qmd
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,17 @@ Jitter requires at least one axis to be discrete as it only jitters along discre
12
12
## Settings
13
13
Apart from the settings of the layer type, setting `position => 'jitter'` will allow these additional settings:
14
14
15
-
*`width`: The total width the jittering will occupy as a proportion of the space available on the scale. Defaults to 0.9
15
+
*`width`: The total width the jittering will occupy as a proportion of the space available on the scale (0 to 1). Defaults to 0.4
16
16
*`dodge`: Should dodging be applied before jittering. The dodging behavior follows the [dodge position](dodge.qmd) behavior? Default to `true`
17
17
*`distribution`: Which kind of distribution should the jittering follow? One of:
18
18
-`'uniform'` (default): Jittering is sampled from a uniform distribution between `-width/2` and `width/2`
19
19
-`'normal'`: Jittering is sampled from a normal distribution with σ as `width/4` resulting in 95% of the points falling inside the given width
20
20
-`'density'`: Jittering follows the density distribution within the group so that the jitter occupies the same area as an equivalent [violin plot](../type/violin.qmd) with density remapped to offset
21
21
-`'intensity'`: Jittering follows the intensity distribution within the group so that the jitter occupies the same area as an equivalent [violin plot](../type/violin.qmd) with intensity remapped to offset
22
-
22
+
23
23
If `distribution` is either `'density'` or `'intensity'` then one of the axes must be continuous
24
-
*`bandwidth`: A numerical value setting the smoothing bandwidth to use for the `'density'` and `'intensity'` distributions. If absent (default), the bandwidth will be computed using Silverman's rule of thumb.
25
-
*`adjust`: A numerical value as multiplier for the `bandwidth` setting, with 1 as default.
24
+
*`bandwidth`: Smoothing bandwidth for the `'density'` and `'intensity'` distributions (must be > 0). If absent (default), the bandwidth will be computed using Silverman's rule of thumb.
25
+
*`adjust`: Multiplier for the `bandwidth` setting (must be > 0). Defaults to 1.
26
26
27
27
## Examples
28
28
When plotting points on a discrete axis they are all placed in the middle
Copy file name to clipboardExpand all lines: doc/syntax/layer/position/stack.qmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Stack requires a continuous scale with a range mapping (e.g. either `y` + `yend`
13
13
Apart from the settings of the layer type, setting `position => 'stack'` will allow these additional settings:
14
14
15
15
*`center`: Should the full stack be centered around 0. Can be used in conjunction with area layers to create steamgraphs. Default to `false`
16
-
*`total`: Sets a total value to which each stack height is normalised. Setting this value leads to 'fill' behaviour. Defaults to `null` (no normalisation)
16
+
*`total`: Sets a total value to which each stack height is normalised (must be > 0 if specified). Setting this value leads to 'fill' behaviour. Defaults to `null` (no normalisation)
0 commit comments