+
+ 
@@ -25,7 +25,7 @@
|
API Docs
|
- Changelog
+ Changelog
@@ -44,10 +44,10 @@
A plotting library for Rust powered by [Plotly.js](https://plot.ly/javascript/).
-Documentation and numerous interactive examples are available in the [Plotly.rs Book](https://igiagkiozis.github.io/plotly/content/getting_started.html), the [examples/](https://github.com/igiagkiozis/plotly/tree/master/examples) directory and [docs.rs](https://docs.rs/crate/plotly).
+Documentation and numerous interactive examples are available in the [Plotly.rs Book](https://igiagkiozis.github.io/plotly/content/getting_started.html), the [examples/](https://github.com/igiagkiozis/plotly/tree/main/examples) directory and [docs.rs](https://docs.rs/crate/plotly).
-For changes since the last version, please consult the [changelog](https://github.com/igiagkiozis/plotly/blob/master/CHANGELOG.md).
+For changes since the last version, please consult the [changelog](https://github.com/igiagkiozis/plotly/blob/main/CHANGELOG.md).
# Basic Usage
@@ -163,13 +163,13 @@ pub fn plot_component() -> Html {
}
});
-
+
use_effect_with_deps(move |_| {
p.run();
|| ()
}, (),
);
-
+
html! {
+ 
@@ -18,4 +18,4 @@
# Fundamentals
-Functionality that applies to the library as a whole is described in the next sections.
\ No newline at end of file
+Functionality that applies to the library as a whole is described in the next sections.
\ No newline at end of file
diff --git a/docs/book/src/fundamentals/jupyter_support.md b/docs/book/src/fundamentals/jupyter_support.md
index 2576aa91..26d8c944 100644
--- a/docs/book/src/fundamentals/jupyter_support.md
+++ b/docs/book/src/fundamentals/jupyter_support.md
@@ -1,12 +1,12 @@
# Jupyter Support
-As of version `0.7.0`, [Plotly.rs](https://github.com/igiagkiozis/plotly) has native support for the [EvCxR Jupyter Kernel](https://github.com/google/evcxr/tree/master/evcxr_jupyter).
+As of version `0.7.0`, [Plotly.rs](https://github.com/igiagkiozis/plotly) has native support for the [EvCxR Jupyter Kernel](https://github.com/google/evcxr/tree/master/evcxr_jupyter).
Once you've installed the required packages you'll be able to run all the examples shown here as well as all [the recipes](../recipes.md) in Jupyter Lab!
## Installation
-It is assumed that an installation of the [Anaconda](https://www.anaconda.com/products/individual) Python distribution is already present in the system. If that is not the case you can follow these [instructions](https://www.anaconda.com/products/individual) to get up and running with `Anaconda`.
+It is assumed that an installation of the [Anaconda](https://www.anaconda.com/products/individual) Python distribution is already present in the system. If that is not the case you can follow these [instructions](https://www.anaconda.com/products/individual) to get up and running with `Anaconda`.
```shell script
conda install -c plotly plotly=4.9.0
@@ -20,17 +20,17 @@ conda install notebook
Although there are alternative methods to enable support for the [EvCxR Jupyter Kernel](https://github.com/google/evcxr/tree/master/evcxr_jupyter), we have elected to keep the requirements consistent with what those of other languages, e.g. Julia, Python and R. This way users know what to expect; and also the folks at [Plotly](https://plotly.com/python/getting-started/#jupyter-notebook-support) have done already most of the heavy lifting to create an extension for Jupyter Lab that works very well.
-Run the following to install the Plotly Jupyter Lab extension:
+Run the following to install the Plotly Jupyter Lab extension:
```shell script
jupyter labextension install jupyterlab-plotly@4.9.0
```
-Once this step is complete to make sure the installation so far was successful, run the following command:
+Once this step is complete to make sure the installation so far was successful, run the following command:
```shell script
jupyter lab
```
-Open a `Python 3` kernel copy/paste the following code in a cell and run it:
+Open a `Python 3` kernel copy/paste the following code in a cell and run it:
```python
import plotly.graph_objects as go
fig = go.Figure(data=go.Bar(x=['a', 'b', 'c'], y=[11, 22, 33]))
@@ -62,7 +62,7 @@ If you're not familiar with the EvCxR kernel it would be good that you at least
## Usage
-Launch Jupyter Lab:
+Launch Jupyter Lab:
```shell script
jupyter lab
```
@@ -104,6 +104,6 @@ plot.set_layout(layout);
plot.lab_display();
format!("EVCXR_BEGIN_CONTENT application/vnd.plotly.v1+json\n{}\nEVCXR_END_CONTENT", plot.to_json())
```
-For Jupyter Lab there are two ways to display a plot in the `EvCxR` kernel, either have the plot object be in the last line without a semicolon or directly invoke the `Plot::lab_display` method on it; both have the same result. You can also find an example notebook [here](https://github.com/igiagkiozis/plotly/blob/master/examples/jupyter/jupyter_lab.ipynb) that will periodically be updated with examples.
+For Jupyter Lab there are two ways to display a plot in the `EvCxR` kernel, either have the plot object be in the last line without a semicolon or directly invoke the `Plot::lab_display` method on it; both have the same result. You can also find an example notebook [here](https://github.com/igiagkiozis/plotly/blob/main/examples/jupyter/jupyter_lab.ipynb) that will periodically be updated with examples.
-The process for Jupyter Notebook is very much the same with one exception; the `Plot::notebook_display` method must be used to display the plot. You can find an example notebook [here](https://github.com/igiagkiozis/plotly/blob/master/examples/jupyter/jupyter_notebook.ipynb)
+The process for Jupyter Notebook is very much the same with one exception; the `Plot::notebook_display` method must be used to display the plot. You can find an example notebook [here](https://github.com/igiagkiozis/plotly/blob/main/examples/jupyter/jupyter_notebook.ipynb)
diff --git a/docs/book/src/fundamentals/ndarray_support.md b/docs/book/src/fundamentals/ndarray_support.md
index b1048dda..474fed0e 100644
--- a/docs/book/src/fundamentals/ndarray_support.md
+++ b/docs/book/src/fundamentals/ndarray_support.md
@@ -1,4 +1,4 @@
-# `ndarray` Support
+# `ndarray` Support
To enable [ndarray](https://github.com/rust-ndarray/ndarray) support in [Plotly.rs](https://github.com/igiagkiozis/plotly) add the following feature to your `Cargo.toml` file:
```toml
@@ -6,11 +6,11 @@ To enable [ndarray](https://github.com/rust-ndarray/ndarray) support in [Plotly.
plotly = { version = ">=0.7.0", features = ["plotly_ndarray"] }
```
-This extends the [Plotly.rs](https://github.com/igiagkiozis/plotly) API in two ways:
+This extends the [Plotly.rs](https://github.com/igiagkiozis/plotly) API in two ways:
* `Scatter` traces can now be created using the `Scatter::from_ndarray` constructor,
* and also multiple traces can be created with the `Scatter::to_traces` method.
-The full source code for the examples below can be found [here](https://github.com/igiagkiozis/plotly/blob/master/plotly/examples/ndarray_support.rs).
+The full source code for the examples below can be found [here](https://github.com/igiagkiozis/plotly/blob/main/plotly/examples/ndarray_support.rs).
## `ndarray` Traces
@@ -55,7 +55,7 @@ var layout = {};
### Multiple Traces
-To display a `2D` array (`Array<_, Ix2>`) you can use the `Scatter::to_traces` method. The first argument of the method represents the common axis for the traces (`x` axis) whilst the second argument contains a collection of traces. At this point it should be noted that there is some ambiguity when passing a `2D` array; namely are the traces arranged along the columns or the rows of the matrix? This ambiguity is resolved by the third argument of the `Scatter::to_traces` method. If that argument is set to `ArrayTraces::OverColumns` then the library assumes that every column represents an individual trace, alternatively if this is set to `ArrayTraces::OverRows` the assumption is that every row represents a trace.
+To display a `2D` array (`Array<_, Ix2>`) you can use the `Scatter::to_traces` method. The first argument of the method represents the common axis for the traces (`x` axis) whilst the second argument contains a collection of traces. At this point it should be noted that there is some ambiguity when passing a `2D` array; namely are the traces arranged along the columns or the rows of the matrix? This ambiguity is resolved by the third argument of the `Scatter::to_traces` method. If that argument is set to `ArrayTraces::OverColumns` then the library assumes that every column represents an individual trace, alternatively if this is set to `ArrayTraces::OverRows` the assumption is that every row represents a trace.
To illustrate this distinction consider the following examples:
```rust
diff --git a/docs/book/src/getting_started.md b/docs/book/src/getting_started.md
index 47dc5cc5..b3c7e5d3 100644
--- a/docs/book/src/getting_started.md
+++ b/docs/book/src/getting_started.md
@@ -1,6 +1,6 @@