Skip to content

Commit

Permalink
update book for release refs/tags/0.12.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 2, 2025
1 parent 802f5da commit 1225228
Show file tree
Hide file tree
Showing 15 changed files with 572 additions and 39 deletions.
2 changes: 1 addition & 1 deletion content/fundamentals/shapes.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions content/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h1 class="menu-title">Plotly.rs Book</h1>
<h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
<p>To start using <a href="https://github.com/plotly/plotly.rs">plotly.rs</a> in your project add the following to your <code>Cargo.toml</code>:</p>
<pre><code class="language-toml">[dependencies]
plotly = "0.11"
plotly = "0.12"
</code></pre>
<p><a href="https://github.com/plotly/plotly.rs">Plotly.rs</a> is ultimately a thin wrapper around the <code>plotly.js</code> library. The main job of this library is to provide <code>structs</code> and <code>enums</code> which get serialized to <code>json</code> and passed to the <code>plotly.js</code> library to actually do the heavy lifting. As such, if you are familiar with <code>plotly.js</code> or its derivatives (e.g. the equivalent Python library), then you should find <a href="https://github.com/plotly/plotly.rs"><code>plotly.rs</code></a> intuitive to use.</p>
<p>A <code>Plot</code> struct contains one or more <code>Trace</code> objects which describe the structure of data to be displayed. Optional <code>Layout</code> and <code>Configuration</code> structs can be used to specify the layout and config of the plot, respectively.</p>
Expand Down Expand Up @@ -231,7 +231,7 @@ <h1 id="getting-started"><a class="header" href="#getting-started">Getting Start
<h2 id="saving-plots"><a class="header" href="#saving-plots">Saving Plots</a></h2>
<p>To add the ability to save plots in the following formats: png, jpeg, webp, svg, pdf and eps, you can use the <code>kaleido</code> feature. This feature depends on <a href="https://github.com/plotly/Kaleido">plotly/Kaleido</a>: a cross-platform open source library for generating static images. All the necessary binaries have been included with <code>plotly_kaleido</code> for <code>Linux</code>, <code>Windows</code> and <code>MacOS</code>. Previous versions of <a href="https://github.com/plotly/plotly.rs">plotly.rs</a> used the <code>orca</code> feature, however, this has been deprecated as it provided the same functionality but required additional installation steps. To enable the <code>kaleido</code> feature add the following to your <code>Cargo.toml</code>:</p>
<pre><code class="language-toml">[dependencies]
plotly = { version = "0.11", features = ["kaleido"] }
plotly = { version = "0.12", features = ["kaleido"] }
</code></pre>
<h2 id="webassembly-support"><a class="header" href="#webassembly-support">WebAssembly Support</a></h2>
<p>As of v0.8.0, <a href="https://github.com/plotly/plotly.rs">plotly.rs</a> can now be used in a <code>Wasm</code> environment by enabling the <code>wasm</code> feature in your <code>Cargo.toml</code>:</p>
Expand Down
193 changes: 177 additions & 16 deletions content/print.html

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion content/recipes/basic_charts.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,8 @@ <h1 id="basic-charts"><a class="header" href="#basic-charts">Basic Charts</a></h
<div class="table-wrapper"><table><thead><tr><th style="text-align: left">Kind</th><th style="text-align: center">Link</th></tr></thead><tbody>
<tr><td style="text-align: left">Scatter Plots</td><td style="text-align: center"><a href="./basic_charts/scatter_plots.html"><img src="./img/line_and_scatter_plot.png" alt="Scatter Plots" /></a></td></tr>
<tr><td style="text-align: left">Line Charts</td><td style="text-align: center"><a href="./basic_charts/line_charts.html"><img src="./img/line_shape_options_for_interpolation.png" alt="Line Charts" /></a></td></tr>
<tr><td style="text-align: left">Bar Charts</td><td style="text-align: center"><a href="./basic_charts/scatter_plots.html"><img src="./img/bar_chart_with_error_bars.png" alt="Scatter Plots" /></a></td></tr>
<tr><td style="text-align: left">Bar Charts</td><td style="text-align: center"><a href="./basic_charts/scatter_plots.html"><img src="./img/bar_chart_with_error_bars.png" alt="Bar Charts" /></a></td></tr>
<tr><td style="text-align: left">Pie Charts</td><td style="text-align: center"><a href="./basic_charts/pie_charts.html"><img src="./img/pie_charts.png" alt="Pie Charts" /></a></td></tr>
<tr><td style="text-align: left">Sankey Diagrams</td><td style="text-align: center"><a href="./basic_charts/sankey_diagrams.html"><img src="./img/basic_sankey.png" alt="Sankey Diagrams" /></a></td></tr>
</tbody></table>
</div>
Expand Down
4 changes: 2 additions & 2 deletions content/recipes/basic_charts/bar_charts.html
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ <h2 id="stacked-bar-chart"><a class="header" href="#stacked-bar-chart">Stacked B
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="../../recipes/basic_charts/sankey_diagrams.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a rel="next prefetch" href="../../recipes/basic_charts/pie_charts.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

Expand All @@ -264,7 +264,7 @@ <h2 id="stacked-bar-chart"><a class="header" href="#stacked-bar-chart">Stacked B
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="../../recipes/basic_charts/sankey_diagrams.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a rel="next prefetch" href="../../recipes/basic_charts/pie_charts.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
Expand Down
Loading

0 comments on commit 1225228

Please sign in to comment.