Further unify Trace/Layout/Chart APIs

Author: kMutagene

docs/02_7_heatmaps.fsx

@@ -105,9 +105,7 @@ let heat3 =
         matrix,
         ColorScale = StyleParam.Colorscale.Viridis
     )
-    |> Chart.withColorBarStyle(
-        Title.init("Im the ColorBar")
-    )
+    |> Chart.withColorBarStyle(TitleText = "Im the ColorBar")
 
 (*** condition: ipynb ***)
 #if IPYNB

docs/05_2_choropleth-map.fsx

@@ -126,7 +126,7 @@ let choroplethMap2 =
         ShowOcean=true,
         OceanColor=Color.fromString "lightblue",
         ShowRivers=true)
-    |> Chart.withColorBarStyle (Title.init("Alcohol consumption[l/y]"),Length=0.5)
+    |> Chart.withColorBarStyle (TitleText = "Alcohol consumption[l/y]", Len=0.5)
 
 (*** condition: ipynb ***)
 #if IPYNB

src/Plotly.NET/ChartAPI/Chart.fs

@@ -3145,7 +3145,7 @@ module StyleParam =
 
         static member toString =
             function
-            | Toggle -> "toggleitem"
+            | ToggleItem -> "toggleitem"
             | ToggleGroup -> "togglegroup"
 
         static member convert = TraceGroupClickOptions.toString >> box

src/Plotly.NET/CommonAbstractions/StyleParams.fs

@@ -224,7 +224,7 @@ type Layout() =
         )
 
     /// <summary>
-    /// Returns a function ahat applies the given styles to a Layout object.
+    /// Returns a function that applies the given styles to a Layout object.
     /// </summary>
     /// <param name="Title">Sets the title of the layout.</param>
     /// <param name="ShowLegend">Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.</param>
@@ -483,8 +483,8 @@ type Layout() =
     /// If there is no linear axis set, returns an empty LinearAxis object.
     /// </summary>
     /// <param name="id">The target axis id</param>
-    static member getLinearAxisById (id: StyleParam.SubPlotId) (layout: Layout) =
-        layout |> Layout.tryGetLinearAxisById id |> Option.defaultValue (LinearAxis.init ())
+    static member getLinearAxisById(id: StyleParam.SubPlotId) =
+        (fun (layout: Layout) -> layout |> Layout.tryGetLinearAxisById id |> Option.defaultValue (LinearAxis.init ()))
 
     /// <summary>
     /// Sets a linear axis object on the layout as a dynamic property with the given axis id.
@@ -532,8 +532,8 @@ type Layout() =
     /// If there is no scene set, returns an empty Scene object.
     /// </summary>
     /// <param name="id">The target scene id</param>
-    static member getSceneById (id: StyleParam.SubPlotId) (layout: Layout) =
-        layout |> Layout.tryGetSceneById id |> Option.defaultValue (Scene.init ())
+    static member getSceneById(id: StyleParam.SubPlotId) =
+        (fun (layout: Layout) -> layout |> Layout.tryGetSceneById id |> Option.defaultValue (Scene.init ()))
 
     /// <summary>
     /// Sets a scene object on the layout as a dynamic property with the given scene id.
@@ -573,8 +573,8 @@ type Layout() =
     /// If there is no geo set, returns an empty Geo object.
     /// </summary>
     /// <param name="id">The target geo id</param>
-    static member getGeoById (id: StyleParam.SubPlotId) (layout: Layout) =
-        layout |> Layout.tryGetGeoById id |> Option.defaultValue (Geo.init ())
+    static member getGeoById(id: StyleParam.SubPlotId) =
+        (fun (layout: Layout) -> layout |> Layout.tryGetGeoById id |> Option.defaultValue (Geo.init ()))
 
     /// <summary>
     /// Sets a geo object on the layout as a dynamic property with the given geo id.
@@ -616,8 +616,8 @@ type Layout() =
     /// If there is no mapbox set, returns an empty Mapbox object.
     /// </summary>
     /// <param name="id">The target mapbox id</param>
-    static member getMapboxById (id: StyleParam.SubPlotId) (layout: Layout) =
-        layout |> Layout.tryGetMapboxById id |> Option.defaultValue (Mapbox.init ())
+    static member getMapboxById(id: StyleParam.SubPlotId) =
+        (fun (layout: Layout) -> layout |> Layout.tryGetMapboxById id |> Option.defaultValue (Mapbox.init ()))
 
     /// <summary>
     /// Sets a mapbox object on the layout as a dynamic property with the given mapbox id.
@@ -661,8 +661,8 @@ type Layout() =
     /// If there is no polar set, returns an empty Polar object.
     /// </summary>
     /// <param name="id">The target polar id</param>
