Add GenericChart3d and Scatter3d

Author: muehlhaus

FSharp.Plotly.sln

@@ -29,6 +29,9 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{8E6D5255-776D-4B61-85F9-73C37AA1FB9A}"
 	ProjectSection(SolutionItems) = preProject
 		docs\content\2d-histograms.fsx = docs\content\2d-histograms.fsx
+		docs\content\3d-line-plots.fsx = docs\content\3d-line-plots.fsx
+		docs\content\3d-scatter-plots.fsx = docs\content\3d-scatter-plots.fsx
+		docs\content\3d-surface-plots.fsx = docs\content\3d-surface-plots.fsx
 		docs\content\area-plots.fsx = docs\content\area-plots.fsx
 		docs\content\bar-charts.fsx = docs\content\bar-charts.fsx
 		docs\content\box-plots.fsx = docs\content\box-plots.fsx

docs/content/3d-line-plots.fsx

@@ -0,0 +1,26 @@
+(*** hide ***)
+#r "../../bin/Newtonsoft.Json.dll"
+#r "../../bin/FSharp.Plotly.dll"
+
+(** 
+# FSharp.Plotly: Pie and Doughnut Charts
+
+*Summary:* This example shows how to create pie and doughnut charts in F#.
+
+A pie or a doughnut chart can be created using the `Chart.Pie` and `Chart.Doughnut` functions.
+When creating pie or doughnut charts, it is usually desirable to provide both labels and 
+values.
+*)
+
+open FSharp.Plotly 
+  
+let values = [19; 26; 55;]
+let labels = ["Residential"; "Non-Residential"; "Utility"]
+  
+(*** define-output:pie1 ***)
+Chart.Pie(values,labels)
+(*** include-it:pie1 ***)
+
+(*** define-output:doughnut1 ***)
+Chart.Doughnut(values,labels,Hole=0.3)
+(*** include-it:doughnut1 ***)

docs/content/3d-scatter-plots.fsx

@@ -0,0 +1,31 @@
+(*** hide ***)
+#r "../../bin/Newtonsoft.Json.dll"
+#r "../../bin/FSharp.Plotly.dll"
+
+(** 
+# FSharp.Plotly: Pie and Doughnut Charts
+
+*Summary:* This example shows how to create pie and doughnut charts in F#.
+
+A pie or a doughnut chart can be created using the `Chart.Pie` and `Chart.Doughnut` functions.
+When creating pie or doughnut charts, it is usually desirable to provide both labels and 
+values.
+*)
+
+open FSharp.Plotly 
+  
+let x = [19; 26; 55;]
+let y = [19; 26; 55;]
+let z = [19; 26; 55;]
+
+  
+(*** define-output:scatter3d_1 ***)
+Chart3d.Scatter(x,y,z,StyleOption.Mode.Markers)
+(*** include-it:scatter3d_1 ***)
+|> Chart3d.withSize(900.,900.)
+|> Chart3d.Show
+
+
+
+
+

docs/content/3d-surface-plots.fsx

@@ -0,0 +1,26 @@
+(*** hide ***)
+#r "../../bin/Newtonsoft.Json.dll"
+#r "../../bin/FSharp.Plotly.dll"
+
+(** 
+# FSharp.Plotly: Pie and Doughnut Charts
+
+*Summary:* This example shows how to create pie and doughnut charts in F#.
+
+A pie or a doughnut chart can be created using the `Chart.Pie` and `Chart.Doughnut` functions.
+When creating pie or doughnut charts, it is usually desirable to provide both labels and 
+values.
+*)
+
+open FSharp.Plotly 
+  
+let values = [19; 26; 55;]
+let labels = ["Residential"; "Non-Residential"; "Utility"]
+  
+(*** define-output:pie1 ***)
+Chart.Pie(values,labels)
+(*** include-it:pie1 ***)
+
+(*** define-output:doughnut1 ***)
+Chart.Doughnut(values,labels,Hole=0.3)
+(*** include-it:doughnut1 ***)

docs/content/getting-started.fsx

