Docs: Area - bar - box plot charts

muehlhaus · muehlhaus · commit f52ba5258027 · 2016-06-20T12:14:55.000+02:00
diff --git a/docs/content/3d-scatter-plots.fsx b/docs/content/3d-scatter-plots.fsx
@@ -20,6 +20,8 @@ let z = [19; 26; 55;]
 (*** define-output:scatter3d_1 ***)
 Chart.Scatter3d(x,y,z,StyleOption.Mode.Markers)
 |> Chart.withX_AxisStyle("my x-axis")
+|> Chart.withY_AxisStyle("my y-axis")
+|> Chart.withZ_AxisStyle("my z-axis")
 |> Chart.withSize(800.,800.)
 
 (*** include-it:scatter3d_1 ***)
diff --git a/docs/content/area-plots.fsx b/docs/content/area-plots.fsx
@@ -26,5 +26,5 @@ Chart.Area(x,y)
 (*** define-output:area2 ***)
 Chart.SplineArea(x,y)
 (*** include-it:area2 ***)
-|> Chart.Show
+
 
diff --git a/docs/content/bar-charts.fsx b/docs/content/bar-charts.fsx
@@ -5,22 +5,39 @@
 (** 
 # FSharp.Plotly: Pie and Doughnut Charts
 
-*Summary:* This example shows how to create pie and doughnut charts in F#.
+*Summary:* This example shows how to create bar and a column 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 bar chart or bar graph is a chart that presents grouped data with rectangular bars with 
+lengths proportional to the values that they represent. The bars can be plotted vertically
+or horizontally. A vertical bar chart is called a column bar chart.
 *)
 
 open FSharp.Plotly 
   
-let yValues = [20; 14; 23;]
-let xValues = ["Product A"; "Product B"; "Product C";]
-let labels  = ["27% market share"; "24% market share"; "19% market share";]
-  
-(*** define-output:pie1 ***)
-Chart.Bar(xValues,yValues,Labels=labels,Opacity=0.3,Marker=Options.Marker(Color="rgba(222,45,38,0.8)"))
-|> Chart.withSize(500.,500.)
-(*** include-it:pie1 ***)
-|> Chart.Show
+let values = [20; 14; 23;]
+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)"))
+(*** include-it:bar1 ***)
+
+(*** define-output:bar2 ***)
+Chart.Bar(keys,values)
+(*** include-it:bar2 ***)
+
+
+(** 
+
+## Stacked bar chart or column charts
+The following example shows how to create a stacked bar chart by combining bar charts created by  `Chart.StackedBar` 
+*)
+
 
+(*** define-output:bar3 ***)
+[
+    Chart.StackedBar(keys,values,Name="old");
+    Chart.StackedBar(keys,[8; 21; 13;],Name="new")
+]
+|> Chart.Combine
+(*** include-it:bar3 ***)
diff --git a/docs/content/box-plots.fsx b/docs/content/box-plots.fsx
@@ -18,5 +18,4 @@ 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.Show
 (*** include-it:box1 ***)
diff --git a/docs/tools/formatters.fsx b/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 760 500 ch
+        let html = GenericChart.toChartHtmlWithSize 500 500 ch
         Some [InlineBlock <| html]
 
     | _ -> None 
