Merge pull request #5447 from plotly/deprecate_gl2d_traces

Add deprecated warnings for pointcloud and heatmapgl
plotly · Jan 28, 2021 · 3f0ee0c · 3f0ee0c
2 parents 6fcbc75 + a96ef51
commit 3f0ee0c
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/traces/heatmapgl/index.js b/src/traces/heatmapgl/index.js
@@ -1,5 +1,12 @@
 'use strict';
 
+var deprecationWarning = [
+    '*heatmapgl* trace is deprecated!',
+    'Please consider switching to the *heatmap* or *image* trace types.',
+    'Alternatively you could contribute/sponsor rewriting this trace type',
+    'based on cartesian features and using regl framework.'
+].join(' ');
+
 module.exports = {
     attributes: require('./attributes'),
     supplyDefaults: require('./defaults'),
@@ -14,6 +21,7 @@ module.exports = {
     categories: ['gl', 'gl2d', '2dMap'],
     meta: {
         description: [
+            deprecationWarning,
             'WebGL version of the heatmap trace type.'
         ].join(' ')
     }

diff --git a/src/traces/pointcloud/index.js b/src/traces/pointcloud/index.js
@@ -1,5 +1,10 @@
 'use strict';
 
+var deprecationWarning = [
+    '*pointcloud* trace is deprecated!',
+    'Please consider switching to the *scattergl* trace type.'
+].join(' ');
+
 module.exports = {
     attributes: require('./attributes'),
     supplyDefaults: require('./defaults'),
@@ -14,6 +19,7 @@ module.exports = {
     categories: ['gl', 'gl2d', 'showLegend'],
     meta: {
         description: [
+            deprecationWarning,
             'The data visualized as a point cloud set in `x` and `y`',
             'using the WebGl plotting engine.'
         ].join(' ')