Fixed Scatter3d lines and added 3d surface plot

Author: muehlhaus

RELEASE_NOTES.md

@@ -1,3 +1,7 @@
+### 1.0.2 - Sep 12 2016
+* Add Scatter3d line plots
+* Add 3d Surface plots
+
 ### 1.0.1 - July 5 2016
 * More awesome stuff coming...
 * More 3d-Charts

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

@@ -3,24 +3,35 @@
 #r "../../bin/FSharp.Plotly.dll"
 
 (** 
-# FSharp.Plotly: Pie and Doughnut Charts
+# FSharp.Plotly: Scatter3d Charts with lines 
 
-*Summary:* This example shows how to create pie and doughnut charts in F#.
+*Summary:* This example shows how to create three-dimensional scatter 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.
+A Scatter3d chart report shows a three-dimensional spinnable view of your data as line with markers
 *)
 
 open FSharp.Plotly 
+open System
+ 
+let c = [0. .. 0.5 .. 15.]
+
+let x,y,z =  
+    c
+    |> List.map (fun i ->
+                    let i' = float i 
+                    let r = 10. * Math.Cos (i' / 10.)
+                    (r*Math.Cos i',r*Math.Sin i',i')
+                    )
+    |> List.unzip3
+
 
-let values = [19; 26; 55;]
-let labels = ["Residential"; "Non-Residential"; "Utility"]
-  
-(*** define-output:pie1 ***)
-Chart.Pie(values,labels)
-(*** include-it:pie1 ***)
+(*** define-output:scatter3d_line_1 ***)
+Chart.Scatter3d(x,y,z,StyleOption.Mode.Lines_Markers)
+|> Chart.withX_AxisStyle("x-axis")
+|> Chart.withY_AxisStyle("y-axis")
+|> Chart.withZ_AxisStyle("z-axis")
+|> Chart.withSize(800.,800.)
+
+(*** include-it:scatter3d_line_1 ***)
+
 
-(*** define-output:doughnut1 ***)
-Chart.Doughnut(values,labels,Hole=0.3)
-(*** include-it:doughnut1 ***)

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

@@ -32,3 +32,5 @@ Chart.Scatter3d(x,y,z,StyleOption.Mode.Markers)
 
 
 
+
+

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

@@ -12,15 +12,41 @@ When creating pie or doughnut charts, it is usually desirable to provide both la
 values.
 *)
 
+open System
 open FSharp.Plotly 
+
+
+// Generate linearly spaced vector
+let linspace (min,max,n) = 
+    if n <= 2 then failwithf "n needs to be larger then 2"
+    let bw = float (max - min) / (float n - 1.)
+    Array.init n (fun i -> min + (bw * float i))
+    //[|min ..bw ..max|]
 
-let values = [19; 26; 55;]
-let labels = ["Residential"; "Non-Residential"; "Utility"]
+
+// Create example data
+let size = 100
+let x = linspace(-2. * Math.PI, 2. * Math.PI, size)
+let y = linspace(-2. * Math.PI, 2. * Math.PI, size)
+
+let f x y = - (5. * x / (x**2. + y**2. + 1.) )
+
+let z = 
+    Array.init size (fun i -> 
+        Array.init size (fun j -> f x.[j] y.[i] )
+                    )
+
+
 
-(*** define-output:pie1 ***)
-Chart.Pie(values,labels)
-(*** include-it:pie1 ***)
+(*** define-output:contour1 ***)
+z
+|> Chart.Surface
+|> Chart.withSize(600.,600.)
+(*** include-it:contour1 ***)
+
+
+
+
+
+
 
-(*** define-output:doughnut1 ***)
-Chart.Doughnut(values,labels,Hole=0.3)
-(*** include-it:doughnut1 ***)

docs/content/box-plots.fsx

@@ -19,5 +19,29 @@ let y =  [2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1.]
 let x = ["bin1";"bin2";"bin1";"bin2";"bin1";"bin2";"bin1";"bin1";"bin2";"bin1"]
 
 (*** define-output:box1 ***)
-Chart.BoxPlot(x,y,Jitter=0.3,Boxpoints=StyleOption.Boxpoints.Outliers)
+Chart.BoxPlot(x,y,Jitter=0.1,Boxpoints=StyleOption.Boxpoints.All)
 (*** include-it:box1 ***)
+
+(**
+By swapping x and y plus using `StyleOption.Orientation.Horizontal` we can flip the chart horizontaly.
+*)
+(*** define-output:box2 ***)
+Chart.BoxPlot(y,x,Jitter=0.1,Boxpoints=StyleOption.Boxpoints.All,Orientation=StyleOption.Orientation.Horizontal)
+(*** include-it:box2 ***)
+
+
+
+(**
+You can also produce a boxplot using the `Chart.Combine` syntax.
+*)
+
+let y' =  [2.; 1.5; 5.; 1.5; 2.; 2.5; 2.1; 2.5; 1.5; 1.;2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1.]
+
+(*** define-output:box3 ***)
+[
+    Chart.BoxPlot("y" ,y,Name="bin1",Jitter=0.1,Boxpoints=StyleOption.Boxpoints.All);
+    Chart.BoxPlot("y'",y',Name="bin2",Jitter=0.1,Boxpoints=StyleOption.Boxpoints.All);
+]
+|> Chart.Combine
+(*** include-it:box3 ***)
+

docs/tools/formatters.fsx

@@ -43,7 +43,7 @@ let createFsiEvaluator root output =
 
     | :? GenericChart.GenericChart as ch ->
         // Just return the inline HTML for a Plotly chart        
-        let html = GenericChart.toChartHtmlWithSize 500 500 ch
+        let html = GenericChart.toChartHtmlWithSize 700 500 ch
         Some [InlineBlock <| html]
 
     | _ -> None 

docs/tools/templates/template.cshtml

@@ -57,8 +57,8 @@
               <li><a href="@Root/range-plots.html">Range Plots</a></li>                                                             
             <li class="nav-header">Plotly 3d-Charts</li>
               <li><a href="@Root/3d-scatter-plots.html">3D Scatter Plots</a></li>           
-              @*<li><a href="@Root/3d-line-plots.html">3D Line Plots</a></li>             
-              <li><a href="@Root/3d-surface-plots.html">3D Surface Plots</a></li>*@
+              <li><a href="@Root/3d-line-plots.html">3D Line Plots</a></li>             
+              <li><a href="@Root/3d-surface-plots.html">3D Surface Plots</a></li>
             <li class="nav-header">Plotly WPF</li>
               <li><a href="@Root/plotly-wpf.html">Using Plotly PopUp window</a></li>            
 

src/FSharp.Plotly/Chart.fs

@@ -376,3 +376,14 @@ type Chart =
     static member Scatter3d(xyz, mode, ?Name,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
         let x,y,z = Seq.unzip3 xyz
         Chart.Scatter3d(x, y, z, mode, ?Name=Name,?Showlegend=Showlegend,?MarkerSymbol=MarkerSymbol,?Color=Color,?Opacity=Opacity,?Labels=Labels,?TextPosition=TextPosition,?TextFont=TextFont,?Dash=Dash,?Width=Width) 
+
+    /// Uses points, line or both depending on the mode to represent 3d-data points
+    static member Surface(data:seq<#seq<#IConvertible>>,?X,?Y, ?Name,?Showlegend,?Opacity,?Colorscale,?Showscale,?zSmooth,?Colorbar) = 
+        let trace = 
+            Trace3dObjects.Surface()
+            |> Options.IMapZ(Z=data,?X=X, ?Y=Y)
+            |> Options.IColormap(?Colorscale=Colorscale,?Showscale=Showscale,?zSmooth=zSmooth,?Colorbar=Colorbar)
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            //|> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)                                                      
+        GenericChart.Chart (trace,None)
+

src/FSharp.Plotly/StyleOption.fs

@@ -182,11 +182,11 @@ module StyleOption =
 
     type Orientation =
         | Horizontal
-        | Vertival
+        | Vertical
 
         static member convert = function
             | Horizontal -> box "h"
-            | Vertival   -> box "v"
+            | Vertical   -> box "v"
 
     /// The colorscale must be a collection containing a mapping of a normalized value (between 0.0 and 1.0) to it's color. At minimum, a mapping for the lowest (0.0) and highest (1.0) values are required. 
     type ColorScale =