Refactoring surface plot

Author: muehlhaus

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

@@ -0,0 +1,79 @@
+(*** 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 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|]
+  
+
+// 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] )
+                    )
+
+let rnd = System.Random()
+let a = Array.init 50 (fun _ -> rnd.NextDouble())
+let b = Array.init 50 (fun _ -> rnd.NextDouble())
+let c = Array.init 50 (fun _ -> rnd.NextDouble())
+
+let cont = DynamicObj()
+//cont?color <- ""
+cont?show <- true
+cont?width <- 3
+
+Trace3d.initMesh3d 
+    (fun mesh3d ->
+        mesh3d?x <- a
+        mesh3d?y <- b
+        mesh3d?z <- c
+        mesh3d?flatshading <- true
+        //mesh3d?contour <- cont
+        mesh3d
+        )
+|> GenericChart.ofTraceObject 
+|> Chart.Show 
+
+
+//(*** define-output:contour1 ***)
+//z
+//|> Chart.Surface
+//|> Chart.withSize(600.,600.)
+//(*** include-it:contour1 ***)
+//
+//// Create simple example data were x y and z is given (z is a xy-Matrix)
+//let x' = [0.;2.5]
+//let y' = [0.;2.5]
+//let z' = [
+//    [1.;1.;]; // row wise (length x)
+//    [1.;1.;];
+//    ] // column (length y)
+//
+//Chart.Surface(z',x',y')
+
+
+

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

@@ -18,7 +18,7 @@ let z = [19; 26; 55;]
 
 
 (*** define-output:scatter3d_1 ***)
-Chart.Scatter3d(x,y,z,StyleOption.Mode.Markers)
+Chart.Scatter3d(x,y,z,StyleParam.Mode.Markers)
 |> Chart.withX_AxisStyle("my x-axis")
 |> Chart.withY_AxisStyle("my y-axis")
 |> Chart.withZ_AxisStyle("my z-axis")

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

@@ -36,8 +36,14 @@ let z =
         Array.init size (fun j -> f x.[j] y.[i] )
                     )
 
+let rnd = System.Random()
+let a = Array.init 50 (fun _ -> rnd.NextDouble())
+let b = Array.init 50 (fun _ -> rnd.NextDouble())
+let c = Array.init 50 (fun _ -> rnd.NextDouble())
+
+//let contours =
+    
 
-  
 (*** define-output:contour1 ***)
 z
 |> Chart.Surface
@@ -49,10 +55,10 @@ let x' = [0.;2.5]
 let y' = [0.;2.5]
 let z' = [
     [1.;1.;]; // row wise (length x)
-    [1.;1.;];
+    [1.;2.;];
     ] // column (length y)
 
-Chart.Surface(z',x',y')
-
+Chart.Surface(z',x',y',Opacity=0.,Contours=Contours.initContours(Contours.ContoursStyle.XyzContours(Show=true)))
+|> Chart.Show
 
 

docs/content/getting-started.fsx

@@ -16,24 +16,18 @@ FSharp.Plotly is powered by popular JavaScript charting library [Plotly](https:/
 #r "../../bin/FSharp.Plotly.dll"
 open FSharp.Plotly
 
-
-
-let trace =
-    Scatter(
-       
-        x = [1; 2; 3; 4],
-        y = [12; 9; 15; 12],
-        mode = "lines+markers",
-        name = "lines and markers"
-    )
-
-let layout =
-    Layout()
-
-trace.get_type
-
-
-GenericChart.ofTraceObject trace layout
+let scatter =
+//    let scatter = 
+//        Trace("scattergl")
+    Trace.initScatter (fun scatter ->
+        scatter?x <- [1; 2; 3; 4]
+        scatter?y <- [1; 2; 3; 4]
+        scatter?mode <- "lines+markers"
+        scatter?name <- "lines and markers"
+        scatter
+        )
+
+GenericChart.ofTraceObject scatter
 |> Chart.Show
 
 

docs/content/range-plots.fsx

@@ -22,5 +22,5 @@ Chart.Pie(values,labels)
 (*** include-it:pie1 ***)
 
 (*** define-output:doughnut1 ***)
-Chart.Doughnut(values,labels,hole=0.3)
+Chart.Doughnut(values,labels,Hole=0.3)
 (*** include-it:doughnut1 ***)

src/FSharp.Plotly/Chart.fs

@@ -6,6 +6,7 @@ open FSharp.Care.Collections
 
 open GenericChart
 open Trace
+open Trace3d
 open Layout
 
 /// Provides a set of static methods for creating charts.
@@ -376,27 +377,33 @@ type Chart =
 
     /// Uses points, line or both depending on the mode to represent 3d-data points
     static member Scatter3d(x, y, z, mode, ?Name,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
-        Trace3d.initScatter3d (Trace3d.Trace3dStyle.Scatter3d(X = x,Y = y,Z=z, Mode=mode) )              
+        Trace3d.initScatter3d (Trace3dStyle.Scatter3d(X = x,Y = y,Z=z, Mode=mode) )              
         |> TraceStyle.TraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
         |> TraceStyle.Line(?Color=Color,?Dash=Dash,?Width=Width)
         |> TraceStyle.Marker(?Color=Color,?Symbol=MarkerSymbol)
         |> TraceStyle.TextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
         |> GenericChart.ofTraceObject 
 
 
-    /// Displays the distribution of data based on the five number summary: minimum, first quartile, median, third quartile, and maximum.       
+    /// Uses points, line or both depending on the mode to represent 3d-data points
     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)
+    /// 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,?Contours,?Colorscale,?Showscale,?Colorbar) = 
+        Trace3d.initSurface (Trace3dStyle.Surface (Z=data,?X=X, ?Y=Y,?Contours=Contours,
+                                ?Colorscale=Colorscale,?Showscale=Showscale,?Colorbar=Colorbar ) )              
+        |> TraceStyle.TraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+        //|> TraceStyle.TextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        |> GenericChart.ofTraceObject 
+
+
+    /// Uses points, line or both depending on the mode to represent 3d-data points
+    static member Mesh3d(x, y, z, mode, ?Name,?Showlegend,?MarkerSymbol,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Dash,?Width) = 
+        Trace3d.initMesh3d (Trace3dStyle.Mesh3d(X = x,Y = y,Z=z) )              
+        |> TraceStyle.TraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+        |> TraceStyle.TextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        |> GenericChart.ofTraceObject 
 
 

src/FSharp.Plotly/ChartExtensions.fs

@@ -49,10 +49,10 @@ module ChartExtensions =
             )
 
         /// Apply styling to the Line(s) of the chart.
-        static member withLineStyle(?Width,?Color,?Shape,?Dash,?Smoothing,?ColorScale) =
+        static member withLineStyle(?Width,?Color,?Shape,?Dash,?Smoothing,?Colorscale) =
             let line = 
                 Line.init ( Line.LineStyle.Apply            
-                    (?Width=Width,?Color=Color,?Shape=Shape,?Dash=Dash,?Smoothing=Smoothing,?ColorScale=ColorScale)
+                    (?Width=Width,?Color=Color,?Shape=Shape,?Dash=Dash,?Smoothing=Smoothing,?Colorscale=Colorscale)
                 )         
             Chart.withLine(line)