Add HeatMapGL

Author: Jonathan Ott

src/Plotly.NET/Chart.fs

@@ -1082,6 +1082,13 @@ type Chart =
                         ?Scalegroup=Scalegroup,?Scalemode=Scalemode,?Side=Side,?Span=Span,?SpanMode=SpanMode,?Uirevision=Uirevision
             ) 
 
+    static member private renderHeatmapTrace (useWebGL:bool) (style: Trace -> Trace) =
+        if useWebGL then
+            Trace.initHeatmapGL style
+            |> GenericChart.ofTraceObject
+        else
+            Trace.initHeatmap style
+            |> GenericChart.ofTraceObject
 
     /// 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.
@@ -1096,11 +1103,17 @@ type Chart =
             [<Optional;DefaultParameterValue(null)>] ?Xgap,
             [<Optional;DefaultParameterValue(null)>] ?Ygap,
             [<Optional;DefaultParameterValue(null)>] ?zSmooth,
-            [<Optional;DefaultParameterValue(null)>] ?Colorbar) = 
-        Trace.initHeatmap (TraceStyle.Heatmap(Z=data,?X=ColNames, ?Y=RowNames,
-                                ?Xgap=Xgap,?Ygap=Ygap,?Colorscale=Colorscale,?Showscale=Showscale,?zSmooth=zSmooth,?Colorbar=Colorbar) )
-        |> TraceStyle.TraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)   
-        |> GenericChart.ofTraceObject
+            [<Optional;DefaultParameterValue(null)>] ?Colorbar,
+            [<Optional;DefaultParameterValue(false)>]?UseWebGL : bool)
+            = 
+        let style =
+            TraceStyle.Heatmap(Z=data,?X=ColNames, ?Y=RowNames,
+                                    ?Xgap=Xgap,?Ygap=Ygap,?Colorscale=Colorscale,?Showscale=Showscale,?zSmooth=zSmooth,?Colorbar=Colorbar)
+            >> TraceStyle.TraceInfo(?Name=Name,?Showlegend=Showlegend,?Opacity=Opacity)
+
+        let useWebGL = defaultArg UseWebGL false
+
+        Chart.renderHeatmapTrace useWebGL style
 
 
     /// Shows a graphical representation of data where the individual values contained in a matrix are represented as colors.

src/Plotly.NET/Playground.fsx

@@ -532,6 +532,27 @@ generateDomainRanges 8 1
 )
 |> Chart.Show
 
+// Heatmap example from Plotly docs: https://plotly.net/2_7_heatmaps.html
+let matrix =
+    [[1.;1.5;0.7;2.7];
+    [2.;0.5;1.2;1.4];
+    [0.1;2.6;2.4;3.0];]
+
+let rownames = ["p3";"p2";"p1"]
+let colnames = ["Tp0";"Tp30";"Tp60";"Tp160"]
+let colorscaleValue = StyleParam.Colorscale.Custom [(0.0,"#3D9970");(1.0,"#001f3f")]
+
+let heat1 =
+    Chart.Heatmap(
+        matrix,colnames,rownames,
+        Colorscale=colorscaleValue,
+        Showscale=true,
+        UseWebGL=true
+    )
+    |> Chart.withSize(700.,500.)
+    |> Chart.withMarginSize(Left=200.)
+    |> Chart.Show
+
 let values,labels = 
     [
     1,"v1"

src/Plotly.NET/Trace.fs

@@ -40,6 +40,10 @@ module Trace =
     let initHeatmap (applyStyle:Trace->Trace) = 
         Trace("heatmap") |> applyStyle
 
+    ///initializes a trace of type "heatmapgl" applying the given trace styling function
+    let initHeatmapGL (applyStyle:Trace->Trace) = 
+        Trace("heatmapgl") |> applyStyle
+
     ///initializes a trace of type "image" applying the given trace styling function
     let initImage (applyStyle:Trace->Trace) = 
          Trace("image") |> applyStyle