diff --git a/src/FSharp.Plotly/Chart.fs b/src/FSharp.Plotly/Chart.fs
@@ -199,88 +199,91 @@ type Chart =
             TraceObjects.Scatter()
             |> Options.Scatter(X = x,Y = y, Mode = mode',Fill=StyleOption.ToZero_y)               
             |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
-            |> Options.ILine(Options.Line(?Color=Color,?Dash=Dash,?Width=Width,?Smoothing=Smoothing))
+            |> Options.ILine(Options.Line(Shape=StyleOption.Shape.Spline,?Color=Color,?Dash=Dash,?Width=Width,?Smoothing=Smoothing))
             |> Options.IMarker(Options.Marker(?Color=Color,?Symbol=MarkerSymbol))
             |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
         GenericChart.Chart (trace,None) 
 
 
 
-//    /// Illustrates comparisons among individual items
-//    static member Bar(x, y, ?Name,?Showlegend,?Color,?Opacity,?Labels,?Marker) = 
-//        let marker =
-//            match Marker with 
-//            | Some m -> Options.Marker(?Color=Color) >> m
-//            | None   -> Options.Marker(?Color=Color)
-//        let trace = 
-//            Bar()
-//            |> Options.Bar(X = x,Y = y,
-//                TraceOptions=Options.Trace(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity),
-//                Marker=marker,
-//                ?Text=Labels)
-//        GenericChart.Chart (trace,None)
-//
-//
-//    /// Displays series of the same chart type as stacked bars.
-//    static member StackedBar(x, y, ?Name,?Showlegend,?Color,?Opacity,?Labels,?Marker) = 
-//        let marker =
-//            match Marker with 
-//            | Some m -> Options.Marker(?Color=Color) >> m
-//            | None   -> Options.Marker(?Color=Color)
-//        let trace = 
-//            Bar()
-//            |> Options.Bar(X = x,Y = y,
-//                TraceOptions=Options.Trace(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity),
-//                Marker=marker,
-//                ?Text=Labels)
-//        
-//        let layout = Options.Layout(Barmode=StyleOption.Barmode.Stack)
-//        GenericChart.Chart (trace,Some [layout])
-//        
-//        
-//        
-//    /// Uses a sequence of columns to compare values across categories.
-//    static member Column(x, y, ?Name,?Showlegend,?Color,?Opacity,?Labels,?Marker) =  
-//        let marker =
-//            match Marker with 
-//            | Some m -> Options.Marker(?Color=Color) >> m
-//            | None   -> Options.Marker(?Color=Color)
-//        let trace = 
-//            Bar()
-//            |> Options.Bar(X = x,Y = y,
-//                TraceOptions=Options.Trace(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity),
-//                Marker=marker,
-//                ?Text=Labels,Orientation = StyleOption.Orientation.Horizontal)
-//                
-//        GenericChart.Chart (trace,None)
-//
-//    /// Displays series of the same chart type as stacked columns.
-//    static member StackedColumn(x, y, ?Name,?Showlegend,?Color,?Opacity,?Labels,?Marker) = 
-//        let marker =
-//            match Marker with 
-//            | Some m -> Options.Marker(?Color=Color) >> m
-//            | None   -> Options.Marker(?Color=Color)
-//        let trace = 
-//            Bar()
-//            |> Options.Bar(X = x,Y = y,
-//                TraceOptions=Options.Trace(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity),
-//                Marker=marker,
-//                ?Text=Labels,Orientation = StyleOption.Orientation.Horizontal)
-//        
-//        let layout = Options.Layout(Barmode=StyleOption.Barmode.Stack)
-//        GenericChart.Chart (trace,Some [layout])
-//
-//    /// Displays the distribution of data based on the five number summary: minimum, first quartile, median, third quartile, and maximum.            
-//    static member BoxPlot(?x,?y,?Name,?Showlegend, ?Color,?Opacity,?Whiskerwidth,?Boxpoints,?Boxmean,?Jitter,?Pointpos,?Line,?Marker) = 
-//        let trace = 
-//            Box()
-//            |> Options.BoxPlot(?X=x, ?Y = y,
-//                TraceOptions=Options.Trace(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity),
-//                ?Line=Line,?Marker=Marker,
-//                ?Fillcolor=Color,?Whiskerwidth=Whiskerwidth,?Boxpoints=Boxpoints,
-//                ?Boxmean=Boxmean,?Jitter=Jitter,?Pointpos=Pointpos)
-//            
-//        GenericChart.Chart (trace,None)
+    /// Illustrates comparisons among individual items
+    static member Column(keys, values, ?Name,?Showlegend,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Marker) = 
+        let marker =
+            match Marker with 
+            | Some m -> Options.Marker(?Color=Color) >> m
+            | None   -> Options.Marker(?Color=Color)
+        let trace = 
+            Bar()
+            |> Options.Bar(X = keys,Y = values)
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            |> Options.IMarker(marker)
+            |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        GenericChart.Chart (trace,None)
+
+
+    /// Displays series of tcolumn chart type as stacked columns.
+    static member StackedColumn(keys, values, ?Name,?Showlegend,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Marker) =            
+        let marker =
+            match Marker with 
+            | Some m -> Options.Marker(?Color=Color) >> m
+            | None   -> Options.Marker(?Color=Color)
+        let trace = 
+            Bar()
+            |> Options.Bar(X = keys,Y = values)
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            |> Options.IMarker(marker)
+            |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        let layout = 
+            Options.Layout(Barmode=StyleOption.Barmode.Stack)
+        GenericChart.Chart (trace,None)
+        |>  GenericChart.addLayout layout
+
+    /// Illustrates comparisons among individual items
+    static member Bar(keys, values, ?Name,?Showlegend,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Marker) = 
+        let marker =
+            match Marker with 
+            | Some m -> Options.Marker(?Color=Color) >> m
+            | None   -> Options.Marker(?Color=Color)
+        let trace = 
+            Bar()
+            |> Options.Bar(X = values,Y = keys,Orientation = StyleOption.Orientation.Horizontal)
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            |> Options.IMarker(marker)
+            |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        GenericChart.Chart (trace,None)
+
+
+    /// Displays series of tcolumn chart type as stacked bars.
+    static member StackedBar(keys, values, ?Name,?Showlegend,?Color,?Opacity,?Labels,?TextPosition,?TextFont,?Marker) = 
+        let marker =
+            match Marker with 
+            | Some m -> Options.Marker(?Color=Color) >> m
+            | None   -> Options.Marker(?Color=Color)
+        
+        let trace = 
+            Bar()
+            |> Options.Bar(X = values,Y = keys,Orientation = StyleOption.Orientation.Horizontal)
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+            |> Options.IMarker(marker)
+            |> Options.ITextLabel(?Text=Labels,?Textposition=TextPosition,?Textfont=TextFont)
+        
+        let layout = 
+            Options.Layout(Barmode=StyleOption.Barmode.Stack)
+        GenericChart.Chart (trace,None)
+        |>  GenericChart.addLayout layout
+
+
+
+    /// Displays the distribution of data based on the five number summary: minimum, first quartile, median, third quartile, and maximum.            
+    static member BoxPlot(?x,?y,?Name,?Showlegend, ?Color,?Opacity,?Whiskerwidth,?Boxpoints,?Boxmean,?Jitter,?Pointpos,?Orientation) = 
+        let trace = 
+            Box()
+            |> Options.BoxPlot(?X=x, ?Y = y,
+                ?Whiskerwidth=Whiskerwidth,?Boxpoints=Boxpoints,
+                ?Boxmean=Boxmean,?Jitter=Jitter,?Pointpos=Pointpos,?Orientation=Orientation,?Fillcolor=Color)            
+            |> Options.ITraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)          
+
+        GenericChart.Chart (trace,None)
 
     /// Shows a graphical representation of a 3-dimensional surface by plotting constant z slices, called contours, on a 2-dimensional format.
     /// That is, given a value for z, lines are drawn for connecting the (x,y) coordinates where that z value occurs.