-    static member getPolarById (id: StyleParam.SubPlotId) (layout: Layout) =
-        layout |> Layout.tryGetPolarById id |> Option.defaultValue (Polar.init ())
+    static member getPolarById(id: StyleParam.SubPlotId) =
+        (fun (layout: Layout) -> layout |> Layout.tryGetPolarById id |> Option.defaultValue (Polar.init ()))
 
     /// <summary>
     /// Sets a polar object on the layout as a dynamic property with the given polar id.
@@ -706,8 +706,8 @@ type Layout() =
     /// If there is no color axis set, returns an empty ColorAxis object.
     /// </summary>
     /// <param name="id">The target color axis id</param>
-    static member getColorAxisById (id: StyleParam.SubPlotId) (layout: Layout) =
-        layout |> Layout.tryGetColorAxisById id |> Option.defaultValue (ColorAxis.init ())
+    static member getColorAxisById(id: StyleParam.SubPlotId) =
+        (fun (layout: Layout) -> layout |> Layout.tryGetColorAxisById id |> Option.defaultValue (ColorAxis.init ()))
 
     /// <summary>
     /// Sets a ColorAxis object on the layout as a dynamic property with the given ColorAxis id.
@@ -751,8 +751,8 @@ type Layout() =
     /// If there is no ternary set, returns an empty Ternary object.
     /// </summary>
     /// <param name="id">The target ternary id</param>
-    static member getTernaryById (id: StyleParam.SubPlotId) (layout: Layout) =
-        layout |> Layout.tryGetTernaryById id |> Option.defaultValue (Ternary.init ())
+    static member getTernaryById(id: StyleParam.SubPlotId) =
+        (fun (layout: Layout) -> layout |> Layout.tryGetTernaryById id |> Option.defaultValue (Ternary.init ()))
 
     /// <summary>
     /// Sets a Ternary object on the layout as a dynamic property with the given Ternary id.
@@ -816,7 +816,7 @@ type Layout() =
     /// <summary>
     /// Combines the given Legend object with the one already present on the layout.
     /// </summary>
-    /// <param name="legend">The updated LayoutGrid object</param>
+    /// <param name="legend">The updated Legend object</param>
     static member updateLegend(legend: Legend) =
         (fun (layout: Layout) ->
             let combined =

src/Plotly.NET/Layout/Layout.fs

@@ -42,6 +42,17 @@ type Trace(traceTypeName: string) =
             trace.SetValue("marker", marker)
             trace)
 
+    /// <summary>
+    /// Combines the given marker object with the one already present on the trace.
+    /// </summary>
+    /// <param name="marker">The updated Trace object</param>
+    static member updateMarker(marker: Marker) =
+        (fun (trace: #Trace) ->
+            let combined =
+                (DynObj.combine (trace |> Trace.getMarker) marker) :?> Marker
+
+            trace |> Trace.setMarker combined)
+
     /// <summary>
     /// Returns the Line object of the given trace.
     ///
@@ -60,6 +71,17 @@ type Trace(traceTypeName: string) =
             trace.SetValue("line", line)
             trace)
 
+    /// <summary>
+    /// Combines the given Line object with the one already present on the trace.
+    /// </summary>
+    /// <param name="line">The updated Line object</param>
+    static member updateLine(line: Line) =
+        (fun (trace: #Trace) ->
+            let combined =
+                (DynObj.combine (trace |> Trace.getLine) line) :?> Line
+
+            trace |> Trace.setLine combined)
+
     /// <summary>
     /// Returns the Error object for the x dimension of the given trace.
     ///
@@ -78,6 +100,17 @@ type Trace(traceTypeName: string) =
             trace.SetValue("error_x", error)
             trace)
 
+    /// <summary>
+    /// Combines the given Error object for the x dimension with the one already present on the trace.
+    /// </summary>
+    /// <param name="error">The updated Error object</param>
+    static member updateXError(error: Error) =
+        (fun (trace: #Trace) ->
+            let combined =
+                (DynObj.combine (trace |> Trace.getXError) error) :?> Error
+
+            trace |> Trace.setXError combined)
+
     /// <summary>
     /// Returns the Error object for the y dimension of the given trace.
     ///
@@ -96,6 +129,17 @@ type Trace(traceTypeName: string) =
             trace.SetValue("error_y", error)
             trace)
 
+    /// <summary>
+    /// Combines the given Error object for the y dimension with the one already present on the trace.
+    /// </summary>
+    /// <param name="error">The updated Error object</param>
+    static member updateYError(error: Error) =
+        (fun (trace: #Trace) ->
+            let combined =
+                (DynObj.combine (trace |> Trace.getYError) error) :?> Error
+
+            trace |> Trace.setYError combined)
+
     /// <summary>
     /// Returns the Error object for the z dimension of the given trace.
     ///
@@ -114,6 +158,17 @@ type Trace(traceTypeName: string) =
             trace.SetValue("error_z", error)
             trace)
 
