Skip to content

Commit bedf5e9

Browse files
alshanalshan
committed
Update docs: what's new in 3.2.0, etc.
1 parent 5152491 commit bedf5e9

File tree

5 files changed

+122
-86
lines changed

5 files changed

+122
-86
lines changed

‎CHANGELOG.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,61 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
66
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). All scales should have the 'format' parameter.
7-
7+
8+
## [3.2.0] - 2022-03-29
9+
10+
### Added
11+
12+
- New geometries:
13+
- `geomViolin()`
14+
15+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_violin.ipynb).
16+
17+
- `geomDotplot()`
18+
19+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_dotplot.ipynb).
20+
21+
- `geomYDotplot()`
22+
23+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_dotplot.ipynb).
24+
25+
26+
- Plot subtitle and caption:
27+
`subtitle` parameter in `ggtitle()` and `labs()`,
28+
`caption` parameter in `labs()`,
29+
`plotSubtitle` and `plotCaption` parameters in `theme()`.
30+
31+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/title_subtitle_caption.ipynb).
32+
33+
- Multi-line labels: The 'newline' character (`\n`) now works as `line break` in plot title, subtitle and caption, in legend's title and in tooltips.
34+
35+
- In tooltip customization API: the `title()` option defines a tooltip "title" text which will always appear above the rest of the tooltip content.
36+
37+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/tooltip_title.ipynb).
38+
39+
- Parameter `scales` in `facetGrid()/facetWrap()` [[#451](https://github.com/JetBrains/lets-plot/issues/451),
40+
[#479](https://github.com/JetBrains/lets-plot/issues/479)].
41+
42+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets_free_scales.ipynb).
43+
44+
45+
### Changed
46+
47+
- New tooltip style: rounded corners, bold label, colored marker inside the tooltip.
48+
- Deprecated tooltip customization API: function `color()` will be removed in one of the future releases.
49+
- 'Auto shrink': plots automatically shrink when necessary to fit width of the output (notebook) cell [[#488](https://github.com/JetBrains/lets-plot/issues/488)].
50+
51+
### Fixed
52+
53+
- Automatic detection of DateTime series [[#99](https://github.com/JetBrains/lets-plot-kotlin/issues/99)].
54+
- Too limited mapping options in GenericAesMapping [[#82](https://github.com/JetBrains/lets-plot-kotlin/issues/82)]
55+
- scaleColorManual Divide by Zero with 1 mapping [[#506](https://github.com/JetBrains/lets-plot/issues/506)].
56+
- LinearBreaksHelper$Companion.computeNiceBreaks out of memory error [[#105](https://github.com/JetBrains/lets-plot-kotlin/issues/105)].
57+
- CVE-2021-23792 in org.jetbrains.lets-plot:lets-plot-image-export@2.2.1 [[#497](https://github.com/JetBrains/lets-plot/issues/497)].
58+
- Fix tooltips for `geom_histogram(stat='density')`.
59+
- The axis tooltip overlaps the general tooltip [[#515](https://github.com/JetBrains/lets-plot/issues/515)].
60+
- The multi-layer tooltip detection strategy will only be used if more than one layer provides tooltips.
61+
862

963
## [3.1.1] - 2021-12-13
1064

‎README.md

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
- [Saving plot to file](#export)
4545
- [GeoTools support](#geotools)
4646

47-
- [What is new in 3.1.0](#new)
47+
- [What is new in 3.2.0](#new)
4848
- [Change log](#change_log)
4949
- [License](#license)
5050

@@ -246,47 +246,56 @@ Learn more: [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blo
246246

247247
<a id="new"></a>
248248

249-
## What is new in 3.1.0
249+
## What is new in 3.2.0
250250

251-
- Added support for `coordFlip()`.
251+
- ### Geometries
252252

253-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/coord_flip.ipynb)
254-
.
253+
- `geomViolin()`
255254

256-
- Improved plot appearance and better `theme` support:
255+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_violin.ipynb).
257256

258-
- Bigger fonts across the board;
259-
- Gridlines;
260-
- 4 themes from ggplot2 (R) library: `themeGrey(), themeLight(), themeClassic(), themeMinimal()`;
261-
- Our designer theme: `themeMinimal2()` (used by default);
262-
- `themeNone()` for the case you want to design another theme;
263-
- A lot more parameters in the `theme()` function, also helpers: `elementLine()`, `elementRect()`, `elementText()`.
257+
- `geomDotplot()`
264258

265-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/themes.ipynb)
266-
.
259+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_dotplot.ipynb).
267260

268-
> Note: fonts size, family and face still can not be configured.
261+
- `geomYDotplot()`
269262

270-
- Improved Date-time formatting support:
263+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_dotplot.ipynb).
271264

272-
- tooltip format() should understand date-time format
273-
pattern [[#387](https://github.com/JetBrains/lets-plot/issues/387)];
274-
- scaleXDatetime should apply date-time formatting to the
275-
breaks [[#392](https://github.com/JetBrains/lets-plot/issues/392)].
265+
- ### Labels and Legends
276266

277-
See `Out[7, 8, 10]` in
278-
the [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/formatting_axes_etc.ipynb)
279-
.
267+
- Plot **subtitle** and **caption** are now supported.
280268

281-
- `CorrPlot()` function now also accepts pre-computed correlation coefficients.
269+
You can use parameter `subtitle`in `ggtitle()` and `labs()` to add a subtitle below the plot' title, and
270+
parameter `caption` in `labs()` to add a caption below plot.
282271

283-
- Kotlin/JS IR: `xxx.klib` artifacts are now available.
272+
- Multi-line labels.
284273

285-
See: [sample Kotlin/JS IR app](https://github.com/alshan/lets-plot-mini-apps/tree/main/js-ir-frontend-app)
274+
The 'newline' character (`\n`) now works as `line break` in plot title, subtitle and caption, in legend's title and in tooltips.
275+
276+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/title_subtitle_caption.ipynb).
277+
278+
- ### Tooltips
279+
280+
<img src="https://raw.githubusercontent.com/JetBrains/lets-plot/master/docs/f-22a/images/tooltip.png" alt="f-22a/images/tooltip.png" width="362" height="310">
281+
282+
- Improved appearance
283+
- Automatic word wrap makes long text values look better
284+
- Tooltip title
285+
286+
You can use new method `title()` in the [Tooltip castomization API](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md) to add a title to tooltip.
287+
288+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/tooltip_title.ipynb).
289+
290+
- ### Facets
291+
292+
"Free" scales are now supported on faceted plots.
293+
294+
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets_free_scales.ipynb).
286295

287296

288297
- Other improvements and fixes -
289-
see [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md#310---2021-11-05)
298+
see [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md#310---2022-03-29)
290299
for details.
291300

292301
<a id="change_log"></a>

‎docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/examples.md
44

55
### Explore example notebooks in Binder:
66

7-
https://mybinder.org/v2/gh/JetBrains/lets-plot-kotlin/v3.1.1demos1?filepath=docs/examples/jupyter-notebooks/
7+
https://mybinder.org/v2/gh/JetBrains/lets-plot-kotlin/v3.2.0demos1?filepath=docs/examples/jupyter-notebooks/
88

99
### Browse Lets-Plot Kotlin API:
1010

‎docs/examples.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ Try the following tutorials and examples to learn and evaluate various features
66
- [Geoms and Stats](#geoms_n_stats)
77
- [Position Adjustment](#pos)
88
- [Scales](#scales)
9+
- [Time Series](#time-series)
910
- [Facets](#facets)
11+
- [Coordinate Systems](#coord-sys)
1012
- [Grouping Plots](#ggbunch)
1113
- [Ordering categories, `asDiscrete()` function](#as_discrete)
1214
- [Export to File](#export)
1315
- [Formatting](#formatting)
14-
- [Theme](#theme)
16+
- [Themes](#theme)
1517
- [Data Sampling](#sampling)
1618
- [Tooltip Customization](#tooltip)
1719
- [Correlation Plot](#corrplot)
@@ -71,11 +73,32 @@ Try the following tutorials and examples to learn and evaluate various features
7173
* `scaleFillHue, scaleFillGrey, scaleColorGradient` : [contours.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/contours.ipynb)
7274

7375

76+
<a id="time-series"></a>
77+
#### Time Series
78+
79+
`scaleXDatetime(), scaleYDatetime(), scaleYTime(), scaleYTime()`
80+
81+
* [scale_time.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scale_time.ipynb)
82+
* [formatting_axes_etc.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/formatting_axes_etc.ipynb)
83+
84+
7485
<a id="facets"></a>
7586
#### Facets
7687

77-
* `facetGrid(), facetWrap()`:
78-
[facets.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets.ipynb)
88+
`facetGrid(), facetWrap()`
89+
90+
* [facets.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets.ipynb)
91+
* [facets_free_scales.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets_free_scales.ipynb)
92+
93+
94+
<a id="coord-sys"></a>
95+
96+
#### Coordinate Systems
97+
98+
`coordCartesian(), coordFixed(), coordMap(), coordFlip()`
99+
100+
* [facets.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/coord_flip.ipynb)
101+
79102

80103
<a id="ggbunch"></a>
81104
#### Grouping Plots
@@ -102,6 +125,7 @@ A simple utility which you can use to arrange plots in a regular grid.
102125
* [ordering_examples.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/ordering_examples.ipynb)
103126
* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
104127

128+
105129
<a id="export"></a>
106130

107131
#### Export to File
@@ -119,7 +143,9 @@ The `ggsave()` function is an easy way to export plot to a file in SVG, HTML or
119143

120144
<a id="theme"></a>
121145

122-
#### Theme
146+
#### Themes
147+
148+
`themeGrey(), themeLight(), themeClassic(), themeMinimal()` and `themeMinimal2()` (used by default).
123149

124150
* [themes.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/themes.ipynb)
125151
* [legend_and_axis.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/legend_and_axis.ipynb)

‎future_changes.md

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +0,0 @@
1-
## [3.1.2] - 2022-xx-xx
2-
3-
### Added
4-
5-
- New geometries:
6-
- `geomViolin()`
7-
8-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_violin.ipynb).
9-
10-
- `geomDotplot()`
11-
12-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_dotplot.ipynb).
13-
14-
- `geomYDotplot()`
15-
16-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_dotplot.ipynb).
17-
18-
19-
- Plot subtitle and caption:
20-
`subtitle` parameter in `ggtitle()` and `labs()`,
21-
`caption` parameter in `labs()`,
22-
`plotSubtitle` and `plotCaption` parameters in `theme()`.
23-
24-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/title_subtitle_caption.ipynb).
25-
26-
- Multi-line labels: The 'newline' character (`\n`) now works as `line break` in plot title, subtitle and caption, in legend's title and in tooltips.
27-
28-
- In tooltip customization API: the `title()` option defines a tooltip "title" text which will always appear above the rest of the tooltip content.
29-
30-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/tooltip_title.ipynb).
31-
32-
- Parameter `scales` in `facetGrid()/facetWrap()` [[#451](https://github.com/JetBrains/lets-plot/issues/451),
33-
[#479](https://github.com/JetBrains/lets-plot/issues/479)].
34-
35-
See: [example notebook](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets_free_scales.ipynb).
36-
37-
38-
### Changed
39-
40-
- New tooltip style: rounded corners, bold label, colored marker inside the tooltip.
41-
- Deprecated tooltip customization API: function `color()` will be removed in one of the future releases.
42-
- 'Auto shrink': plots automatically shrink when necessary to fit width of the output (notebook) cell [[#488](https://github.com/JetBrains/lets-plot/issues/488)].
43-
44-
### Fixed
45-
46-
- Automatic detection of DateTime series [[#99](https://github.com/JetBrains/lets-plot-kotlin/issues/99)].
47-
- Too limited mapping options in GenericAesMapping [[#82](https://github.com/JetBrains/lets-plot-kotlin/issues/82)]
48-
- scaleColorManual Divide by Zero with 1 mapping [[#506](https://github.com/JetBrains/lets-plot/issues/506)].
49-
- LinearBreaksHelper$Companion.computeNiceBreaks out of memory error [[#105](https://github.com/JetBrains/lets-plot-kotlin/issues/105)].
50-
- CVE-2021-23792 in org.jetbrains.lets-plot:lets-plot-image-export@2.2.1 [[#497](https://github.com/JetBrains/lets-plot/issues/497)].
51-
- Fix tooltips for `geom_histogram(stat='density')`.
52-
- The axis tooltip overlaps the general tooltip [[#515](https://github.com/JetBrains/lets-plot/issues/515)].
53-
- The multi-layer tooltip detection strategy will only be used if more than one layer provides tooltips.

0 commit comments

Comments
 (0)