Add histogram docs

Author: muehl

FSharp.Plotly.sln

@@ -30,6 +30,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{8E6D
 	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-mesh-plots.fsx = docs\content\3d-mesh-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/2d-histograms.fsx

@@ -7,17 +7,50 @@
 
 *Summary:* This example shows how to create a bi-dimensional histogram of two data samples in F#.
 
-A Histogram2d chart can be created using the `Chart.Histogram2d` functions.
+A Histogram2d chart can be created using the `Chart.Histogram2d` or `Chart.Histogram2dContour` functions.
 *)
 
 open FSharp.Plotly 
-  
+
+// generate random normaly distributed data
+let normal (rnd:System.Random) mu tau =
+    let mutable v1 = 2.0 * rnd.NextDouble() - 1.0
+    let mutable v2 = 2.0 * rnd.NextDouble() - 1.0
+    let mutable r = v1 * v1 + v2 * v2
+    while (r >= 1.0 || r = 0.0) do
+        v1 <- 2.0 * rnd.NextDouble() - 1.0
+        v2 <- 2.0 * rnd.NextDouble() - 1.0
+        r <- v1 * v1 + v2 * v2
+    let fac = sqrt(-2.0*(log r)/r)
+    (tau * v1 * fac + mu)
+
+
+
 let rnd = System.Random()
-let x' = [for i=0 to 500 do yield rnd.NextDouble() ]
-let y' = [for i=0 to 500 do yield rnd.NextDouble() ]
+let n = 2000
+let a = -1.
+let b = 1.2
+let step i = a +  ((b - a) / float (n - 1)) * float i
+
+// generate data disturbed in x and y direction
+let x = Array.init n (fun i -> ((step i)**3.) + (0.3 * (normal (rnd) 0. 2.) ))
+let y = Array.init n (fun i -> ((step i)**6.) + (0.3 * (normal (rnd) 0. 2.) ))
+
+(*** define-output:Histogram2dContour1 ***)
+[
+    Chart.Histogram2dContour (x,y,Line=Line.init(Width=0))
+    Chart.Point(x,y,Opacity=0.3)
+]
+|> Chart.Combine
+(*** include-it:Histogram2dContour1 ***)
+
+
+(*** define-output:Histogram2d1 ***)
+Chart.Histogram2d (x,y)
+(*** include-it:Histogram2d1 ***)
+
+
+
+
 
-(*** define-output:histo1 ***)
-[for i=0 to 500 do yield rnd.NextDouble(),rnd.NextDouble() ]
-|> Chart.Histogram2d
-|> Chart.withSize(500.,500.)
-(*** include-it:histo1 ***)
+

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

@@ -52,7 +52,7 @@ Trace3d.initMesh3d
         mesh3d?y <- b
         mesh3d?z <- c
         mesh3d?flatshading <- true
-        //mesh3d?contour <- cont
+        mesh3d?contour <- Contours.initXyz(Show=true)
         mesh3d
         )
 |> GenericChart.ofTraceObject 

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

@@ -41,8 +41,6 @@ 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
@@ -58,7 +56,8 @@ let z' = [
     [1.;2.;];
     ] // column (length y)
 
-//Chart.Surface(z',x',y',Opacity=0.,Contours=Contours. init(Contours.styleXyz(Show=true)))
-//|> Chart.Show
+(*** define-output:contour2 ***)
+Chart.Surface(z',x',y',Opacity=0.5,Contours=Contours.initXyz(Show=true))
+(*** define-output:contour2 ***)
 
 

docs/content/histograms.fsx

@@ -3,68 +3,23 @@
 #r "../../bin/FSharp.Plotly.dll"
 
 (** 
-# FSharp.Plotly: Pie and Doughnut Charts
+# FSharp.Plotly: Histogram2d
 
-*Summary:* This example shows how to create pie and doughnut charts in F#.
+*Summary:* This example shows how to create a one-dimensional histogram of a data samples 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 histogram consisting of rectangles whose area is proportional to the frequency of a variable and whose width is equal to the class interval.
+The histogram chart represents the distribution of numerical data and can be created using the `Chart.Histogram`.
 *)
 
 open FSharp.Plotly 
 
-
-let normal (rnd:System.Random) mu tau =
-    let mutable v1 = 2.0 * rnd.NextDouble() - 1.0
-    let mutable v2 = 2.0 * rnd.NextDouble() - 1.0
-    let mutable r = v1 * v1 + v2 * v2
-    while (r >= 1.0 || r = 0.0) do
-        v1 <- 2.0 * rnd.NextDouble() - 1.0
-        v2 <- 2.0 * rnd.NextDouble() - 1.0
-        r <- v1 * v1 + v2 * v2
-    let fac = sqrt(-2.0*(log r)/r)
-    (tau * v1 * fac + mu)
-
 let rnd = System.Random()
-let sampleNormal () = 
-    normal (rnd) 0. 2.
-
-let n = 2000
-let a = -1.
-let b = 1.2
-let step i = a +  ((b - a) / float (n - 1)) * float i
-
-let x = Array.init n (fun i -> ((step i)**3.) + (0.3 * sampleNormal () ))
-let y = Array.init n (fun i -> ((step i)**6.) + (0.3 * sampleNormal () ))
-
-
-let colorScale = StyleParam.Colorscale.Custom [(0.0,"white");(1.0,"red")]
-
-(*** define-output:Histogram2dContour1 ***)
-[
-    Chart.Histogram2dContour (x,y,Colorscale=colorScale,Line=Line.init(Width=0))
-    Chart.Point(x,y,Opacity=0.3)
-]
-|> Chart.Combine
-(*** include-it:Histogram2dContour1 ***)
+let x = [for i=0 to 500 do yield rnd.NextDouble() ]
+  
+(*** define-output:histo1 ***)
+x
+|> Chart.Histogram
+|> Chart.withSize(500.,500.)
+//(*** include-it:histo1 ***)
 |> Chart.Show
 
-
-(*** define-output:Histogram1 ***)
-[
-    //var layout = {barmode: "overlay"};
-    Chart.Histogram x
-    Chart.Histogram y
-]
-|> Chart.Combine
-(*** include-it:Histogram1 ***)
-|> Chart.Show
-
-
-(*** define-output:Histogram2d1 ***)
-Chart.Histogram2d (x,y,Colorscale=colorScale)
-(*** include-it:Histogram2d1 ***)
-|> Chart.Show
-
-

docs/content/polar-charts.fsx

@@ -29,6 +29,4 @@ let t  = [0; 45; 90; 135; 200; 320; 184;]
 ]
 |> Chart.Combine
 (*** include-it:polar1 ***)
