Merge pull request #14 from alceal:feature/color

feat: Add `color` argument
alceal · Sep 13, 2024 · f8d3b49 · f8d3b49
2 parents dfcea11 + 7f416c5
commit f8d3b49
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 39 deletions.
diff --git a/src/aesthetics/mark.rs b/src/aesthetics/mark.rs
@@ -15,16 +15,36 @@ pub(crate) trait Mark {
         marker!(opacity, size)
     }
 
-    fn set_color(marker: &Marker, colors: &Option<Vec<Rgb>>, index: usize) -> Marker {
+    fn set_color(
+        marker: &Marker,
+        color: &Option<Rgb>,
+        colors: &Option<Vec<Rgb>>,
+        index: usize,
+    ) -> Marker {
         let mut updated_marker = marker.clone();
 
-        if let Some(colors) = colors {
-            if let Some(rgb) = colors.get(index) {
+        match color {
+            Some(rgb) => {
                 let group_color = plotly::color::Rgb::new(rgb.0, rgb.1, rgb.2);
                 updated_marker = updated_marker.color(group_color);
             }
+            None => {
+                if let Some(colors) = colors {
+                    if let Some(rgb) = colors.get(index) {
+                        let group_color = plotly::color::Rgb::new(rgb.0, rgb.1, rgb.2);
+                        updated_marker = updated_marker.color(group_color);
+                    }
+                }
+            }
         }
 
+        // if let Some(colors) = colors {
+        //     if let Some(rgb) = colors.get(index) {
+        //         let group_color = plotly::color::Rgb::new(rgb.0, rgb.1, rgb.2);
+        //         updated_marker = updated_marker.color(group_color);
+        //     }
+        // }
+
         updated_marker
     }
 }
diff --git a/src/axis/mod.rs b/src/axis/mod.rs
@@ -7,7 +7,7 @@ use crate::Rgb;
 
 /// A structure representing an axis with customizable properties such as position, type, color, ticks, and grid lines.
 ///
-/// Examples:
+/// **Examples**
 ///
 /// ```
 /// let axis_format = Axis::new()

diff --git a/src/legend/mod.rs b/src/legend/mod.rs
@@ -2,7 +2,7 @@ use crate::{Orientation, Rgb};
 
 /// A structure representing a customizable plot legend with properties such as background color, border, font, orientation, and position.
 ///
-/// Examples:
+/// **Example**
 ///
 /// ```
 /// let legend_format = Legend::new()

diff --git a/src/traces/barplot.rs b/src/traces/barplot.rs
@@ -41,6 +41,7 @@ impl BarPlot {
     /// * `orientation` - An optional `Orientation` enum specifying whether the plot should be horizontal or vertical.
     /// * `group` - An optional string specifying the column name to be used for grouping data points.
     /// * `error` - An optional string specifying the column name containing error values for the y-axis data.
+    /// * `color` - An optional `Rgb` value specifying the color of the markers to be used for the plot.
     /// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
     /// * `plot_title` - An optional `Text` struct specifying the title of the plot.
     /// * `x_title` - An optional `Text` struct specifying the title of the x-axis.
@@ -53,7 +54,7 @@ impl BarPlot {
     ///
     /// Returns an instance of `BarPlot`.
     ///
-    /// # Example
+    /// **Examples**
     ///
     /// ```
     /// BarPlot::builder()
@@ -63,9 +64,7 @@ impl BarPlot {
     ///     .orientation(Orientation::Vertical)
     ///     .group("gender")
     ///     .error("errors")
-    ///     .colors(vec![
-    ///         Rgb(255, 0, 0),
-    ///     ])
+    ///     .color(Rgb(255, 0, 0))
     ///     .plot_title(
     ///         Text::from("Vertical Bar Plot")
     ///             .font("Arial")
@@ -135,6 +134,7 @@ impl BarPlot {
         group: Option<String>,
         error: Option<String>,
         // Marker
+        color: Option<Rgb>,
         colors: Option<Vec<Rgb>>,
         // Layout
         plot_title: Option<Text>,
@@ -185,6 +185,7 @@ impl BarPlot {
             additional_series,
             opacity,
             size,
+            color,
             colors,
             line_types,
         );
@@ -318,6 +319,7 @@ impl VerticalBarPlot {
     /// * `y` - A string specifying the column name to be used for the y-axis.
     /// * `group` - An optional string specifying the column name to be used for grouping data points.
     /// * `error` - An optional string specifying the column name containing error values for the y-axis data.
+    /// * `color` - An optional `Rgb` value specifying the color of the markers to be used for the plot.
     /// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
     /// * `plot_title` - An optional `Text` struct specifying the title of the plot.
     /// * `x_title` - An optional `Text` struct specifying the title of the x-axis.
@@ -330,7 +332,7 @@ impl VerticalBarPlot {
     ///
     /// Returns an instance of `VerticalBarPlot`.
     ///
-    /// # Example
+    /// **Example**
     ///
     /// ```
     /// VerticalBarPlot::builder()
@@ -339,9 +341,7 @@ impl VerticalBarPlot {
     ///     .y("values")
     ///     .group("gender")
     ///     .error("errors")
-    ///     .colors(vec![
-    ///         Rgb(255, 0, 0),
-    ///     ])
+    ///     .color(Rgb(255, 0, 0))
     ///     .plot_title(
     ///         Text::from("Vertical Bar Plot")
     ///             .font("Arial")
@@ -375,6 +375,7 @@ impl VerticalBarPlot {
         group: Option<String>,
         error: Option<String>,
         // Marker
+        color: Option<Rgb>,
         colors: Option<Vec<Rgb>>,
         // Layout
         plot_title: Option<Text>,
@@ -426,6 +427,7 @@ impl VerticalBarPlot {
             additional_series,
             opacity,
             size,
+            color,
             colors,
             line_types,
         );
@@ -508,6 +510,7 @@ impl HorizontalBarPlot {
     /// * `y` - A string specifying the column name to be used for the y-axis.
     /// * `group` - An optional string specifying the column name to be used for grouping data points.
     /// * `error` - An optional string specifying the column name containing error values for the x-axis data.
+    /// * `color` - An optional `Rgb` value specifying the color of the markers to be used for the plot.
     /// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
     /// * `plot_title` - An optional `Text` struct specifying the title of the plot.
     /// * `x_title` - An optional `Text` struct specifying the title of the x-axis.
@@ -520,7 +523,7 @@ impl HorizontalBarPlot {
     ///
     /// Returns an instance of `HorizontalBarPlot`.
     ///
-    /// # Example
+    /// **Example**
     ///
     /// ```
     /// HorizontalBarPlot::builder()
@@ -529,9 +532,7 @@ impl HorizontalBarPlot {
     ///     .y("animals")
     ///     .group("gender")
     ///     .error("errors")
-    ///     .colors(vec![
-    ///         Rgb(255, 0, 0),
-    ///     ])
+    ///     .color(Rgb(255, 0, 0))
     ///     .plot_title(
     ///         Text::from("Horizontal Bar Plot")
     ///             .font("Arial")
@@ -557,7 +558,6 @@ impl HorizontalBarPlot {
     /// ```
     ///
     /// ![Horizontal Bar Plot](https://imgur.com/saoTcNg.png)
-    ///
     #[builder(on(String, into), on(Text, into))]
     pub fn new(
         data: &DataFrame,
@@ -566,6 +566,7 @@ impl HorizontalBarPlot {
         group: Option<String>,
         error: Option<String>,
         // Marker
+        color: Option<Rgb>,
         colors: Option<Vec<Rgb>>,
         // Layout
         plot_title: Option<Text>,
@@ -617,6 +618,7 @@ impl HorizontalBarPlot {
             additional_series,
             opacity,
             size,
+            color,
             colors,
             line_type,
         );

diff --git a/src/traces/boxplot.rs b/src/traces/boxplot.rs
@@ -44,6 +44,7 @@ impl BoxPlot {
     /// * `point_offset` - An optional f64 value specifying the horizontal offset for individual data points when `box_points` is enabled.
     /// * `jitter` - An optional f64 value indicating the amount of jitter (random noise) to apply to individual data points for visibility.
     /// * `opacity` - An optional f64 value specifying the opacity of the plot markers (range: 0.0 to 1.0).
+    /// * `color` - An optional `Rgb` value specifying the color of the markers to be used for the plot.
     /// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
     /// * `plot_title` - An optional `Text` struct specifying the title of the plot.
     /// * `x_title` - An optional `Text` struct specifying the title of the x-axis.
@@ -56,7 +57,7 @@ impl BoxPlot {
     ///
     /// Returns an instance of `BoxPlot`.
     ///
-    /// # Example
+    /// **Examples**
     ///
     /// ```
     /// BoxPlot::builder()
@@ -153,6 +154,7 @@ impl BoxPlot {
         jitter: Option<f64>,
         // Marker
         opacity: Option<f64>,
+        color: Option<Rgb>,
         colors: Option<Vec<Rgb>>,
         // Layout
         plot_title: Option<Text>,
@@ -200,6 +202,7 @@ impl BoxPlot {
             additional_series,
             opacity,
             size,
+            color,
             colors,
             line_types,
         );
@@ -358,6 +361,7 @@ impl VerticalBoxPlot {
     /// * `point_offset` - An optional f64 value specifying the horizontal offset for individual data points when `box_points` is enabled.
     /// * `jitter` - An optional f64 value indicating the amount of jitter (random noise) to apply to individual data points for visibility.
     /// * `opacity` - An optional f64 value specifying the opacity of the plot markers (range: 0.0 to 1.0).
+    /// * `color` - An optional `Rgb` value specifying the color of the markers to be used for the plot.
     /// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
     /// * `plot_title` - An optional `Text` struct specifying the title of the plot.
     /// * `x_title` - An optional `Text` struct specifying the title of the x-axis.
@@ -370,7 +374,7 @@ impl VerticalBoxPlot {
     ///
     /// Returns an instance of `VerticalBoxPlot`.
     ///
-    /// # Example
+    /// **Example**
     ///
     /// ```
     /// VerticalBoxPlot::builder()
@@ -412,7 +416,6 @@ impl VerticalBoxPlot {
     /// ```
     ///
     /// ![Vertical Box Plot](https://imgur.com/0Zn0mFu.png)
-    ///
     #[builder(on(String, into), on(Text, into))]
     pub fn new(
         data: &DataFrame,
@@ -424,6 +427,7 @@ impl VerticalBoxPlot {
         jitter: Option<f64>,
         // Marker
         opacity: Option<f64>,
+        color: Option<Rgb>,
         colors: Option<Vec<Rgb>>,
         // Layout
         plot_title: Option<Text>,
@@ -472,6 +476,7 @@ impl VerticalBoxPlot {
             additional_series,
             opacity,
             size,
+            color,
             colors,
             line_types,
         );
@@ -564,6 +569,7 @@ impl HorizontalBoxPlot {
     /// * `point_offset` - An optional f64 value specifying the horizontal offset for individual data points when `box_points` is enabled.
     /// * `jitter` - An optional f64 value indicating the amount of jitter (random noise) to apply to individual data points for visibility.
     /// * `opacity` - An optional f64 value specifying the opacity of the plot markers (range: 0.0 to 1.0).
+    /// * `color` - An optional `Rgb` value specifying the color of the markers to be used for the plot.
     /// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
     /// * `plot_title` - An optional `Text` struct specifying the title of the plot.
     /// * `x_title` - An optional `Text` struct specifying the title of the x-axis.
@@ -576,7 +582,7 @@ impl HorizontalBoxPlot {
     ///
     /// Returns an instance of `HorizontalBoxPlot`.
     ///
-    /// # Example
+    /// **Example**
     ///
     /// ```
     /// HorizontalBoxPlot::builder()
@@ -618,7 +624,6 @@ impl HorizontalBoxPlot {
     /// ```
     ///
     /// ![Horizontal Box Plot](https://imgur.com/Lu92liU.png)
-    ///
     #[builder(on(String, into), on(Text, into))]
     pub fn new(
         data: &DataFrame,
@@ -630,6 +635,7 @@ impl HorizontalBoxPlot {
         jitter: Option<f64>,
         // Marker
         opacity: Option<f64>,
+        color: Option<Rgb>,
         colors: Option<Vec<Rgb>>,
         // Layout
         plot_title: Option<Text>,
@@ -678,6 +684,7 @@ impl HorizontalBoxPlot {
             additional_series,
             opacity,
             size,
+            color,
             colors,
             line_type,
         );

diff --git a/src/traces/histogram.rs b/src/traces/histogram.rs
@@ -33,6 +33,7 @@ impl Histogram {
     /// * `x` - A string specifying the column name to be used for the x-axis.
     /// * `group` - An optional string specifying the column name to be used for grouping data points.
     /// * `opacity` - An optional f64 value specifying the opacity of the plot markers (range: 0.0 to 1.0).
+    /// * `color` - An optional `Rgb` value specifying the color of the markers to be used for the plot.
     /// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
     /// * `plot_title` - An optional `Text` struct specifying the title of the plot.
     /// * `x_title` - An optional `Text` struct specifying the title of the x-axis.
@@ -45,7 +46,7 @@ impl Histogram {
     ///
     /// Returns an instance of `Histogram`.
     ///
-    /// # Example
+    /// **Example**
     ///
     /// ```
     /// Histogram::builder()
@@ -83,14 +84,14 @@ impl Histogram {
     /// ```
     ///
     /// ![Histogram](https://imgur.com/ZNomy9V.png)
-    ///
     #[builder(on(String, into), on(Text, into))]
     pub fn new(
         data: &DataFrame,
         x: String,
         group: Option<String>,
         // Marker
         opacity: Option<f64>,
+        color: Option<Rgb>,
         colors: Option<Vec<Rgb>>,
         // Layout
         plot_title: Option<Text>,
@@ -142,6 +143,7 @@ impl Histogram {
             additional_series,
             opacity,
             size,
+            color,
             colors,
             line_types,
         );