+    /// <summary>
+    /// Combines the given Error object for the z dimension with the one already present on the trace.
+    /// </summary>
+    /// <param name="error">The updated Error object</param>
+    static member updateZError(error: Error) =
+        (fun (trace: #Trace) ->
+            let combined =
+                (DynObj.combine (trace |> Trace.getZError) error) :?> Error
+
+            trace |> Trace.setZError combined)
+
     /// <summary>
     /// Returns the color axis anchor of the given trace.
     ///
@@ -159,6 +214,17 @@ type Trace(traceTypeName: string) =
             trace.SetValue("domain", domain)
             trace)
 
+    /// <summary>
+    /// Combines the given Domain object with the one already present on the trace.
+    /// </summary>
+    /// <param name="domain">The updated Domain object</param>
+    static member updateDomain(domain: Domain) =
+        (fun (trace: #Trace) ->
+            let combined =
+                (DynObj.combine (trace |> Trace.getDomain) domain) :?> Domain
+
+            trace |> Trace.setDomain combined)
+
     /// <summary>
     /// Returns the stackgroup of the given trace.
     ///
@@ -196,6 +262,17 @@ type Trace(traceTypeName: string) =
             trace.SetValue("colorbar", colorBar)
             trace)
 
+    /// <summary>
+    /// Combines the given ColorBar object with the one already present on the trace.
+    /// </summary>
+    /// <param name="colorBar">The updated ColorBar object</param>
+    static member updateColorBar(colorBar: ColorBar) =
+        (fun (trace: #Trace) ->
+            let combined =
+                (DynObj.combine (trace |> Trace.getColorBar) colorBar) :?> ColorBar
+
+            trace |> Trace.setColorBar combined)
+
 //-------------------------------------------------------------------------------------------------------------------------------------------------
 /// Contains general, visualization-unspecific functions to style Trace objects.
 ///
@@ -235,7 +312,7 @@ type TraceStyle() =
             trace)
 
     /// <summary>
-    /// Returns a function that applies the given styles to the trace's marker object.
+    /// Returns a function that applies the given styles to the trace's marker object. Overwrites attributes with the same name that are already set.
     /// </summary>
     /// <param name="AutoColorScale">Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.</param>
     /// <param name="CAuto">Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.</param>
@@ -337,7 +414,7 @@ type TraceStyle() =
             trace |> Trace.setMarker (marker))
 
     /// <summary>
-    /// Returns a function that applies the given styles to the trace's line object.
+    /// Returns a function that applies the given styles to the trace's line object. Overwrites attributes with the same name that are already set.
     /// </summary>
     /// <param name="AutoColorScale">Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.</param>
     /// <param name="CAuto">Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.</param>
@@ -409,7 +486,7 @@ type TraceStyle() =
             trace |> Trace.setLine (line))
 
     /// <summary>
-    /// Returns a function that applies the given styles to the trace's Error object for the x dimension.
+    /// Returns a function that applies the given styles to the trace's Error object for the x dimension. Overwrites attributes with the same name that are already set.
     /// </summary>
     /// <param name ="Visible">Determines whether or not this set of error bars is visible.</param>
     /// <param name ="Type">Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.</param>
@@ -463,7 +540,7 @@ type TraceStyle() =
             trace |> Trace.setXError (xerror))
 
     /// <summary>
-    /// Returns a function that applies the given styles to the trace's Error object for the y dimension.
+    /// Returns a function that applies the given styles to the trace's Error object for the y dimension. Overwrites attributes with the same name that are already set.
     /// </summary>
     /// <param name ="Visible">Determines whether or not this set of error bars is visible.</param>
     /// <param name ="Type">Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.</param>

src/Plotly.NET/Traces/Trace.fs

@@ -245,8 +245,7 @@ let choroplethMap2Chart =
         OceanColor= Color.fromString "lightblue",
         ShowRivers=true)
     |> Chart.withColorBarStyle (
-        Title.init(Text="Alcohol consumption[l/y]")
-        ,Length=0.5
+        TitleText="Alcohol consumption[l/y]",Len=0.5
     )
 
 [<Tests>]

tests/Plotly.NET.Tests/HtmlCodegen/GeoMapCharts.fs

@@ -517,11 +517,7 @@ let heatmapStyledChart =
     )
     |> Chart.withSize(700.,500.)
     |> Chart.withMarginSize(Left=200.)
-    |> Chart.withColorBarStyle(
-        Title.init(
-            Text = "Im the Colorbar"
-        )
-    )
+    |> Chart.withColorBarStyle(TitleText = "Im the Colorbar")
 
 let annotatedheatmap = 
     Chart.AnnotatedHeatmap(