Add Wind Rose chart and docs

Author: muehlhaus

FSharp.Plotly.sln

@@ -47,6 +47,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{8E6D
 		docs\content\polar-charts.fsx = docs\content\polar-charts.fsx
 		docs\content\range-plots.fsx = docs\content\range-plots.fsx
 		docs\content\shapes.fsx = docs\content\shapes.fsx
+		docs\content\windrose-charts.fsx = docs\content\windrose-charts.fsx
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{ED8079DD-2B06-4030-9F0F-DC548F98E1C4}"

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

@@ -26,7 +26,7 @@ let x,y,z =
 
 
 (*** define-output:scatter3d_line_1 ***)
-Chart.Scatter3d(x,y,z,StyleOption.Mode.Lines_Markers)
+Chart.Scatter3d(x,y,z,StyleParam.Mode.Lines_Markers)
 |> Chart.withX_AxisStyle("x-axis")
 |> Chart.withY_AxisStyle("y-axis")
 |> Chart.withZ_AxisStyle("z-axis")

docs/content/bar-charts.fsx

@@ -19,8 +19,9 @@ let keys   = ["Product A"; "Product B"; "Product C";]
 let labels = ["27% market share"; "24% market share"; "19% market share";]
 
 (*** define-output:bar1 ***)
-Chart.Column(keys,values,Labels=labels,Opacity=0.3,Marker=Options.Marker(Color="rgba(222,45,38,0.8)",Size=1)) // Changing the thickness of the bar is not possible at the moment
+Chart.Column(keys,values,Labels=labels,Opacity=0.3,Marker=Marker.init(Marker.style (Color="rgba(222,45,38,0.8)",Size=1))) // Changing the thickness of the bar is not possible at the moment
 (*** include-it:bar1 ***)
+|> Chart.Show
 
 (*** define-output:bar2 ***)
 Chart.Bar(keys,values)
@@ -43,4 +44,3 @@ The following example shows how to create a stacked bar chart by combining bar c
 (*** include-it:bar3 ***)
 |> Chart.Show
 
-FSharp.Plotly.

docs/content/box-plots.fsx

@@ -19,14 +19,14 @@ 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.1,Boxpoints=StyleOption.Boxpoints.All)
+Chart.BoxPlot(x,y,Jitter=0.1,Boxpoints=StyleParam.Boxpoints.All)
 (*** include-it:box1 ***)
 
 (**
-By swapping x and y plus using `StyleOption.Orientation.Horizontal` we can flip the chart horizontaly.
+By swapping x and y plus using `StyleParam.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)
+Chart.BoxPlot(y,x,Jitter=0.1,Boxpoints=StyleParam.Boxpoints.All,Orientation=StyleParam.Orientation.Horizontal)
 (*** include-it:box2 ***)
 
 
@@ -39,8 +39,8 @@ 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.
 
 (*** 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.BoxPlot("y" ,y,Name="bin1",Jitter=0.1,Boxpoints=StyleParam.Boxpoints.All);
+    Chart.BoxPlot("y'",y',Name="bin2",Jitter=0.1,Boxpoints=StyleParam.Boxpoints.All);
 ]
 |> Chart.Combine
 (*** include-it:box3 ***)

docs/content/line-scatter-plots.fsx

@@ -22,7 +22,7 @@ let y' = [2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1.]
 
 (*** define-output:line1 ***)
 Chart.Line(x,y',Name="line")    
-|> Chart.withLineStyle(Width=2,Dash=StyleOption.DrawingStyle.Dot)
+|> Chart.withLineStyle(Width=2,Dash=StyleParam.DrawingStyle.Dot)
 (*** include-it:line1 ***)
 
 (** 
@@ -43,8 +43,8 @@ shown below.
 
 (*** define-output:line3 ***)
 Chart.Spline(x,y',Name="spline")    
-|> Chart.withLineStyle(Width=2,Dash=StyleOption.DrawingStyle.Dot)
-|> Chart.withLineStyle(Width=6,Dash=StyleOption.DrawingStyle.Dot)
+|> Chart.withLineStyle(Width=2,Dash=StyleParam.DrawingStyle.Dot)
+|> Chart.withLineStyle(Width=6,Dash=StyleParam.DrawingStyle.Dot)
 (*** include-it:line3 ***)
 
 
@@ -60,16 +60,15 @@ If `TextPosition` is set the labels are drawn otherwise only shown when hovering
 let l  = ["a";"b";"c";"d";"e";"f";"g";"h";"i";"j";]
 
 (*** define-output:pointsWithLabels ***)
-Chart.Point(x,y',Name="points",Labels=l,TextPosition=StyleOption.TextPosition.TopRight)    
+Chart.Point(x,y',Name="points",Labels=l,TextPosition=StyleParam.TextPosition.TopRight)    
 (*** include-it:pointsWithLabels ***)
 |> Chart.Show
 
 
 
-
-(*** define-output:pointsWithErrorBars ***)
-Chart.Point(x,y',Name="points with errors")    
-|> Chart.withXError(Options.Error(Array=[|0.2;0.3;0.2;0.1;0.2;0.4;0.2;0.08;0.2;0.1;|]))
-|> Chart.withYError(Options.Error(Array=[|0.3;0.2;0.1;0.4;0.2;0.4;0.1;0.18;0.02;0.2;|]))
-(*** include-it:pointsWithErrorBars ***)
-|> Chart.Show
+//(*** define-output:pointsWithErrorBars ***)
+//Chart.Point(x,y',Name="points with errors")    
+//|> Chart.withXError(Options.Error(Array=[|0.2;0.3;0.2;0.1;0.2;0.4;0.2;0.08;0.2;0.1;|]))
+//|> Chart.withYError(Options.Error(Array=[|0.3;0.2;0.1;0.4;0.2;0.4;0.1;0.18;0.02;0.2;|]))
+//(*** include-it:pointsWithErrorBars ***)
+//|> Chart.Show

docs/content/polar-charts.fsx

@@ -3,24 +3,32 @@
 #r "../../bin/FSharp.Plotly.dll"
 
 (** 
-# FSharp.Plotly: Pie and Doughnut Charts
+# FSharp.Plotly: Polar chart
 
-*Summary:* This example shows how to create pie and doughnut charts in F#.
+*Summary:* This example shows how to create polar 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 polar chart is a graphical method of displaying multivariate data in the form of a two-dimensional chart 
+of three or more quantitative variables represented on axes starting from the same point.
+The relative position and angle of the axes is typically uninformative.
 *)
 
 open FSharp.Plotly 
 
-let values = [19; 26; 55;]
-let labels = ["Residential"; "Non-Residential"; "Utility"]
+let r   = [1; 2; 3; 4; 5; 6; 7;]
+let r'  = [ 5; 6; 7; 1; 2; 3; 4;]
+let r'' = [ 3; 1; 5; 2; 8; 7; 5;]
+
+
+let t  = [0; 45; 90; 135; 200; 320; 184;]
 
-(*** define-output:pie1 ***)
-Chart.Pie(values,labels)
-(*** include-it:pie1 ***)
+(*** define-output:polar1 ***)
+[
+    Chart.Polar(r,t,StyleParam.Mode.Markers,Name="1")
+    Chart.Polar(r',t,StyleParam.Mode.Markers,Name="2")
+    Chart.Polar(r'',t,StyleParam.Mode.Markers,Name="3")
+]
+|> Chart.Combine
+(*** include-it:polar1 ***)
+|> Chart.Show
+
 
-(*** define-output:doughnut1 ***)
-Chart.Doughnut(values,labels,hole=0.3)
-(*** include-it:doughnut1 ***)

docs/content/shapes.fsx

@@ -1,4 +1,4 @@
-(*** hide ***)
+(*** side ***)
 #r "../../bin/Newtonsoft.Json.dll"
 #r "../../bin/FSharp.Plotly.dll"
 
@@ -14,12 +14,19 @@ open FSharp.Plotly
 let x  = [1.; 2.; 3.; 4.; 5.; 6.; 7.; 8.; 9.; 10.; ]
 let y' = [2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1.]
 
-let s1 = Shape.init (Shape.ShapeStyle.Shape(StyleParam.ShapeType.Rectangle,2.,4.,3.,4.,Opacity=0.3,Fillcolor="#d3d3d3") )
-let s2 = Shape.init (Shape.ShapeStyle.Shape(StyleParam.ShapeType.Rectangle,5.,7.,3.,4.,Opacity=0.3,Fillcolor="#d3d3d3") )
+let s1 = 
+    Shape.init 
+        ( Shape.style
+            ( StyleParam.ShapeType.Rectangle,2.,4.,3.,4.,Opacity=0.3,Fillcolor="#d3d3d3" ) 
+        )
+let s2 = 
+    Shape.init 
+        ( Shape.style
+            ( StyleParam.ShapeType.Rectangle,5.,7.,3.,4.,Opacity=0.3,Fillcolor="#d3d3d3" )
+        )
 (*** define-output:line1 ***)
 Chart.Line(x,y',Name="line")    
-//|> Chart.withShape(Options.Shape(StyleOption.ShapeType.Rectangle,2.,4.,3.,4.,Opacity=0.3,Fillcolor="#d3d3d3"))
+//|> Chart.withShape(Options.Shape(StyleParam.ShapeType.Rectangle,2.,4.,3.,4.,Opacity=0.3,Fillcolor="#d3d3d3"))
 |> Chart.withShapes([s1;s2])
 (*** include-it:line1 ***)
-|> Chart.Show
 

docs/content/windrose-charts.fsx

@@ -0,0 +1,34 @@
+(*** hide ***)
+#r "../../bin/Newtonsoft.Json.dll"
+#r "../../bin/FSharp.Plotly.dll"
+
+(** 
+# FSharp.Plotly: Wind Rose chart
+
+*Summary:* This example shows how to create wind rose charts in F#.
+
+A wind rose is a graphic tool used by meteorologists to give a succinct view 
+of how wind speed and direction are typically distributed at a particular location.
+*)
+
+open FSharp.Plotly 
+  
+let r    = [77.5; 72.5; 70.0; 45.0; 22.5; 42.5; 40.0; 62.5]
+let r'   = [57.5; 50.0; 45.0; 35.0; 20.0; 22.5; 37.5; 55.0]
+let r''  = [40.0; 30.0; 30.0; 35.0; 7.5; 7.5; 32.5; 40.0]
+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 ***)
+[
+    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
+
+

docs/tools/templates/template.cshtml

@@ -54,6 +54,7 @@
               <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>
+              <li><a href="@Root/windrose-charts.html">Polar Charts</a></li>
               <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>