-|> Chart.Show
-
 

docs/content/windrose-charts.fsx

@@ -20,15 +20,15 @@ let r''' = [20.0; 7.5; 15.0; 22.5; 2.5; 2.5; 12.5; 22.5]
 
 let t = ["North"; "N-E"; "East"; "S-E"; "South"; "S-W"; "West"; "N-W"]
 
-(*** define-output:polar1 ***)
+(*** define-output:windrose1 ***)
 [
     Chart.WindRose (r   ,t,Name="11-14 m/s")
     Chart.WindRose (r'  ,t,Name="8-11 m/s")
     Chart.WindRose (r'' ,t,Name="5-8 m/s")
     Chart.WindRose (r''',t,Name="< 5 m/s")
 ]
 |> Chart.Combine
-(*** include-it:polar1 ***)
-|> Chart.Show
+(*** include-it:windrose1 ***)
+
 
 

docs/tools/templates/template.cshtml

@@ -49,8 +49,8 @@
               <li><a href="@Root/bubble-charts.html">Bubble Charts</a></li>
               <li><a href="@Root/contour-plots.html">Contour Plots</a></li>
               <li><a href="@Root/heatmaps.html">Heatmaps</a></li>
-              @*<li><a href="@Root/histograms.html">Histograms</a></li>
-              <li><a href="@Root/2d-histograms.html">2D Histograms</a></li>*@  
+              <li><a href="@Root/histograms.html">Histograms</a></li>
+              <li><a href="@Root/2d-histograms.html">2D Histograms</a></li>
               <li><a href="@Root/line-scatter-plots.html">Line and Scatter Plots</a></li>                          
               <li><a href="@Root/pie-daughnut-charts.html">Pie and Doughnut Charts</a></li>
               <li><a href="@Root/polar-charts.html">Polar Charts</a></li>
@@ -60,6 +60,7 @@
               <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-mesh-plots.html">3D MEsh 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

@@ -387,7 +387,7 @@ type Chart =
         |> GenericChart.ofTraceObject
 
      /// Computes the bi-dimensional histogram of two data samples and auto-determines the bin size.
-    static member Histogram2d(x,y,?Z,?Name,?Colorscale,?Showscale,?zSmooth,?Colorbar,?zAuto,?zMin,?zMax,?nBinsx,?nBinsy,?Xbins,?Ybins,?HistNorm,?HistFunc) =         
+    static member Histogram2d(x,y,?Z,?Name,?Showlegend,?Colorscale,?Showscale,?zSmooth,?Colorbar,?zAuto,?zMin,?zMax,?nBinsx,?nBinsy,?Xbins,?Ybins,?HistNorm,?HistFunc) =         
         Trace.initHistogram2d (
             TraceStyle.Histogram2d (X=x, Y=y,? Z=Z,
                                 ?Colorscale=Colorscale,?Showscale=Showscale,?zSmooth=zSmooth,?Colorbar=Colorbar) )

src/FSharp.Plotly/Contours.fs

@@ -99,6 +99,32 @@ type Contours () =
             )
 
 
+    // Initialized x-y-z-Contours with the same properties    
+    static member initXyz
+        (
+            ?Show           ,
+            //?Project      ,
+            ?Color,
+            ?Usecolor       ,
+            ?Width          ,
+            ?Highlight      ,
+            ?Highlightcolor ,
+            ?Highlightwidth 
+                
+        ) =
+            Contours () 
+            |> Contours.styleXyz
+                (
+                    ?Show=Show                    ,
+                    //?Project                      ,
+                    ?Color=Color                  ,
+                    ?Usecolor=Usecolor            ,
+                    ?Width=Width                  ,
+                    ?Highlight=Highlight          ,
+                    ?Highlightcolor=Highlightcolor,
+                    ?Highlightwidth=Highlightwidth 
+                )
+
     // Applies the styles to Contours()
     //[<CompiledName("styleXyz")>]
     static member styleXyz