plotlyjs v2.13: Add flaglist options including "left", "right", "top"…

…, "bottom", "width" and "height" to control the direction of automargin on cartesian axes (plotly/plotly.js#6193)
plotly · Feb 6, 2023 · 5c7cadd · 5c7cadd
1 parent bda17d2
commit 5c7cadd
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 6 deletions.
diff --git a/src/Plotly.NET/CommonAbstractions/StyleParams.fs b/src/Plotly.NET/CommonAbstractions/StyleParams.fs
@@ -31,6 +31,32 @@ module StyleParam =
         override this.ToString() = this |> ArrowSide.toString
         member this.Convert() = this |> ArrowSide.convert
 
+    [<RequireQualifiedAccess>]
+    type TickAutoMargin =
+        | Height 
+        | Width  
+        | Left   
+        | Right  
+        | Top    
+        | Bottom 
+        | All
+        | Custom of seq<TickAutoMargin>
+
+        static member toString =
+            function
+            | Height -> "height"
+            | Width  -> "width"
+            | Left   -> "left"
+            | Right  -> "right"
+            | Top    -> "top"
+            | Bottom -> "bottom"
+            | All    -> "height+width+left+right+top+bottom"
+            | Custom s -> s |> Seq.map (fun a -> a |> TickAutoMargin.toString) |> String.concat "+"
+
+        static member convert = TickAutoMargin.toString >> box
+        override this.ToString() = this |> TickAutoMargin.toString
+        member this.Convert() = this |> TickAutoMargin.convert
+
     [<RequireQualifiedAccess>]
     type AnnotationAlignment =
         | Left

diff --git a/src/Plotly.NET/Layout/ObjectAbstractions/Common/LinearAxis.fs b/src/Plotly.NET/Layout/ObjectAbstractions/Common/LinearAxis.fs
@@ -126,7 +126,7 @@ type LinearAxis() =
             [<Optional; DefaultParameterValue(null)>] ?TickWidth: int,
             [<Optional; DefaultParameterValue(null)>] ?TickColor: Color,
             [<Optional; DefaultParameterValue(null)>] ?ShowTickLabels: bool,
-            [<Optional; DefaultParameterValue(null)>] ?AutoMargin: bool,
+            [<Optional; DefaultParameterValue(null)>] ?AutoMargin: StyleParam.TickAutoMargin,
             [<Optional; DefaultParameterValue(null)>] ?ShowSpikes: bool,
             [<Optional; DefaultParameterValue(null)>] ?SpikeColor: Color,
             [<Optional; DefaultParameterValue(null)>] ?SpikeThickness: int,
@@ -371,7 +371,7 @@ type LinearAxis() =
             [<Optional; DefaultParameterValue(null)>] ?TickWidth: int,
             [<Optional; DefaultParameterValue(null)>] ?TickColor: Color,
             [<Optional; DefaultParameterValue(null)>] ?ShowTickLabels: bool,
-            [<Optional; DefaultParameterValue(null)>] ?AutoMargin: bool,
+            [<Optional; DefaultParameterValue(null)>] ?AutoMargin: StyleParam.TickAutoMargin,
             [<Optional; DefaultParameterValue(null)>] ?ShowSpikes: bool,
             [<Optional; DefaultParameterValue(null)>] ?SpikeColor: Color,
             [<Optional; DefaultParameterValue(null)>] ?SpikeThickness: int,
@@ -889,7 +889,7 @@ type LinearAxis() =
             [<Optional; DefaultParameterValue(null)>] ?TickWidth: int,
             [<Optional; DefaultParameterValue(null)>] ?TickColor: Color,
             [<Optional; DefaultParameterValue(null)>] ?ShowTickLabels: bool,
-            [<Optional; DefaultParameterValue(null)>] ?AutoMargin: bool,
+            [<Optional; DefaultParameterValue(null)>] ?AutoMargin: StyleParam.TickAutoMargin,
             [<Optional; DefaultParameterValue(null)>] ?ShowSpikes: bool,
             [<Optional; DefaultParameterValue(null)>] ?SpikeColor: Color,
             [<Optional; DefaultParameterValue(null)>] ?SpikeThickness: int,
@@ -989,7 +989,7 @@ type LinearAxis() =
             TickWidth |> DynObj.setValueOpt axis "tickwidth"
             TickColor |> DynObj.setValueOpt axis "tickcolor"
             ShowTickLabels |> DynObj.setValueOpt axis "showticklabels"
-            AutoMargin |> DynObj.setValueOpt axis "automargin"
+            AutoMargin |> DynObj.setValueOptBy axis "automargin" StyleParam.TickAutoMargin.convert
             ShowSpikes |> DynObj.setValueOpt axis "showspikes"
             SpikeColor |> DynObj.setValueOpt axis "spikecolor"
             SpikeThickness |> DynObj.setValueOpt axis "spikethickness"

diff --git a/src/Plotly.NET/Templates/ChartTemplates.fs b/src/Plotly.NET/Templates/ChartTemplates.fs
@@ -322,7 +322,7 @@ module ChartTemplates =
             |> Layout.updateLinearAxisById (
                 StyleParam.SubPlotId.XAxis 1,
                 LinearAxis.init (
-                    AutoMargin = true,
+                    AutoMargin = StyleParam.TickAutoMargin.All,
                     GridColor = Color.fromKeyword White,
                     LineColor = Color.fromKeyword White,
                     Ticks = StyleParam.TickOptions.Empty,
@@ -334,7 +334,7 @@ module ChartTemplates =
             |> Layout.updateLinearAxisById (
                 StyleParam.SubPlotId.YAxis 1,
                 LinearAxis.init (
-                    AutoMargin = true,
+                    AutoMargin = StyleParam.TickAutoMargin.All,
                     GridColor = Color.fromKeyword White,
                     LineColor = Color.fromKeyword White,
                     Ticks = StyleParam.TickOptions.Empty,