cleanup usage of imageformat

Signed-off-by: Andrei Gherghescu <[email protected]>

Author: andrei-ng

plotly/src/lib.rs

@@ -11,6 +11,11 @@ compile_error!(
     r#"The "kaleido" feature is not available on "wasm" targets. Please compile without this feature for the wasm target family."#
 );
 
+#[cfg(all(feature = "kaleido", feature = "plotly_static"))]
+compile_error!(
+    r#"The "kaleido" feature and "plotly_static" are conflictings. Please select only one of them."#
+);
+
 #[cfg(feature = "plotly_ndarray")]
 pub mod ndarray;
 #[cfg(feature = "plotly_ndarray")]
@@ -26,7 +31,6 @@ pub mod common;
 pub mod configuration;
 pub mod layout;
 pub mod plot;
-pub(crate) mod static_format;
 pub mod traces;
 
 pub use common::color;
@@ -35,9 +39,7 @@ pub use layout::Layout;
 pub use plot::{Plot, Trace};
 
 #[cfg(feature = "kaleido")]
-pub use static_format::ImageFormat;
-#[cfg(not(feature = "kaleido"))]
-pub use static_format::ImageFormat;
+pub use plotly_kaleido::ImageFormat;
 
 #[cfg(feature = "plotly_static")]
 pub use plotly_static::{StaticExporterBuilder, ImageFormat};

plotly/src/plot.rs

@@ -11,13 +11,20 @@ use serde::Serialize;
 
 use crate::{Configuration, Layout};
 
+#[cfg(feature = "kaleido")]
+use plotly_kaleido::ImageFormat;
+
+#[cfg(feature = "plotly_static")]
+use plotly_static::ImageFormat;
+
 #[derive(Template)]
 #[template(path = "plot.html", escape = "none")]
 struct PlotTemplate<'a> {
     plot: &'a Plot,
     js_scripts: &'a str,
 }
 
+#[cfg(any(feature = "kaleido", feature = "plotly_static"))]
 #[derive(Template)]
 #[template(path = "static_plot.html", escape = "none")]
 #[cfg(all(not(target_family = "wasm"), not(target_os = "android")))]
@@ -45,7 +52,7 @@ struct JupyterNotebookPlotTemplate<'a> {
 
 #[cfg(all(not(target_family = "wasm"), not(target_os = "android")))]
 const DEFAULT_HTML_APP_NOT_FOUND: &str = r#"Could not find default application for HTML files.
-Consider using the `to_html` method obtain a string representation instead. If using the `kaleido` feature the
+Consider using the `to_html` method obtain a string representation instead. If using the `kaleido` or `plotly_static` feature the
 `write_image` method can be used to produce a static image in one of the following formats:
 - ImageFormat::PNG
 - ImageFormat::JPEG
@@ -65,33 +72,7 @@ plot.write_image("filename", ImageFormat::PNG, width, height, scale);
 See https://plotly.github.io/plotly.rs/content/getting_started.html for further details.
 "#;
 
-/// Image format for static image export.
-#[derive(Debug, Clone, Serialize)]
-pub enum ImageFormat {
-    PNG,
-    JPEG,
-    WEBP,
-    SVG,
-    PDF,
-    EPS,
-}
 
-impl std::fmt::Display for ImageFormat {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(
-            f,
-            "{}",
-            match self {
-                Self::PNG => "png",
-                Self::JPEG => "jpeg",
-                Self::WEBP => "webp",
-                Self::SVG => "svg",
-                Self::PDF => "pdf",
-                Self::EPS => "eps",
-            }
-        )
-    }
-}
 
 /// A struct that implements `Trace` can be serialized to json format that is
 /// understood by Plotly.js.
@@ -289,6 +270,7 @@ impl Plot {
     /// Display the fully rendered `Plot` as a static image of the given format
     /// in the default system browser.
     #[cfg(all(not(target_family = "wasm"), not(target_os = "android")))]
+    #[cfg(any(feature = "kaleido", feature = "plotly_static"))]
     pub fn show_image(&self, format: ImageFormat, width: usize, height: usize) {
         use std::env;
 
@@ -409,7 +391,7 @@ impl Plot {
             .save(
                 filename.as_ref(),
                 &serde_json::to_value(self).unwrap(),
-                &format.to_string(),
+                format,
                 width,
                 height,
                 scale,
@@ -434,7 +416,7 @@ impl Plot {
                 kaleido
                     .image_to_string(
                         &serde_json::to_value(self).unwrap(),
-                        &format.to_string(),
+                        format,
                         width,
                         height,
                         scale,
@@ -455,7 +437,7 @@ impl Plot {
         kaleido
             .image_to_string(
                 &serde_json::to_value(self).unwrap(),
-                "svg",
+                ImageFormat::SVG,
                 width,
                 height,
                 scale,
@@ -472,6 +454,7 @@ impl Plot {
     }
 
     #[cfg(all(not(target_family = "wasm"), not(target_os = "android")))]
+    #[cfg(any(feature = "kaleido", feature = "plotly_static"))]
     pub fn render_static(&self, format: &ImageFormat, width: usize, height: usize) -> String {
         let tmpl = StaticPlotTemplate {
             plot: self,
@@ -585,6 +568,12 @@ mod tests {
     use super::*;
     use crate::Scatter;
 
+    #[cfg(feature = "kaleido")]
+    use plotly_kaleido::ImageFormat;
+
+    #[cfg(feature = "plotly_static")]
+    use plotly_static::ImageFormat;
+
     fn create_test_plot() -> Plot {
         let trace1 = Scatter::new(vec![0, 1, 2], vec![6, 10, 2]).name("trace1");
         let mut plot = Plot::new();
@@ -725,14 +714,6 @@ mod tests {
         assert!(plot1 == plot2);
     }
 
-    #[test]
-    #[ignore] // Don't really want it to try and open a browser window every time we run a test.
-    #[cfg(not(target_family = "wasm"))]
-    fn show_image() {
-        let plot = create_test_plot();
-        plot.show_image(ImageFormat::PNG, 1024, 680);
-    }
-
     #[test]
     fn save_html() {
         let plot = create_test_plot();