(closes #399) Add json generation functions for GenericChart, add json tests for all Chart2D test charts.

Author: kMutagene

src/Plotly.NET/ChartAPI/GenericChart.fs

@@ -117,6 +117,22 @@ module GenericChart =
                 Frames = []
             }
 
+    type ChartDTO =
+        {
+            [<JsonProperty("data")>]
+            Data: Trace list
+            [<JsonProperty("layout")>]
+            Layout: Layout
+            [<JsonProperty("config")>]
+            Config: Config
+        }
+        static member create data layout config =
+            {
+                Data = data
+                Layout = layout
+                Config = config
+            }
+
     //TO-DO refactor as type with static members to remove verbose top namespace from 'GenericChart.GenericChart'
     type GenericChart =
         | Chart of Trace * Layout * Config * DisplayOptions
@@ -317,6 +333,47 @@ module GenericChart =
         )
         |> RenderView.AsString.htmlDocument
 
+    /// <summary>
+    /// Serializes a GenericChart to a JSON string, representing the data and layout of the GenericChart:
+    ///
+    /// {
+    ///
+    /// "data": [ -serialized traces array- ] ,
+    ///
+    /// "layout": { -serialized layout object- } ,
+    ///
+    /// "frames": [ -empty array, not supported yet, legacy stuff- ]
+    ///
+    /// }
+    /// </summary>
+    /// <param name="gChart">the chart to serialize</param>
+    let toFigureJson gChart =
+        gChart
+        |> toFigure
+        |> fun f -> JsonConvert.SerializeObject(f, Globals.JSON_CONFIG)
+
+    /// <summary>
+    /// Serializes a GenericChart to a JSON string, representing the data, layout and config of the GenericChart:
+    ///
+    /// {
+    ///
+    /// "data": [ -serialized traces array- ] ,
+    ///
+    /// "layout": { -serialized layout object- } ,
+    ///
+    /// "config": { -serialized config object- }
+    ///
+    /// }
+    /// </summary>
+    /// <param name="gChart">the chart to serialize</param>
+    let toJson gChart =
+
+        ChartDTO.create 
+            (getTraces gChart)
+            (getLayout gChart)
+            (getConfig gChart)
+        |> fun dto -> JsonConvert.SerializeObject(dto, Globals.JSON_CONFIG)
+
     /// Creates a new GenericChart whose traces are the results of applying the given function to each of the trace of the GenericChart.
     let mapTrace f gChart =
         match gChart with

tests/Common/FSharpTestBase/TestCharts/Chart2DTestCharts.fs

@@ -163,6 +163,8 @@ module Bar =
         let keys   = ["Product A"; "Product B"; "Product C";]
         Chart.Bar(values = values, Keys = keys, UseDefaults = false)
 
+module StackedBar = 
+
     let ``Two stacked bars chart`` =
         let values = [20; 14; 23;]
         let keys   = ["Product A"; "Product B"; "Product C";]
@@ -172,15 +174,16 @@ module Bar =
         ]
         |> Chart.combine
 
-module StackedBar = ()
-
 module Column = 
 
     let ``Simple column chart`` =
         let values = [20; 14; 23;]
         let keys   = ["Product A"; "Product B"; "Product C";]
         Chart.Column(values = values, Keys = keys, UseDefaults = false)
 
+module StackedColumn = 
+
+    
     let ``Two stacked columns chart`` =
         let values = [20; 14; 23;]
         let keys   = ["Product A"; "Product B"; "Product C";]
@@ -190,8 +193,6 @@ module Column =
         ]
         |> Chart.combine
 
-module StackedColumn = ()
-
 module Histogram = 
 
     let ``Simple histogram`` =

tests/Common/FSharpTestBase/TestUtils.fs

@@ -203,6 +203,16 @@ module HtmlCodegen =
     let emptyLayout chart =
         "var layout = {};" |> chartGeneratedContains chart
 
+module JsonGen =
+    
+    let jsonIs chart expected =
+        let json = chart |> GenericChart.toJson
+        Expect.equal json expected $"JSON not equal to expected value."
+
+    let figureJsonIs chart expected =
+        let json = chart |> GenericChart.toFigureJson
+        Expect.equal json expected $"JSON not equal to expected value."
+
 module Objects =
 
     let jsonFieldIsSetWith fieldName expected (object:#DynamicObj) =

tests/CoreTests/CoreTests/CoreTests.fsproj

@@ -22,6 +22,8 @@
     <Compile Include="HTMLCodegen\SimpleTests.fs" />
     <Compile Include="HTMLCodegen\ChartLayout.fs" />
     <Compile Include="HTMLCodegen\MulticategoryData.fs" />
+    <!--JSONGen-->
+    <Compile Include="JSONGen\Chart2D.fs" />
     <!--Misc-->
     <Compile Include="ChartAPIs\WithAxis.fs" />
     <Compile Include="ChartAPIs\Combine.fs" />

tests/CoreTests/CoreTests/HTMLCodegen/Chart2D.fs

@@ -198,11 +198,11 @@ module StackedBar =
             testList "StackedBar" [
                 testCase "Stacked bar data" ( fun () ->
                     """var data = [{"type":"bar","name":"old","x":[20,14,23],"y":["Product A","Product B","Product C"],"orientation":"h","marker":{"pattern":{}}},{"type":"bar","name":"new","x":[8,21,13],"y":["Product A","Product B","Product C"],"orientation":"h","marker":{"pattern":{}}}];"""
-                    |> chartGeneratedContains Bar.``Two stacked bars chart``
+                    |> chartGeneratedContains StackedBar.``Two stacked bars chart``
                 );
                 testCase "Stacked bar layout" ( fun () ->
                     "var layout = {\"barmode\":\"stack\"};"
-                    |> chartGeneratedContains Bar.``Two stacked bars chart``
+                    |> chartGeneratedContains StackedBar.``Two stacked bars chart``
                 );
             ]
         ]
@@ -229,11 +229,11 @@ module StackedColumn =
             testList "StackedColumn" [
                 testCase "Stacked column data" ( fun () ->
                     """var data = [{"type":"bar","name":"old","x":["Product A","Product B","Product C"],"y":[20,14,23],"orientation":"v","marker":{"pattern":{}}},{"type":"bar","name":"new","x":["Product A","Product B","Product C"],"y":[8,21,13],"orientation":"v","marker":{"pattern":{}}}];"""
-                    |> chartGeneratedContains Column.``Two stacked columns chart``
+                    |> chartGeneratedContains StackedColumn.``Two stacked columns chart``
                 );
                 testCase "Stacked column layout" ( fun () ->
                     "var layout = {\"barmode\":\"stack\"};"
-                    |> chartGeneratedContains Column.``Two stacked columns chart``
+                    |> chartGeneratedContains StackedColumn.``Two stacked columns chart``
                 );
             ]
         ]