Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jetbrains/lets-plot-kotlin

Grammar of Graphics for Kotlin
https://github.com/jetbrains/lets-plot-kotlin

charts geotools ggplot ggplot2 graphics jupyter jupyter-notebooks jvm kotlin kotlin-api plot plot-library plots plots-in-kotlin

Last synced: about 1 month ago
JSON representation

Grammar of Graphics for Kotlin

Host: GitHub
URL: https://github.com/jetbrains/lets-plot-kotlin
Owner: JetBrains
License: mit
Created: 2019-02-26T09:42:50.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-05-24T17:26:58.000Z (6 months ago)
Last Synced: 2024-05-29T19:45:18.402Z (5 months ago)
Topics: charts, geotools, ggplot, ggplot2, graphics, jupyter, jupyter-notebooks, jvm, kotlin, kotlin-api, plot, plot-library, plots, plots-in-kotlin
Language: Kotlin
Homepage: https://lets-plot.org/kotlin/
Size: 56.4 MB
Stars: 412
Watchers: 173
Forks: 36
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Lets-Plot Kotlin API

A **Grammar of Graphics** for Kotlin.

[![official JetBrains project](http://jb.gg/badges/official-flat-square.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)

[![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/JetBrains/lets-plot-kotlin/master/LICENSE)

[![Latest Release](https://img.shields.io/github/v/release/JetBrains/lets-plot-kotlin)](https://github.com/JetBrains/lets-plot-kotlin/releases/latest)

**Lets-Plot Kotlin API** is a Kotlin API for [Lets-Plot Multiplatform](https://github.com/JetBrains/lets-plot) 

 plotting library, \

which is built on the principles of layered graphics first described in the \

Leland Wilkinson work [The Grammar of Graphics](https://www.goodreads.com/book/show/2549408.The_Grammar_of_Graphics).

    

        

             

               

            

        

        

            
Lets-Plot Kotlin API is largely based on the API
provided by 

            ggplot2 package well-known to data scientists who use R.

            To learn more about the Grammar of Graphics,
we recommend an excellent book called
 

            “ggplot2: Elegant Graphics for Data Analysis”. 

            This will be a good prerequisite for further exploration of the Lets-Plot library.

          

    



### Quickstart

Inside [Kotlin Notebook](https://plugins.jetbrains.com/plugin/16340-kotlin-notebook),

[Datalore](https://datalore.jetbrains.com/) or

[Jupyter with Kotlin Kernel](https://github.com/Kotlin/kotlin-jupyter#readme):

```

%use lets-plot

```     

```kotlin

val rand = java.util.Random()

val data = mapOf(

    "rating" to List(200) { rand.nextGaussian() } + List(200) { rand.nextGaussian() * 1.5 + 1.5 },

    "cond" to List(200) { "A" } + List(200) { "B" }

)

var p = letsPlot(data)

p += geomDensity(color = "dark_green", alpha = .3) { x = "rating"; fill = "cond" }

p + ggsize(700, 350)

```






See the "Quickstart" notebook in [Datalore](https://datalore.jetbrains.com/view/notebook/aTA9lQnPkRwdCzT6uy95GZ) or

[Jupyter nbviewer](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/quickstart.ipynb).



## Table of Contents

             

- [Usage](#usage)

  - [Notebooks](#in-notebook)

  - [Compose Multiplatform](#in-compose-multiplatform)

  - [JVM and Kotlin/JS](#in-jvm-js)

- [Documentation](#documentation)

- [What is new in 4.8.0](#new)

- [Recent Updates in the Gallery](#recent_gallery_updates)

- [Change Log](#change_log)

- [Code of Conduct](#CoC)

- [License](#license)

                          



## Usage



### Notebooks

With the help of Lets-Plot Kotlin API you can easily create plots in [Kotlin Notebook](https://plugins.jetbrains.com/plugin/16340-kotlin-notebook),

[Datalore](https://datalore.jetbrains.com/), [Jupyter with Kotlin Kernel](https://github.com/Kotlin/kotlin-jupyter#readme) \

or any other notebook that supports `Kotlin Kernel`.

#### "Line Magics"

```

%use lets-plot

```  

This "line magic" will apply **Lets-Plot library descriptor** which adds to your notebook all the boilerplate code necessary to create plots.

By default, `library descriptor` is bundled with the Kotlin Jupyter Kernel installed in your environment. \

However, you can override the default settings using:

```

%useLatestDescriptors

```

In this case the latest `library descriptor` will be pulled from the [Kotlin Jupyter Libraries](https://github.com/Kotlin/kotlin-jupyter-libraries) repository.

#### Library Descriptor Parameters

```

%use lets-plot(api=4.8.0, lib=4.4.1, js=4.4.1, isolatedFrame=false)

```                                                                 

- `api` - version of the Lets-Plot Kotlin API.

- `lib` - version of the Lets-Plot Multiplatform (JARs).

- `js`  - version of the Lets-PLot Multiplatform JavaScript bundle.

- `isolatedFrame` - If `false`: load JS just once per notebook (default in Jupyter).

  If `true`: include Lets-Plot JS in each output (default in [Datalore](https://datalore.jetbrains.com/) notebooks).



### Compose Multiplatform

To learn how to embed Lets-Plot charts in [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform) applications, please check out the [Lets-Plot Skia Frontend](https://github.com/JetBrains/lets-plot-skia) project.

   



### JVM and Kotlin/JS

To learn more about creating plots in JVM or Kotlin/JS environment please read [USAGE_SWING_JFX_JS.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/USAGE_BATIK_JFX_JS.md). 

        

#### Examples

Examples of using of the Lets-Plot Kotlin API in JVM and Kotlin/JS applications are available in the [Lets-Plot Kotlin Mini Apps (Demos)](https://github.com/alshan/lets-plot-mini-apps) GitHub repository.



## Documentation

* _Lets-Plot Kotlin API_ documentation and API reference: [**Lets-Plot for Kotlin**](https://lets-plot.org/kotlin)

* A quick introduction to the _Grammar of Graphics_ and _Lets-Plot Kotlin API_: [Lets-Plot Usage Guide](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/guide/user_guide.ipynb) 



## What is new in 4.8.0

- #### Waterfall Plot

  

  See [example notebook](https://nbviewer.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/f-4.8.0/waterfall_plot.ipynb).

- #### **`geomBand()`**:

  

  See [example notebook](https://nbviewer.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/f-4.8.0/geom_band.ipynb).

- #### Custom Legends

  - `manualKey` parameter in plot layer

  - `layerKey()` function

    


    

  See [example notebook](https://nbviewer.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/f-4.8.0/manual_legend.ipynb).

- #### Customizing Legends Appearance

  Override aesthetics in the `guideLegend()` function.

  See [example notebook](https://nbviewer.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/f-4.8.0/legend_override_aes.ipynb).

- #### And More

  See [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md) for a full list of changes.



## Recent Updates in the [Gallery](https://lets-plot.org/kotlin/gallery.html)

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



## Change Log

See [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md).



## Code of Conduct

This project and the corresponding community are governed by the 

[JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct). 

Please make sure you read it.



## License

Code and documentation released under

the [MIT license](https://github.com/JetBrains/lets-plot-kotlin/blob/master/LICENSE).

Copyright © 2019-2024, JetBrains s.r.o.