Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
juba committed May 26, 2024
1 parent 44754e3 commit 6b14090
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,18 @@ If you just want to try this package without installing it on your computer, you
**Features:**

- Syntax as close as possible to the JavaScript one
- Two renderers available: `widget`, which generates plots as Jupyter widgets, and `jsdom`, which generates SVG, HTML or PNG outputs (via typst)
- Plots can be generated as Jupyter widgets, or as SVG, HTML or PNG outputs (via typst)
- Plots can be saved to SVG, HTML, PNG or PDF files
- [Pandas](https://pandas.pydata.org) and [polars](https://pola.rs) DataFrame and Series objects are serialized using [Arrow](https://arrow.apache.org) IPC format for improved speed and better data type conversions
- Works with Jupyter notebooks and Quarto documents
- Works offline, no iframe or dependency to Observable runtime
- Caching mechanism of data objects if they are used several times in the same plot
- Custom JavaScript code can be passed as strings with the `js` method
- Python `date` and `datetime` objects are automatically converted to JavaScript `Date` objects
- Works with Jupyter notebooks and Quarto documents
- Plots can be saved to SVG, HTML, PNG or PDF files

**Limitations:**

- Plot interactions (tooltips, crosshair...) are not available with the `jsdom` renderer (<https://github.com/juba/pyobsplot/issues/16>).
- Plot interactions (tooltips, crosshair...) are only available with the "widget" format (<https://github.com/juba/pyobsplot/issues/16>).
- Very limited integration with IDE (documentation and autocompletion) for Plot methods. (<https://github.com/juba/pyobsplot/issues/13>)

## Credits
Expand Down

0 comments on commit 6b14090

Please sign in to comment.