@@ -313,7 +316,8 @@ type Chart =
 //                    Marker=Options.Marker(?Color=Color),
 //                    ?Textinfo=Textinfo,?Textposition=Textposition)                
 //        GenericChart.Chart (trace,None)
-//
+
+
 //    /// Shows how proportions of data, shown as pie-shaped pieces, contribute to the data as a whole.
 //    static member Doughnut(values,?labels,?Name,?Showlegend,?Color,?Hole,?Hoverinfo,?Textinfo,?Textposition) =         
 //        let hole' = if Hole.IsSome then Hole.Value else 0.4
diff --git a/src/FSharp.Plotly/Options.fs b/src/FSharp.Plotly/Options.fs
@@ -193,44 +193,29 @@ type Options() =
     // Applies the styles to Bar()
     static member Bar
         (   
-            //plotType: string, 
-            ?TraceOptions:TraceOptions<_>, 
-            // data
             ?X      : seq<#IConvertible>,
-            ?Y      : seq<#IConvertible>,
-            ?Text   : seq<#IConvertible>,
-                                 
+            ?Y      : seq<#IConvertible>,                                 
             ?Marker: MarkerOptions,            
             ?R: _, ?T: _,
             ?Error_y: ErrorOptions,
             ?Error_x: ErrorOptions,
             // 
             ?Orientation
         ) =
