add scatter_geo example in examples/maps

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

Author: andrei-ng

examples/maps/src/main.rs

@@ -1,9 +1,10 @@
 #![allow(dead_code)]
 
 use plotly::{
+    color::Rgb,
     common::Marker,
-    layout::{Center, DragMode, Mapbox, MapboxStyle, Margin},
-    DensityMapbox, Layout, Plot, ScatterMapbox,
+    layout::{Axis, Center, DragMode, LayoutGeo, Mapbox, MapboxStyle, Margin, Projection},
+    DensityMapbox, Layout, Plot, ScatterGeo, ScatterMapbox,
 };
 
 fn scatter_mapbox(show: bool, file_name: &str) {
@@ -30,6 +31,48 @@ fn scatter_mapbox(show: bool, file_name: &str) {
     }
 }
 
+fn scatter_geo(show: bool, file_name: &str) {
+    // Reproduce the Earth from https://plotly.com/javascript/lines-on-maps/#lines-on-an-orthographic-map
+    let trace =
+        ScatterGeo::new(vec![45.5017], vec![-73.5673]).marker(Marker::new().size(25).opacity(0.9));
+
+    let layout = Layout::new()
+        .drag_mode(DragMode::Zoom)
+        .margin(Margin::new().top(0).left(0).bottom(0).right(0))
+        .geo(
+            LayoutGeo::new()
+                .showocean(true)
+                .showlakes(true)
+                .showcountries(true)
+                .showland(true)
+                .oceancolor(Rgb::new(0, 255, 255))
+                .lakecolor(Rgb::new(0, 255, 255))
+                .landcolor(Rgb::new(230, 145, 56))
+                .lataxis(
+                    Axis::new()
+                        .show_grid(true)
+                        .grid_color(Rgb::new(102, 102, 102)),
+                )
+                .lonaxis(
+                    Axis::new()
+                        .show_grid(true)
+                        .grid_color(Rgb::new(102, 102, 102)),
+                )
+                .projection(
+                    Projection::new().projection_type(plotly::layout::ProjectionType::Orthographic),
+                ),
+        );
+
+    let mut plot = Plot::new();
+    plot.add_trace(trace);
+    plot.set_layout(layout);
+
+    let path = write_example_to_html(&plot, file_name);
+    if show {
+        plot.show_html(path);
+    }
+}
+
 fn density_mapbox(show: bool, file_name: &str) {
     let trace = DensityMapbox::new(vec![45.5017], vec![-73.5673], vec![0.75]).zauto(true);
 
@@ -63,5 +106,6 @@ fn write_example_to_html(plot: &Plot, name: &str) -> String {
 fn main() {
     // Change false to true on any of these lines to display the example.
     scatter_mapbox(false, "scatter_mapbox");
+    scatter_geo(false, "scatter_geo");
     density_mapbox(false, "density_mapbox");
 }

plotly/src/layout/geo.rs

@@ -0,0 +1,44 @@
+use plotly_derive::FieldSetter;
+use serde::Serialize;
+
+use crate::color::Color;
+use crate::layout::{Axis, Center, Projection};
+
+#[derive(Serialize, Clone, Debug, FieldSetter)]
+
+pub struct LayoutGeo {
+    /// Sets the latitude and longitude of the center of the map.
+    center: Option<Center>,
+    /// Sets the domain within which the mapbox will be drawn.
+    /// Sets the zoom level of the map.
+    zoom: Option<u8>,
+    /// Sets the projection of the map
+    #[field_setter(default = "Projection::new().projection_type(ProjectionType::Orthographic)")]
+    projection: Option<Projection>,
+    /// If to show the ocean or not
+    #[field_setter(default = "Some(true)")]
+    showocean: Option<bool>,
+    /// Sets the color of the ocean
+    #[field_setter(default = "'rgb(0, 255, 255)'")]
+    oceancolor: Option<Box<dyn Color>>,
+    /// If to show the land or not
+    showland: Option<bool>,
+    /// Sets the color of the land
+    landcolor: Option<Box<dyn Color>>,
+    /// If to show lakes or not
+    showlakes: Option<bool>,
+    /// Sets the color of the lakes
+    lakecolor: Option<Box<dyn Color>>,
+    /// If to show countries (borders) or not
+    showcountries: Option<bool>,
+    /// Configures the longitude axis
+    lonaxis: Option<Axis>,
+    /// Configures the latitude axis
+    lataxis: Option<Axis>,
+}
+
+impl LayoutGeo {
+    pub fn new() -> Self {
+        Default::default()
+    }
+}

plotly/src/layout/mod.rs

@@ -13,6 +13,7 @@ pub mod update_menu;
 
 mod annotation;
 mod axis;
+mod geo;
 mod grid;
 mod legend;
 mod mapbox;
@@ -27,6 +28,7 @@ pub use self::axis::{
     RangeMode, RangeSelector, RangeSlider, RangeSliderYAxis, SelectorButton, SelectorStep,
     SliderRangeMode, StepMode, TicksDirection, TicksPosition,
 };
+pub use self::geo::LayoutGeo;
 pub use self::grid::{GridDomain, GridPattern, GridXSide, GridYSide, LayoutGrid, RowOrder};
 pub use self::legend::{Legend, TraceOrder};
 pub use self::mapbox::{Center, Mapbox, MapboxStyle};
@@ -137,41 +139,6 @@ pub enum SelectDirection {
     Any,
 }
 
-#[derive(Serialize, Clone, Debug, FieldSetter)]
-pub struct Geo {
-    /// Sets the zoom level of the map.
-    zoom: Option<u8>,
-    /// Sets the projection of the map
-    #[field_setter(default = "Projection::new().projection_type(ProjectionType::Orthographic)")]
-    projection: Option<Projection>,
-    /// If to show the ocean or not
-    #[field_setter(default = "Some(true)")]
-    showocean: Option<bool>,
-    /// Sets the color of the ocean
-    #[field_setter(default = "'rgb(0, 255, 255)'")]
-    oceancolor: Option<Box<dyn Color>>,
-    /// If to show the land or not
-    showland: Option<bool>,
-    /// Sets the color of the land
-    landcolor: Option<Box<dyn Color>>,
-    /// If to show lakes or not
-    showlakes: Option<bool>,
-    /// Sets the color of the lakes
-    lakecolor: Option<Box<dyn Color>>,
-    /// If to show countries (borders) or not
-    showcountries: Option<bool>,
-    /// Configures the longitude axis
-    lonaxis: Option<Axis>,
-    /// Configures the latitude axis
-    lataxis: Option<Axis>,
-}
-
-impl Geo {
-    pub fn new() -> Self {
-        Default::default()
-    }
-}
-
 #[serde_with::skip_serializing_none]
 #[derive(Serialize, Debug, Clone, FieldSetter)]
 pub struct Template {
@@ -309,7 +276,10 @@ pub struct LayoutFields {
     y_axis8: Option<Box<Axis>>,
     #[serde(rename = "zaxis8")]
     z_axis8: Option<Box<Axis>>,
+    // ternary: Option<LayoutTernary>,
     scene: Option<LayoutScene>,
+    geo: Option<LayoutGeo>,
+    // polar: Option<LayoutPolar>,
     annotations: Option<Vec<Annotation>>,
     shapes: Option<Vec<Shape>>,
     #[serde(rename = "newshape")]