Add functions to get and update polar/polar axis on chart layout

Author: kMutagene

src/Plotly.NET/ChartExtensions.fs

@@ -1144,4 +1144,59 @@ module ChartExtensions =
             let file = sprintf "%s.html" guid
             let path = Path.Combine(tempPath, file)
             File.WriteAllText(path, html)
-            path |> openOsSpecificFile
+            path |> openOsSpecificFile
+
+        /// Sets the polar object with the given id on the chart layout
+        [<CompiledName("WithPolar")>]
+        static member withPolar(polar:Polar, [<Optional;DefaultParameterValue(null)>] ?Id) =
+            (fun (ch:GenericChart) ->
+                let layout =
+                    let id = defaultArg Id 1
+                    GenericChart.getLayout ch 
+                    |> Layout.updatePolarById(id,polar)
+                GenericChart.setLayout layout ch
+            )
+
+        
+        /// Sets the angular axis of the polar object with the given id on the chart layout
+        [<CompiledName("WithAngularAxis")>]
+        static member withAngularAxis(angularAxis:Axis.AngularAxis, [<Optional;DefaultParameterValue(null)>] ?Id) =
+            (fun (ch:GenericChart) ->
+                
+                let id = defaultArg Id 1
+                let layout = GenericChart.getLayout ch 
+
+                let updatedPolar = 
+                    layout
+                    |> Layout.tryGetPolarById(id)
+                    |> Option.defaultValue (Polar.init())
+                    |> Polar.style(AngularAxis = angularAxis)
+
+                let updatedLayout =
+                    layout
+                    |> Layout.updatePolarById(id,updatedPolar)
+
+                GenericChart.setLayout updatedLayout ch
+            )
+            
+        /// Sets the radial axis of the polar object with the given id on the chart layout
+        [<CompiledName("WithRadialAxis")>]
+        static member withRadialAxis(radialAxis:Axis.RadialAxis, [<Optional;DefaultParameterValue(null)>] ?Id) =
+            (fun (ch:GenericChart) ->
+                let id = defaultArg Id 1
+                let layout = GenericChart.getLayout ch 
+
+                let updatedPolar = 
+                    layout
+                    |> Layout.tryGetPolarById(id)
+                    |> Option.defaultValue (Polar.init())
+                    |> Polar.style(RadialAxis = radialAxis)
+
+                let updatedLayout =
+                    layout
+                    |> Layout.updatePolarById(id,updatedPolar)
+
+                GenericChart.setLayout updatedLayout ch
+            )
+
+

src/Plotly.NET/Layout.fs

@@ -336,6 +336,34 @@ type Layout() =
                 layout
             )
 
+    static member tryGetPolarById (id:int) =
+        (fun (layout:Layout) -> 
+            let key = if id < 2 then "polar" else sprintf "polar%i" id
+            layout.TryGetTypedValue<Polar>(key)
+        )
+
+    /// Updates the style of current polar object with given Id. 
+    /// If there does not exist a polar object with the given id, sets it with the given polar object
+    static member updatePolarById
+        (   
+           id       : int,
+           polar    : Polar
+        ) =
+            (fun (layout:Layout) -> 
+
+                let key = if id < 2 then "polar" else sprintf "polar%i" id
+
+                let polar' = 
+                    match layout |> Layout.tryGetPolarById(id) with
+                    | Some a  -> DynObj.combine (unbox a) polar
+                    | None    -> polar :> DynamicObj
+                
+                polar' |> DynObj.setValue layout key
+
+                layout
+            )
+
+
     static member setLegend(legend:Legend) =
         (fun (layout:Layout) -> 
             legend |> DynObj.setValue layout "legend"

src/Plotly.NET/Polar.fs

@@ -63,12 +63,12 @@ type Polar () =
             (fun (polar:Polar) -> 
 
                 Domain      |> DynObj.setValueOpt polar "domain"
-                Sector      |> DynObj.setValueOpt polar "sector"
+                Sector      |> DynObj.setValueOptBy polar "sector" (fun (a,b) -> [|a;b|])
                 Hole        |> DynObj.setValueOpt polar "hole"
                 BGColor     |> DynObj.setValueOpt polar "bgcolor"
                 RadialAxis  |> DynObj.setValueOpt polar "radialaxis"
                 AngularAxis |> DynObj.setValueOpt polar "angularaxis"
-                GridShape   |> DynObj.setValueOpt polar "gridshape"
+                GridShape   |> DynObj.setValueOptBy polar "gridshape" StyleParam.PolarGridShape.convert
                 UIRevision  |> DynObj.setValueOpt polar "uirevision"
 
                 polar