-            (fun (bar:('T :> Bar)) -> 
-                //bar.set_type plotType                     
-
+            (fun (bar:('T :> Bar)) ->       
                 X            |> Option.iter bar.set_x
-                Y            |> Option.iter bar.set_y
-//                Text         |> Option.iter bar.set_text -- temporarily
-                //form scattern --> textposition |> Option.iter (StyleOption.TextPosition.toString >> bar.set_textposition)
-                //form scattern --> mode         |> Option.iter (StyleOption.Mode.toString >> bar.set_mode)
-                //form scattern --> connectgaps  |> Option.iter bar.set_connectgaps
-                //form scattern --> fill         |> Option.iter (StyleOption.Fill.toString >> bar.set_fill)
-                //form scattern --> fillcolor    |> Option.iter bar.set_fillcolor                    
+                Y            |> Option.iter bar.set_y    
                 R            |> Option.iter bar.set_r
                 T            |> Option.iter bar.set_t
                 Orientation  |> Option.iter (StyleOption.Orientation.convert >> bar.set_orientation)
                     
-                // Update
-                //form scattern --> line         |> Option.iter (updatePropertyValueAndIgnore bar <@ bar.line     @>)
-                Marker       |> Option.iter (updatePropertyValueAndIgnore bar <@ bar.marker   @>)
-                //form scattern --> textfont     |> Option.iter (updatePropertyValueAndIgnore bar <@ bar.textfont @>)
+                // Update                
+                Marker       |> Option.iter (updatePropertyValueAndIgnore bar <@ bar.marker   @>)                
                 Error_x      |> Option.iter (updatePropertyValueAndIgnore bar <@ bar.error_x  @>)
                 Error_y      |> Option.iter (updatePropertyValueAndIgnore bar <@ bar.error_y  @>)
                     
                 // out ->
-                bar |> (optApply TraceOptions) 
+                bar
 
             ) 
 
@@ -608,12 +593,10 @@ type Options() =
     // Applies the styles to Pie()
     static member Pie
         (                
-            ?TraceOptions:TraceOptions<_>,
             ?Values,
             ?Labels,
             ?Label0,
             ?dLabel,   
-            ?Marker,
             ?Scalegroup,
             ?Textinfo,
             ?Textfont: FontOptions,                    
@@ -650,20 +633,19 @@ type Options() =
                 Pullsrc         |> Option.iter pie.set_pullsrc        
                 
                 // Update
-                Marker          |> Option.iter (updatePropertyValueAndIgnore pie <@ pie.marker          @>)
+                //Marker          |> Option.iter (updatePropertyValueAndIgnore pie <@ pie.marker          @>)
                 Textfont        |> Option.iter (updatePropertyValueAndIgnore pie <@ pie.textfont        @>)
                 Insidetextfont  |> Option.iter (updatePropertyValueAndIgnore pie <@ pie.insidetextfont  @>)
                 Outsidetextfont |> Option.iter (updatePropertyValueAndIgnore pie <@ pie.outsidetextfont @>)
                     
                 // out ->
-                pie |> (optApply TraceOptions) 
+                pie
             ) 
 
 
     // Applies the styles to Box()
     static member BoxPlot
-        (                
-            ?TraceOptions:TraceOptions<_>,
+        (                            
             ?Y,           
             ?X,           
             ?X0,          
@@ -674,8 +656,6 @@ type Options() =
             ?Jitter,      
             ?Pointpos,    
             ?Orientation, 
-            ?Line         : LineOptions,                         
-            ?Marker       : MarkerOptions,
             ?Fillcolor,   
             ?xAxis,       
             ?yAxis,       
@@ -700,12 +680,9 @@ type Options() =
                 yAxis        |> Option.iter boxPlot.set_yaxis       
                 Ysrc         |> Option.iter boxPlot.set_ysrc        
                 Xsrc         |> Option.iter boxPlot.set_xsrc        
-                // Update
-                Line         |> Option.iter (updatePropertyValueAndIgnore boxPlot <@ boxPlot.line   @>)
-                Marker       |> Option.iter (updatePropertyValueAndIgnore boxPlot <@ boxPlot.marker @>)
                 
                 // out ->
-                boxPlot |> (optApply TraceOptions) 
+                boxPlot
             ) 
   
     // Applies the styles to TraceObjects with IMapZ interface
diff --git a/src/FSharp.Plotly/TraceObjects.fs b/src/FSharp.Plotly/TraceObjects.fs
@@ -1298,6 +1298,15 @@ module TraceObjects =
             with get () = Option.get _marker
             and set value = _marker <- Some value
          member __.ShouldSerializemarker() = not _marker.IsNone
+        
+
+        interface ITrace with 
+            member __.``type``
+                with get () = Option.get _type
+                and set value = _type <- Some value
+
+            member __.ShouldSerializetype() = not _type.IsNone        
+        
         interface ITraceInfo with
             /// Sets the trace name. The trace name appear as the legend item and on hover.
             member __.name