@@ -19,6 +19,7 @@ open FSharp.Plotly
 
 let trace =
     Scatter(
+       
         x = [1; 2; 3; 4],
         y = [12; 9; 15; 12],
         mode = "lines+markers"
@@ -28,6 +29,9 @@ let trace =
 let layout =
     Layout()
 
+trace.get_type
+
+
 GenericChart.ofTraceObject trace layout
 |> Chart.Show
 

src/FSharp.Plotly/Chart.fs

@@ -20,24 +20,48 @@ type Chart =
             |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
         GenericChart.Chart (trace,None)
 
+    /// Uses points, line or both depending on the mode to represent data points
+    static member Scatter(xy, mode, ?Name,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
+        let x,y = Seq.unzip xy 
+        Chart.Scatter(x, y, mode, ?Name=Name,?Showlegend=Showlegend,?MarkerSymbol=MarkerSymbol,?Color=Color,?Opacity=Opacity,?Labels=Labels,?TextPosition=TextPosition,?TextFont=TextFont,?Dash=Dash,?Width=Width)
+
+    /// Uses points to represent data points
+    static member Point(x, y, ?Name,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
+        let trace = 
+            TraceObjects.Scatter()
+            |> Options.Scatter(X = x,Y = y, Mode = StyleOption.Markers)               
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            |> Options.ILine(Options.Line(?Color=Color,?Dash=Dash,?Width=Width))
+            |> Options.IMarker(Options.Marker(?Color=Color,?Symbol=MarkerSymbol))
+            |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        GenericChart.Chart (trace,None)
+
+    /// Uses points to represent data points
+    static member Point(xy,?Name,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
+        let x,y = Seq.unzip xy 
+        Chart.Point(x, y, ?Name=Name,?Showlegend=Showlegend,?MarkerSymbol=MarkerSymbol,?Color=Color,?Opacity=Opacity,?Labels=Labels,?TextPosition=TextPosition,?TextFont=TextFont,?Dash=Dash,?Width=Width)
+
+    /// Uses lines to represent data points
+    static member Line(x, y, ?Name,?ShowMarkers,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
+        let mode' = 
+            match ShowMarkers with
+            | Some show -> if show then StyleOption.Lines_Markers else StyleOption.Lines
+            | None      -> StyleOption.Lines_Markers // default
+        let trace = 
+            TraceObjects.Scatter()
+            |> Options.Scatter(X = x,Y = y, Mode = mode')               
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            |> Options.ILine(Options.Line(?Color=Color,?Dash=Dash,?Width=Width))
+            |> Options.IMarker(Options.Marker(?Color=Color,?Symbol=MarkerSymbol))
+            |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        GenericChart.Chart (trace,None)
+
+    /// Uses lines to represent data points
+    static member Line(xy,?Name,?ShowMarkers,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
+        let x,y = Seq.unzip xy 
+        Chart.Line(x, y, ?Name=Name,?ShowMarkers=ShowMarkers,?Showlegend=Showlegend,?MarkerSymbol=MarkerSymbol,?Color=Color,?Opacity=Opacity,?Labels=Labels,?TextPosition=TextPosition,?TextFont=TextFont,?Dash=Dash,?Width=Width)
+
 
-//    /// Uses points to represent data points.
-//    static member Point(x, y, ?Name,?Showlegend,?Color,?Opacity,?MarkerSymbol,?Labels) =                      
-//        let trace = 
-//            TraceObjects.Scatter()
-//            |> Options.Scatter(X = x,Y = y, Mode=StyleOption.Markers, 
-//                TraceOptions=Options.Trace(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity),
-//                Marker=Options.Marker(?Color=Color,?Symbol=MarkerSymbol),
-//                ?Fillcolor=Color,?Text=Labels)
-//        GenericChart.Chart (trace,None)
-//
-//
-//    /// Uses points to represent data points.
-//    static member Point(xy, ?Name,?Showlegend,?Color,?Opacity,?MarkerSymbol,?Labels) =         
-//        let x,y = Seq.unzip xy
-//        Chart.Point(x,y, ?Name=Name,?Showlegend=Showlegend,?Color=Color,?Opacity=Opacity,?MarkerSymbol=MarkerSymbol,?Labels=Labels)
-//
-//
 //    /// Uses a line to connect the data points represented.
 //    static member Line(x, y,?Name,?ShowMarkers,?Dash,?Showlegend,?Width,?Color,?Opacity,?MarkerSymbol,?Labels) =             
 //        let mode' = match ShowMarkers with

src/FSharp.Plotly/Chart3d.fs

@@ -1,2 +1,23 @@
-module Chart3d
+namespace FSharp.Plotly
+
+open System
+open System.IO
+open FSharp.Care.Collections
+
+open GenericChart3d
+    
+/// Provides a set of static methods for creating charts.
+type Chart3d =
+
+    /// Uses points, line or both depending on the mode to represent data points
+    static member Scatter(x, y, z, mode, ?Name,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
+        let trace = 
+            Trace3dObjects.Scatter3d()
+            |> Options3d.Scatter3d(X = x,Y = y,Z=z, Mode=mode)               
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            |> Options.ILine(Options.Line(?Color=Color,?Dash=Dash,?Width=Width))
+            |> Options.IMarker(Options.Marker(?Color=Color,?Symbol=MarkerSymbol))
+            |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        GenericChart3d.Chart (trace,None)
+
 

src/FSharp.Plotly/Chart3dExtensions.fs

@@ -3,11 +3,32 @@
 open System
 open System.IO
 
-open GenericChart
+open GenericChart3d
 
 /// Extensions methods for 3d-Charts supporting the fluent pipeline style 'Chart3d.WithXYZ(...)'.
 [<AutoOpen>]
 module Chart3dExtensions =
+
+    /// Provides a set of static methods for creating charts.
+    type Chart3d with 
+
+        static member withSize(width,heigth) =            
+            (fun (ch:GenericChart3d) -> 
+                let layout = Options.Layout(Width=width,Height=heigth)
+                GenericChart3d.addLayout layout ch)  
 
-    let a = 42
+        // ####################### 
+        /// Create a combined chart with the given charts merged   
+        static member Combine(gCharts:seq<GenericChart3d>) =
+            GenericChart3d.combine gCharts
+        
+        /// Show chart in browser            
+        static member Show (ch:GenericChart3d) = 
+            let guid = Guid.NewGuid().ToString()
+            let html = GenericChart3d.toEmbeddedHTML ch
+            let tempPath = Path.GetTempPath()
+            let file = sprintf "%s.html" guid
+            let path = Path.Combine(tempPath, file)
+            File.WriteAllText(path, html)
+            System.Diagnostics.Process.Start(path) |> ignore
 

src/FSharp.Plotly/GenericChart.fs

@@ -29,7 +29,7 @@ module HTML =
   </script>"""
 
 
-/// Module 
+/// Module to represent a GenericChart
 module GenericChart =
     // 'T when 'T :> ITrace
     type GenericChart =