From 7b4542c78e57d9838410c499f52ad27a00757fa0 Mon Sep 17 00:00:00 2001 From: Andrei Gherghescu <8067229+andrei-ng@users.noreply.github.com> Date: Fri, 6 Dec 2024 16:29:51 +0100 Subject: [PATCH] update readmes Signed-off-by: Andrei Gherghescu <8067229+andrei-ng@users.noreply.github.com> --- CHANGELOG.md | 8 ++++++++ README.md | 8 ++++++-- examples/customization/README.md | 2 +- 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b27e40e8..9cf2ea1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.11.1] - 2024-12-X +### Changed +- + +### Fixed +- [[#175](https://github.com/plotly/plotly.rs/issues/175)] Put multiple subplots in the same html - added an example using `build_html` crate. +- [[#228](https://github.com/plotly/plotly.rs/issues/228)] Redraw function seems to be broken - added example on generating responsive plots. + ## [0.11.0] - 2024-12-06 ### Changed - [[#251](https://github.com/plotly/plotly.rs/pull/251)] Expose image data as String with `to_base64` and `to_svg` using Kaleido diff --git a/README.md b/README.md index 3eb81720..f28f78ce 100644 --- a/README.md +++ b/README.md @@ -108,8 +108,6 @@ plotly = { version = "0.11", features = ["kaleido"] } With this feature enabled, plots can be saved as any of `png`, `jpeg`, `webp`, `svg`, `pdf` and `eps`. Note that the plot will be a static image, i.e. they will be non-interactive. -The Kaleido binary is downloaded for your system's architecture at compile time from the official Kaleido [release page](https://github.com/plotly/Kaleido/releases). This library currently supports `x86_64` on Linux and Windows, and both `x86_64` and `aarch64` on macOS. - Exporting a simple plot looks like this: ```rust @@ -122,6 +120,12 @@ plot.add_trace(trace); plot.write_image("out.png", ImageFormat::PNG, 800, 600, 1.0); ``` +### _Kaleido dependency_ + +On your host, when building this project with the `kaleido` feature enabled the Kaleido binary is downloaded automatically for your system's architecture at compile time from the official Kaleido [release page](https://github.com/plotly/Kaleido/releases). This library currently supports `x86_64` on Linux and Windows, and both `x86_64` and `aarch64` on macOS. + +When building application for other targets that depend on this feature, the `Kaleido` binary will need to be installed manually on the target machine. Currently, the location where the binary is expected is hardcoded depending on the target OS. E.g., on Linux this defaults to `~/.config/kaleido`. This is defined in source code at [here](https://github.com/plotly/plotly.rs/blob/1405731b5121c1343b491e307222a21ef4becc5e/plotly_kaleido/src/lib.rs#L89) + ## Usage Within a Wasm Environment Using `Plotly.rs` in a Wasm-based frontend framework is possible by enabling the `wasm` feature: diff --git a/examples/customization/README.md b/examples/customization/README.md index 530ce37e..dc1cb4ed 100644 --- a/examples/customization/README.md +++ b/examples/customization/README.md @@ -2,7 +2,7 @@ We often get issues/questions regarding customization of the HTML output. In most situations, these are not related to Plotly functionality but rather custom behavior related to HTML rendering. -The directory [./customization](./customization) contains examples of the most frequent raised questions by users of `plotly-rs`, such as +This example pacakge contains examples of the most frequent raised questions by users of `plotly-rs`, such as - making the resulting HTML plot responsive on browser window size change - making the resulting HTML fill the entire browser page - placing multiple plots in the same HTML page using the [`build_html`](https://crates.io/crates/build_html) crate