Traces for Mesh3d, Image, ScatterMapbox (#88)

* Add basic Mesh3D trace functionality

* Add basic Image trace functionality

* Add basic ScatterMapbox functionality

* Fix compilation errors due to merge

* Copy some setters

* Fill in some more Mesh3D setters

* Complete the Mesh3D setters

* Complete the Image setters

* Sketch idea of ImageData trait

* Complete the ScatterMapbox setters

* Add tests for Mesh3D

* Fix cargo warnings

* Make greater use of IntoIterator trait

* Add tests for Image

* Add tests for ScatterMapbox

* Fix compilation errors

* Insert _ in setter names

* Run rustfmt and add line breaks to documentation

* Add jupyter lab examples for Mesh3D, Image, ScatterMapbox

* Update CHANGELOG

* Remove setter assertions

* refactoring

* fix tests

* formatting

* add ImageData trait

* add Image trace examples

* add mesh3d example

* rustfmt

* add map example

* tweak zoom data type

* rustfmt

* clippy

* update workflows

Co-authored-by: Michael Freeborn <michaelfreeborn1@gmail.com>

Author: JoelSjogren

.github/workflows/ci.yml

@@ -60,7 +60,9 @@ jobs:
           basic_charts,
           custom_controls,
           financial_charts,
+          images,
           kaleido,
+          maps,
           ndarray,
           scientific_charts,
           shapes,

.github/workflows/release_ci.yml

@@ -60,7 +60,9 @@ jobs:
           basic_charts,
           custom_controls,
           financial_charts,
+          images,
           kaleido,
+          maps,
           ndarray,
           scientific_charts,
           shapes,

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.8.2] - 2022-11-xx
 ### Added
 - [[#110](https://github.com/igiagkiozis/plotly/pull/110)] `LegendGroupTitle` to existing traces.
+- [[#88](https://github.com/igiagkiozis/plotly/pull/88)] `Mesh3D`, `Image`, `ScatterMapbox` traces.
 
 ### Changed
 - [[#113](https://github.com/igiagkiozis/plotly/pull/113)] Refactored the structure of the examples to make them more accessible, whilst adding more examples e.g. for `wasm`.

examples/3d_charts/src/main.rs

@@ -4,7 +4,7 @@ use ndarray::Array;
 use plotly::{
     common::{ColorScale, ColorScalePalette, Marker, MarkerSymbol, Mode, Title},
     layout::{Axis, Layout},
-    Plot, Scatter3D, Surface,
+    Mesh3D, Plot, Scatter3D, Surface,
 };
 
 // 3D Scatter Plots
@@ -101,12 +101,35 @@ fn surface_plot() {
     plot.show();
 }
 
+fn mesh_3d_plot() {
+    let trace = Mesh3D::new(
+        vec![0, 1, 2, 0],
+        vec![0, 0, 1, 2],
+        vec![0, 2, 0, 1],
+        vec![0, 0, 0, 1],
+        vec![1, 2, 3, 2],
+        vec![2, 3, 1, 3],
+    )
+    .intensity(vec![0.0, 0.33, 0.66, 1.0])
+    .color_scale(ColorScale::Palette(ColorScalePalette::Rainbow));
+
+    let mut plot = Plot::new();
+    plot.add_trace(trace);
+
+    plot.show();
+}
+
 fn main() {
     // Uncomment any of these lines to display the example.
 
     // Scatter3D Plots
-    simple_scatter3d_plot();
-    simple_line3d_plot();
-    customized_scatter3d_plot();
-    surface_plot();
+    // simple_scatter3d_plot();
+    // simple_line3d_plot();
+    // customized_scatter3d_plot();
+
+    // Surface Plots
+    // surface_plot();
+
+    // Mesh Plots
+    // mesh_3d_plot();
 }

examples/custom_controls/src/main.rs

@@ -10,7 +10,8 @@ use plotly::{
     Bar, HeatMap, Layout, Plot,
 };
 
-/// Display a bar chart with an associated dropdown selector to show different data.
+/// Display a bar chart with an associated dropdown selector to show different
+/// data.
 fn bar_plot_with_dropdown_for_different_data() {
     type BarType = Bar<&'static str, i32>;
     let mut plot = Plot::new();
@@ -40,7 +41,8 @@ fn bar_plot_with_dropdown_for_different_data() {
     plot.show();
 }
 
-/// Display a heat map, with buttons to allow for toggling of different colorscales.
+/// Display a heat map, with buttons to allow for toggling of different
+/// colorscales.
 fn heat_map_with_modifiable_colorscale() {
     type HeatMapType = HeatMap<f64, f64, Vec<f64>>;
     let gauss = |v: i32| (-v as f64 * v as f64 / 200.0).exp();
@@ -72,7 +74,8 @@ fn heat_map_with_modifiable_colorscale() {
     plot.show();
 }
 
-/// Display a bar chart, with buttons to toggle between stacked or grouped display maodes.
+/// Display a bar chart, with buttons to toggle between stacked or grouped
+/// display maodes.
 fn bar_chart_with_modifiable_bar_mode() {
     type BarType = Bar<&'static str, i32>;
     let mut plot = Plot::new();

examples/images/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "images"
+version = "0.1.0"
+authors = ["Michael Freeborn <michaelfreeborn1@gmail.com>"]
+edition = "2021"
+
+[dependencies]
+image = "0.24.4"
+ndarray = "0.15.6"
+plotly = { path = "../../plotly", features = ["plotly_image", "plotly_ndarray"] }

examples/images/README.md

@@ -0,0 +1,6 @@
+# Images
+
+## How to Run
+
+1. Configure which example(s) you want to run by commenting/uncommenting lines in the `main` function, located in `src/main.rs`.
+2. Run `cargo run`.

examples/images/assets/mario.png

@@ -0,0 +1,98 @@
+#![allow(dead_code)]
+
+use ndarray::arr2;
+use plotly::{color::Rgb, image::ColorModel, Image, Plot};
+
+fn basic_image() {
+    let w = Rgb::new(255, 255, 255);
+    let b = Rgb::new(0, 0, 0);
+    let r = Rgb::new(240, 8, 5);
+    let db = Rgb::new(145, 67, 7);
+    let lb = Rgb::new(251, 200, 129);
+    let s = Rgb::new(153, 75, 10);
+    let bl = Rgb::new(3, 111, 191);
+    let y = Rgb::new(251, 250, 15);
+
+    let pixels = vec![
+        vec![w, w, w, w, r, r, r, r, r, w, w, w, w, w, w],
+        vec![w, w, w, r, r, r, r, r, r, r, r, r, w, w, w],
+        vec![w, w, w, db, db, db, lb, lb, b, lb, w, w, w, w, w],
+        vec![w, w, db, lb, db, lb, lb, lb, b, lb, lb, lb, w, w, w],
+        vec![w, w, db, lb, db, db, lb, lb, lb, db, lb, lb, lb, w, w],
+        vec![w, w, db, db, lb, lb, lb, lb, db, db, db, db, w, w, w],
+        vec![w, w, w, w, lb, lb, lb, lb, lb, lb, lb, w, w, w, w],
+        vec![w, w, w, r, r, bl, r, r, r, w, w, w, w, w, w],
+        vec![w, w, r, r, r, bl, r, r, bl, r, r, r, w, w, w],
+        vec![w, r, r, r, r, bl, bl, bl, bl, r, r, r, r, w, w],
+        vec![w, lb, lb, r, bl, y, bl, bl, y, bl, r, lb, lb, w, w],
+        vec![w, lb, lb, lb, bl, bl, bl, bl, bl, bl, lb, lb, lb, w, w],
+        vec![w, lb, lb, bl, bl, bl, bl, bl, bl, bl, bl, lb, lb, w, w],
+        vec![w, w, w, bl, bl, bl, w, w, bl, bl, bl, w, w, w, w],
+        vec![w, w, s, s, s, w, w, w, w, s, s, s, w, w, w],
+        vec![w, s, s, s, s, w, w, w, w, w, s, s, s, s, w],
+    ];
+    let trace = Image::new(pixels).color_model(ColorModel::RGB);
+
+    let mut plot = Plot::new();
+    plot.add_trace(trace);
+
+    plot.show()
+}
+
+fn trace_from_image_crate_rgb() {
+    let im = image::open("assets/mario.png").unwrap().into_rgb8();
+    let trace = Image::new(im).color_model(ColorModel::RGB);
+
+    let mut plot = Plot::new();
+    plot.add_trace(trace);
+
+    plot.show()
+}
+
+fn trace_from_image_crate_rgba() {
+    let im = image::open("assets/mario.png").unwrap().into_rgba8();
+    let trace = Image::new(im).color_model(ColorModel::RGBA);
+
+    let mut plot = Plot::new();
+    plot.add_trace(trace);
+
+    plot.show()
+}
+
+fn trace_from_ndarray_rgb() {
+    let pixels = arr2(&[
+        [(255, 255, 255), (0, 0, 0)],
+        [(0, 0, 0), (255, 255, 255)],
+        [(255, 255, 255), (0, 0, 0)],
+    ]);
+    let trace = Image::new(pixels).color_model(ColorModel::RGB);
+
+    let mut plot = Plot::new();
+    plot.add_trace(trace);
+
+    plot.show()
+}
+
+fn trace_from_ndarray_rgba() {
+    let pixels = arr2(&[
+        [(255, 255, 255, 1.), (0, 0, 0, 0.25)],
+        [(0, 0, 0, 0.5), (255, 255, 255, 1.)],
+        [(255, 255, 255, 1.), (0, 0, 0, 0.75)],
+    ]);
+    let trace = Image::new(pixels).color_model(ColorModel::RGBA);
+
+    let mut plot = Plot::new();
+    plot.add_trace(trace);
+
+    plot.show()
+}
+
+fn main() {
+    // Uncomment any of these lines to display the example.
+
+    // basic_image();
+    // trace_from_image_crate_rgb();
+    // trace_from_image_crate_rgba();
+    // trace_from_ndarray_rgb();
+    // trace_from_ndarray_rgba();
+}

examples/images/src/main.rs

@@ -5,13 +5,15 @@ fn main() {
     let trace = Scatter::new(vec![0, 1, 2], vec![2, 1, 0]);
     plot.add_trace(trace);
 
-    // Adjust these arguments to set the image format, width and height of the output image.
+    // Adjust these arguments to set the image format, width and height of the
+    // output image.
     let filename = "out";
     let image_format = ImageFormat::PNG;
     let width = 800;
     let height = 600;
     let scale = 1.0;
 
-    // The image will be saved to format!("{filename}.{image_format}") relative to the current working directory.
+    // The image will be saved to format!("{filename}.{image_format}") relative to
+    // the current working directory.
     plot.write_image(filename, image_format, width, height, scale);
 }