Align API for saving/showing plots more closely with plotly.py #89
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mfreeborn
added a commit
that referenced
this pull request
Aug 26, 2022
* Update dependencies * Improve NumOrString (#76) * reimplement NumOrString + tests * changelog * Fix contributing typos (#77) * fix typos * update changelog * Fix Visible enum implementation (#70) * implement proper Visible enum * fix implementation and add tests * improve test * remove TruthyEnum * update changelog * add PartialEq impl and tests (#61) * add PartialEq impl and tests * impl clone with test * add Clone derives * update changelog * Add support for the majority of config options (#65) * add support for the majority of config options * fix enum serialization representations * add DoubleClick enum * refine options * doc fix * add tests * fix dependencies * update changelog * add setter for `Plot.configuration` * impl Serialize for Plot (#68) * impl Serialize for Plot * serialize Traces/Layout separately * improve tests * refactor template rendering with serializable plot * add to doctest to prove html tags aren't escaped * update changelog * add getter for `Plot.configuration` * Add support for layout templates (#62) * add LayoutTemplate struct * add constructor for Template * add test * WIP * support static predefined themes * implement plotly_dark layout template * make theme public * fix colorbar recursive Default impl * fix incorrect rename for Marker.size_mode * make Layout::template() method generic * add plotly_white and default (empty) themes * fix dependencies * update changelog * Serialize plotly_kaleido::PlotData correctly (#75) * impl Serialize for Plot * serialize Traces/Layout separately * improve tests * refactor template rendering with serializable plot * add to doctest to prove html tags aren't escaped * serialize PlotData * serialize PlotData * update changelog * Support wasm (#59) * builds for wasm-unknown-unknown * add wasm feature to readme * update conditional compilation derives * add bindings to plotly.js newPlot() and react() * add helper function Plot::to_js_object() * fix imports * update changelog * update workflows for new feature * fix conditional imports * update readme * fix variable interpolation (#78) * Add tests (#74) * partial test coverage of common/mod.rs * finish tests for common.rs * start layout tests * finish tests for enums * just a few more structs to go for layout... * more tests * make tests pass * update changelog * Support Sankey Diagrams (#69) * working basic example * fix examples * implement the rest of sankey * fix Domain * improve test * add sankey tests * add test for Domain * fix tests * add Sankey to book * Impl clone for colors (#79) * add Clone/Copy derives * update changelog * Update plotly js (#80) * update plotly and mathjax deps * fix imports + typo * update changelog * Add tests for layout module (#81) * add tests for bar trace (#82) * Fix stack overflow in layout tests (#83) * box some layout struct fields * undo method signature changes * Fix unused Dependencies warning with proper feature gating #84 * Tidy up folder structure (#85) * reconfigure folder structure * disambiguate import and fix feature gating * Refactor Color trait and apply throughout codebase (#87) * Add Scatter3d support (#66) * scatter 3D plot example running * added 3D line plot and examples for 3d line plot and surface plot * fixes and cleanup * adjusted CHANGELOG.md * adjusted CHANGELOG.md * remove unintentionally included test output file * fix merge * tweak examples * derive Default and sort imports * fix feature-gated import * add tests * update book * fix examples * add plot3d examples to ci * update book * fix newest book examples Co-authored-by: Michael Freeborn <[email protected]> * Align API for saving/showing plots more closely with plotly.py (#89) * reconfigure API for saving/showing plots * update changelog * update book introduction with new api * add rustfmt step to ci (#90) * add wasm example to book (#91) * Add serde_with::skip_serializing_none macro (#94) * add serde_with dependency * apply skip_serializing_none macro * finish applying skip_if_none macro * fix typo * fix typo * clippy lints (#95) * add tests (#96) * add tests * add tests * prepare v0.8.0 (#97) Co-authored-by: Ioannis Giagkiozis <[email protected]> Co-authored-by: Mario Herzog <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR refactors the main API for showing and saving plots to more closely align with the familiar plotly.py.
Plot::show()displays the interactive HTML plot in the broswer.Plot::show_image(...)displays a static image of the given format in the browser.Plot::to{_inline}_html(...)renders the plot as an HTML string, either fully standalone or inline.Plot::write_html(...)saves the image to an HTML file (kaleido not required).Plot::write_image(...)uses kaleido to save a static image of the plot.During the process, I've also refactored the HTML templates to use cleaner Javascript code, and added some tests, too.