make scatterpolar use own attributes and defaults

Author: etpinard

src/traces/scatterpolar/index.js

@@ -25,10 +25,10 @@ module.exports = {
     meta: {
         hrName: 'scatter_polar',
         description: [
-            'The scatterpolar trace type encompasses line charts, scatter charts, text charts, and bubble charts.',
+            'The scatterpolar trace type encompasses line charts, scatter charts, text charts, and bubble charts',
             'in polar coordinates.',
             'The data visualized as scatter point or lines is set in',
-            '`r` (radial) and `theta` (angular). coordintes',
+            '`r` (radial) and `theta` (angular) coordinates',
             'Text (appearing either on the chart or on hover only) is via `text`.',
             'Bubble charts are achieved by setting `marker.size` and/or `marker.color`',
             'to numerical arrays.'

src/traces/scatterpolargl/attributes.js

@@ -0,0 +1,37 @@
+/**
+* Copyright 2012-2018, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var scatterPolarAttrs = require('../scatterpolar/attributes');
+var scatterGlAttrs = require('../scattergl/attributes');
+
+module.exports = {
+    mode: scatterPolarAttrs.mode,
+    r: scatterPolarAttrs.r,
+    theta: scatterPolarAttrs.theta,
+    thetaunit: scatterPolarAttrs.thetaunit,
+
+    text: scatterPolarAttrs.text,
+    // no hovertext
+
+    line: scatterGlAttrs.line,
+    connectgaps: scatterGlAttrs.connectgaps,
+
+    marker: scatterGlAttrs.marker,
+    // no cliponaxis
+
+    fill: scatterGlAttrs.fill,
+    fillcolor: scatterGlAttrs.fillcolor,
+
+    hoverinfo: scatterPolarAttrs.hoverinfo,
+    hoveron: scatterPolarAttrs.hoveron,
+
+    selected: scatterPolarAttrs.selected,
+    unselected: scatterPolarAttrs.unselected
+};

src/traces/scatterpolargl/defaults.js

@@ -0,0 +1,65 @@
+/**
+* Copyright 2012-2018, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var Lib = require('../../lib');
+
+var subTypes = require('../scatter/subtypes');
+var handleMarkerDefaults = require('../scatter/marker_defaults');
+var handleLineDefaults = require('../scatter/line_defaults');
+var handleFillColorDefaults = require('../scatter/fillcolor_defaults');
+var PTS_LINESONLY = require('../scatter/constants').PTS_LINESONLY;
+
+var attributes = require('./attributes');
+
+module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
+    function coerce(attr, dflt) {
+        return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
+    }
+
+    var r = coerce('r');
+    var theta = coerce('theta');
+    var len = (r && theta) ? Math.min(r.length, theta.length) : 0;
+
+    if(!len) {
+        traceOut.visible = false;
+        return;
+    }
+
+    if(len < r.length) traceOut.r = r.slice(0, len);
+    if(len < theta.length) traceOut.theta = theta.slice(0, len);
+
+    coerce('thetaunit');
+    coerce('mode', len < PTS_LINESONLY ? 'lines+markers' : 'lines');
+    coerce('text');
+
+    if(subTypes.hasLines(traceOut)) {
+        handleLineDefaults(traceIn, traceOut, defaultColor, layout, coerce);
+        coerce('connectgaps');
+    }
+
+    var dfltHoverOn = [];
+
+    if(subTypes.hasMarkers(traceOut)) {
+        handleMarkerDefaults(traceIn, traceOut, defaultColor, layout, coerce);
+        dfltHoverOn.push('points');
+    }
+
+    coerce('fill');
+    if(traceOut.fill !== 'none') {
+        handleFillColorDefaults(traceIn, traceOut, defaultColor, coerce);
+    }
+
+    if(traceOut.fill === 'tonext' || traceOut.fill === 'toself') {
+        dfltHoverOn.push('fills');
+    }
+    coerce('hoveron', dfltHoverOn.join('+') || 'points');
+
+    Lib.coerceSelectionMarkerOpacity(traceOut, coerce);
+};

src/traces/scatterpolargl/index.js

@@ -15,7 +15,6 @@ var Axes = require('../../plots/cartesian/axes');
 var kdtree = require('kdgrass');
 var Lib = require('../../lib');
 
-
 function calc(container, trace) {
     var layout = container._fullLayout;
     var subplotId = trace.subplot;
@@ -202,17 +201,14 @@ function hoverPoints(pointData, xval, yval, hovermode) {
     return scatterPointData;
 }
 
-
 module.exports = {
     moduleType: 'trace',
     name: 'scatterpolargl',
     basePlotModule: require('../../plots/polar'),
     categories: ['gl', 'regl', 'polar', 'symbols', 'markerColorscale', 'showLegend', 'scatter-like'],
 
-    // TODO scatterpolargl won't support text
-    // should have its own attributes and defaults
-    attributes: require('../scatterpolar/attributes'),
-    supplyDefaults: require('../scatterpolar/defaults'),
+    attributes: require('./attributes'),
+    supplyDefaults: require('./defaults'),
 
     calc: calc,
     plot: plot,
@@ -223,13 +219,10 @@ module.exports = {
     meta: {
         hrName: 'scatter_polar_gl',
         description: [
-            '!!! GL VERSION OF SCATTERPOLAR !!!',
-
-            'The scatterpolar trace type encompasses line charts, scatter charts, text charts, and bubble charts.',
-            'in polar coordinates.',
+            'The scatterpolargl trace type encompasses line charts, scatter charts, and bubble charts',
+            'in polar coordinates using the WebGL plotting engine.',
             'The data visualized as scatter point or lines is set in',
-            '`r` (radial) and `theta` (angular). coordintes',
-            'Text (appearing either on the chart or on hover only) is via `text`.',
+            '`r` (radial) and `theta` (angular) coordinates',
             'Bubble charts are achieved by setting `marker.size` and/or `marker.color`',
             'to numerical arrays.'
         ].join(' ')