Skip to content

Commit de496d0

Browse files
ASmirnov-HORISASmirnov-HORIS
authored
Documentation for v4.14.0 (#306)
1 parent afb86da commit de496d0

31 files changed

Lines changed: 358002 additions & 65235 deletions

‎Writerside/images/changelog/4.14.0/color_alpha_componnet.png‎

58.2 KB
Loading

‎Writerside/images/changelog/4.14.0/facet_strip_text_angle.png‎

24.4 KB
Loading

‎Writerside/images/changelog/4.14.0/ggdeck_dual_axis.png‎

69.9 KB
Loading

‎Writerside/images/changelog/4.14.0/ggdeck_plot_overlay.png‎

76.7 KB
Loading

‎Writerside/topics/aesthetics.md‎

Lines changed: 89 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -50,30 +50,94 @@ See [example notebook](%nb-aesthetics-text_style-font_face%).
5050

5151
## Color and Fill
5252

53-
Colors and fills of geometries can be specified in the following ways:
54-
55-
- **RGB**/**RGBA** - e.g. `"rgb(0, 0, 255)"`, `"rgba(0, 0, 255, 0.5)"`.
56-
57-
- **HEX** - e.g. `"#0077ff"`, `"#07f"`.
58-
59-
- **Transparent** - an empty string (`""`) or the aliases `"blank"` and `"transparent"` for a fully transparent color.
60-
61-
- **Named colors** from <a href="named_colors.md">a predefined list of color names</a>.
62-
63-
- **System colors** depending on the current theme <a href="presentation_options.md#color-schemes-flavors">flavor</a>, one of:
64-
65-
<list columns="3">
66-
<li>
67-
<img alt="Color 'pen'" src="aesthetics_color_pen.png"/>
68-
</li>
69-
<li>
70-
<img alt="Color 'brush'" src="aesthetics_color_brush.png"/>
71-
</li>
72-
<li>
73-
<img alt="Color 'paper'" src="aesthetics_color_paper.png"/>
74-
</li>
75-
</list>
76-
77-
- An instance of the `java.awt.Color` class.
53+
Colors can be specified using <a href="named_colors.md">named colors</a>,
54+
theme-dependent system colors (`"pen"`, `"paper"`, `"brush"`), RGB/RGBA strings, HEX values,
55+
or `color(...)`. Named colors are case-insensitive;
56+
hyphens and underscores are ignored, and `grey` is treated the same as `gray`
57+
(`"dark_orange"`, `"light-blue"`, and `"DARK-GREY"` are valid).
58+
In addition to the named colors listed in the <a href="named_colors.md">Named colors reference</a>,
59+
grayscale names from `"gray0"` to `"gray100"` are supported.
60+
Transparency can be included directly in the color value by using an alpha-enabled format
61+
or by appending opacity to a named color, for example `"steelblue / 0.35"`.
62+
63+
<table>
64+
<tr>
65+
<td>Type</td>
66+
<td>Format</td>
67+
<td>Example</td>
68+
</tr>
69+
<tr>
70+
<td>Named color</td>
71+
<td>name</td>
72+
<td>"steelblue"</td>
73+
</tr>
74+
<tr>
75+
<td>Named color with opacity</td>
76+
<td>name / a</td>
77+
<td>"steelblue / 0.35"</td>
78+
</tr>
79+
<tr>
80+
<td>System color</td>
81+
<td>pen, brush, paper</td>
82+
<td>"pen"</td>
83+
</tr>
84+
<tr>
85+
<td>RGB</td>
86+
<td>rgb(r, g, b)</td>
87+
<td>"rgb(70, 130, 180)"</td>
88+
</tr>
89+
<tr>
90+
<td>RGBA</td>
91+
<td>rgba(r, g, b, a)</td>
92+
<td>"rgba(70, 130, 180, 0.35)"</td>
93+
</tr>
94+
<tr>
95+
<td>Color function</td>
96+
<td>color(r, g, b)</td>
97+
<td>"color(70, 130, 180)"</td>
98+
</tr>
99+
<tr>
100+
<td>Color function with opacity</td>
101+
<td>color(r, g, b, a)</td>
102+
<td>"color(70, 130, 180, 0.35)"</td>
103+
</tr>
104+
<tr>
105+
<td>HEX RGB</td>
106+
<td>#RRGGBB, #RGB</td>
107+
<td>"#4682B4", "#48B"</td>
108+
</tr>
109+
<tr>
110+
<td>HEX RGBA</td>
111+
<td>#RRGGBBAA, #RGBA</td>
112+
<td>"#4682B459", "#48B6"</td>
113+
</tr>
114+
<tr>
115+
<td>An instance of the java.awt.Color class</td>
116+
<td>Color.NAME, Color(r, g, b), …</td>
117+
<td>Color.MAGENTA</td>
118+
</tr>
119+
<tr>
120+
<td>Transparent</td>
121+
<td>transparent, blank, empty string</td>
122+
<td>"transparent"</td>
123+
</tr>
124+
</table>
125+
126+
For opacity values, `0` means fully transparent and `1` means fully opaque;
127+
percentage values such as `"steelblue/35%"` are not supported. See also an [example](%nb-color_alpha%).
128+
129+
System colors `"pen"`, `"paper"`, and `"brush"` can be used when you want a color to adapt to the active theme or <a href="presentation_options.md#color-schemes-flavors">flavor</a>.
130+
131+
<list columns="3">
132+
<li>
133+
<img alt="Color 'pen'" src="aesthetics_color_pen.png"/>
134+
</li>
135+
<li>
136+
<img alt="Color 'brush'" src="aesthetics_color_brush.png"/>
137+
</li>
138+
<li>
139+
<img alt="Color 'paper'" src="aesthetics_color_paper.png"/>
140+
</li>
141+
</list>
78142

79143
See [example notebook](%nb-aesthetics-system_colors%).

‎Writerside/topics/charts.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Text:
7070
Cookbooks:
7171

7272
- [Missing values: line, path, area, and ribbon](%nb-missing_values_line_path_area_ribbon%)
73+
- [Indication of removed records](%nb-removed_records_indication%)
7374
- [Drawing graph edges](%nb-graph_edges%)
7475
- [Formatting labels on plots](%nb-formatting_axes_etc%)
7576
- [Text geoms](%nb-text_geoms%)
@@ -329,4 +330,5 @@ Cookbooks:
329330

330331
- [Legend customization](%nb-legend%)
331332
- [Manual legend](%nb-manual_legend%)
333+
- [Customizing legend key size and appearance](%nb-legend_key_size%)
332334
- [Customize legend appearance](%nb-legend_theme%)

‎Writerside/topics/formats.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,15 +159,16 @@ The list of supported directives to format date/time values:
159159
- `%M` - minute as a zero-padded decimal number (00, 01, …, 59);
160160
- `%p` - "AM" or "PM" according to the given time value;
161161
- `%P` - like %p but in lowercase: "am" or "pm";
162-
- `%S` - second as a zero-padded decimal number (00, 01, …, 59).
162+
- `%S` - second as a zero-padded decimal number (00, 01, …, 59);
163+
- `%f` - millisecond as a zero-padded decimal number (000, 001, …, 999).
163164

164165
<note>
165166
If no timezone information is present (naive datetime), Lets-Plot assumes UTC timezone. For timezone-aware datetime objects, the timezone information from the data is preserved and used for rendering.
166167
</note>
167168

168169
### Datetime Format Examples
169170

170-
Let's apply the format string to the date `Aug 6, 2019` and the time `4:46:35`:
171+
Let's apply the format string to the date `Aug 6, 2019` and the time `4:46:35.123`:
171172

172173
```
173174
%a --> "Tue"
@@ -188,8 +189,9 @@ Let's apply the format string to the date `Aug 6, 2019` and the time `4:46:35`:
188189
%P --> "am"
189190
%p --> "AM"
190191
%S --> "35"
192+
%f --> "123"
191193
192-
%Y-%m-%dT%H:%M:%S --> "2019-08-06T04:46:35"
194+
%Y-%m-%dT%H:%M:%S.%f --> "2019-08-06T04:46:35.123"
193195
%m/%d/%Y --> "08/06/2019"
194196
%m-%d-%Y %H:%M --> "08-06-2019 04:46"
195197
%d.%m.%y --> "06.08.19"

‎Writerside/topics/multiplot.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ Cookbooks:
3232
- [Interactive pan/zoom with shared axes in gggrid](%nb-gggrid_scale_share_zoom%)
3333
- [Collecting guides in gggrid()](%nb-gggrid_legend_collect%)
3434

35+
## `ggdeck`
36+
37+
- [`ggdeck`](%api_lets_plot%/ggdeck.html) - overlays several independent plots in one view while keeping their drawing areas aligned.
38+
39+
Cookbooks:
40+
41+
- [Dual-axis effect with ggdeck()](%nb-ggdeck_dual_axis%)
42+
- [Plot overlay with ggdeck()](%nb-ggdeck_plot_overlay%)
43+
3544
## Plot Tags
3645

3746
Plot tags are short labels attached to subplots and composite figures (panel labels, figure numbering).

‎Writerside/topics/named_colors.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ You can specify a color for theme elements and geometries by its name from the t
66
Named colors are case-insensitive and can be written in various formats: "LightGreen", "lightgreen", "light green", or "light-green" are all accepted and treated equivalently. You can also use either "gray" or "grey" spelling for grayscale colors.
77
</note>
88

9+
<note>
10+
Any named color can be made transparent by appending opacity as "/a", where "a" is a value from 0 (fully transparent) to 1 (full opaque). For example, "steelblue/0.35" means "steelblue" with 35% opacity. Percentage opacity values such as "35%" are not supported. See also an <a href="%nb-color_alpha%">example</a>.
11+
</note>
12+
913
## Example {collapsible="true"}
1014

1115
```kotlin

‎Writerside/topics/tooltips.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Tooltip Customization
22

33
You can customize the content, values formatting and appearance of tooltip for any geometry layer by using the parameter `tooltips`.
4-
The parameter takes as value the result of the [`layerToltips()`](%api_tooltips%/layer-tooltips/index.html) function call.
4+
The parameter takes as value the result of the [`layerTooltips()`](%api_tooltips%/layer-tooltips/index.html) function call.
55

66
[Learn more (datalore link)](%nbp-tooltips%).
77

0 commit comments

Comments
 (0)