Funnel traces

lib/funnel.js

@@ -0,0 +1,11 @@
+/**
+* Copyright 2012-2019, 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';
+
+module.exports = require('../src/traces/funnel');

lib/index-finance.js

@@ -16,6 +16,7 @@ Plotly.register([
     require('./pie'),
     require('./ohlc'),
     require('./candlestick'),
+    require('./funnel'),
     require('./waterfall')
 ]);
 

lib/index.js

@@ -21,6 +21,7 @@ Plotly.register([
     require('./contour'),
     require('./scatterternary'),
     require('./violin'),
+    require('./funnel'),
     require('./waterfall'),
 
     require('./pie'),

src/components/drawing/index.js

@@ -110,9 +110,7 @@ drawing.hideOutsideRangePoints = function(traceGroups, subplot) {
         var trace = d[0].trace;
         var xcalendar = trace.xcalendar;
         var ycalendar = trace.ycalendar;
-        var selector = trace.type === 'bar' ? '.bartext' :
-            trace.type === 'waterfall' ? '.bartext,.line' :
-                '.point,.textpoint';
+        var selector = Registry.traceIs(trace, 'bar-like') ? '.bartext' : '.point,.textpoint';
 
         traceGroups.selectAll(selector).each(function(d) {
             drawing.hideOutsideRangePoint(d, d3.select(this), xa, ya, xcalendar, ycalendar);

src/components/legend/style.js

@@ -84,6 +84,7 @@ module.exports = function style(s, gd) {
             .classed('legendpoints', true);
     })
     .each(styleWaterfalls)
+    .each(styleFunnels)
     .each(styleBars)
     .each(styleBoxes)
     .each(stylePies)
@@ -306,14 +307,25 @@ module.exports = function style(s, gd) {
     }
 
     function styleBars(d) {
+        styleBarFamily(d, this);
+    }
+
+    function styleFunnels(d) {
+        styleBarFamily(d, this, 'funnel');
+    }
+
+    function styleBarFamily(d, lThis, desiredType) {
         var trace = d[0].trace;
         var marker = trace.marker || {};
         var markerLine = marker.line || {};
 
-        var barpath = d3.select(this).select('g.legendpoints')
-            .selectAll('path.legendbar')
-            .data(Registry.traceIs(trace, 'bar') ? [d] : []);
-        barpath.enter().append('path').classed('legendbar', true)
+        var isVisible = (!desiredType) ? Registry.traceIs(trace, 'bar') :
+            (trace.type === desiredType && trace.visible);
+
+        var barpath = d3.select(lThis).select('g.legendpoints')
+            .selectAll('path.legend' + desiredType)
+            .data(isVisible ? [d] : []);
+        barpath.enter().append('path').classed('legend' + desiredType, true)
             .attr('d', 'M6,6H-6V-6H6Z')
             .attr('transform', 'translate(20,0)');
         barpath.exit().remove();

src/plot_api/helpers.js

@@ -328,7 +328,7 @@ exports.cleanData = function(data) {
             trace.scene = Plots.subplotsRegistry.gl3d.cleanId(trace.scene);
         }
 
-        if(!traceIs(trace, 'pie') && !traceIs(trace, 'bar') && trace.type !== 'waterfall') {
+        if(!traceIs(trace, 'pie') && !traceIs(trace, 'bar-like')) {
             if(Array.isArray(trace.textposition)) {
                 for(i = 0; i < trace.textposition.length; i++) {
                     trace.textposition[i] = cleanTextPosition(trace.textposition[i]);

src/plots/cartesian/axes.js

@@ -2813,7 +2813,7 @@ function hasBarsOrFill(gd, ax) {
 
         if(trace.visible === true && (trace.xaxis + trace.yaxis) === subplot) {
             if(
-                (Registry.traceIs(trace, 'bar') || trace.type === 'waterfall') &&
+                Registry.traceIs(trace, 'bar-like') &&
                 trace.orientation === {x: 'h', y: 'v'}[axLetter]
             ) return true;
 

src/plots/cartesian/axis_defaults.js

@@ -37,7 +37,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
     var font = options.font || {};
     var splomStash = options.splomStash || {};
 
-    var visible = coerce('visible', !options.cheateronly);
+    var visible = coerce('visible', !options.visibleDflt);
 
     var axType = containerOut.type;
 
@@ -58,8 +58,6 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
 
     if(axType !== 'category' && !options.noHover) coerce('hoverformat');
 
-    if(!visible) return containerOut;
-
     var dfltColor = coerce('color');
     // if axis.color was provided, use it for fonts too; otherwise,
     // inherit from global font color in case that was provided.
@@ -69,6 +67,9 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
     // try to get default title from splom trace, fallback to graph-wide value
     var dfltTitle = splomStash.label || layoutOut._dfltTitle[letter];
 
+    handleTickLabelDefaults(containerIn, containerOut, coerce, axType, options, {pass: 1});
+    if(!visible) return containerOut;
+
     coerce('title.text', dfltTitle);
     Lib.coerceFont(coerce, 'title.font', {
         family: font.family,
@@ -77,7 +78,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
     });
 
     handleTickValueDefaults(containerIn, containerOut, coerce, axType);
-    handleTickLabelDefaults(containerIn, containerOut, coerce, axType, options);
+    handleTickLabelDefaults(containerIn, containerOut, coerce, axType, options, {pass: 2});
     handleTickMarkDefaults(containerIn, containerOut, coerce, options);
     handleLineGridDefaults(containerIn, containerOut, coerce, {
         dfltColor: dfltColor,

src/plots/cartesian/constants.js

@@ -65,14 +65,21 @@ module.exports = {
     traceLayerClasses: [
         'heatmaplayer',
         'contourcarpetlayer', 'contourlayer',
-        'waterfalllayer', 'barlayer',
+        'funnellayer', 'waterfalllayer', 'barlayer',
         'carpetlayer',
         'violinlayer',
         'boxlayer',
         'ohlclayer',
         'scattercarpetlayer', 'scatterlayer'
     ],
 
+    clipOnAxisFalseQuery: [
+        '.scatterlayer',
+        '.barlayer',
+        '.funnellayer',
+        '.waterfalllayer'
+    ],
+
     layerValue2layerClass: {
         'above traces': 'above',
         'below traces': 'below'

src/plots/cartesian/index.js

@@ -260,7 +260,7 @@ function plotOne(gd, plotinfo, cdSubplot, transitionOpts, makeOnCompleteCallback
         );
 
         // layers that allow `cliponaxis: false`
-        if(className !== 'scatterlayer' && className !== 'barlayer' && className !== 'waterfalllayer') {
+        if(constants.clipOnAxisFalseQuery.indexOf('.' + className) === -1) {
             Drawing.setClipUrl(sel, plotinfo.layerClipId, gd);
         }
     });
@@ -276,7 +276,7 @@ function plotOne(gd, plotinfo, cdSubplot, transitionOpts, makeOnCompleteCallback
     if(!gd._context.staticPlot) {
         if(plotinfo._hasClipOnAxisFalse) {
             plotinfo.clipOnAxisFalseTraces = plotinfo.plot
-                .selectAll('.scatterlayer, .barlayer, .waterfalllayer')
+                .selectAll(constants.clipOnAxisFalseQuery.join(','))
                 .selectAll('.trace');
         }
 

src/plots/cartesian/layout_defaults.js

@@ -28,58 +28,68 @@ var Registry = require('../../registry');
 var traceIs = Registry.traceIs;
 var getComponentMethod = Registry.getComponentMethod;
 
+function skipType(trace) {
+    return !(
+        traceIs(trace, 'cartesian') ||
+        traceIs(trace, 'gl2d')
+    );
+}
+
+function listNames(traceIn, xOy) {
+    var a = traceIn[xOy + 'axis'];
+    var b = traceIn[xOy + 'axes'];
+
+    var list = [];
+    if(a) {
+        list = [a];
+    } else if(b) {
+        list = b;
+    }
+
+    return list;
+}
+
 function appendList(cont, k, item) {
     if(Array.isArray(cont[k])) cont[k].push(item);
     else cont[k] = [item];
 }
 
+function getName(trace, xOy) {
+    return (trace[xOy + 'axis']) ? id2name(trace[xOy + 'axis']) : undefined; // TODO: why these should be left undefined?
+}
+
 module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
     var ax2traces = {};
-    var xaCheater = {};
-    var xaNonCheater = {};
+    var hideX = {};
+    var hideY = {};
     var outerTicks = {};
     var noGrids = {};
     var i, j;
+    var trace;
+    var xaName, yaName;
 
-    // look for axes in the data
-    for(i = 0; i < fullData.length; i++) {
-        var trace = fullData[i];
-        if(!traceIs(trace, 'cartesian') && !traceIs(trace, 'gl2d')) continue;
-
-        var xaName;
-        if(trace.xaxis) {
-            xaName = id2name(trace.xaxis);
-            appendList(ax2traces, xaName, trace);
-        } else if(trace.xaxes) {
-            for(j = 0; j < trace.xaxes.length; j++) {
-                appendList(ax2traces, id2name(trace.xaxes[j]), trace);
-            }
+    function append(list) {
+        for(var k = 0; k < list.length; k++) {
+            appendList(ax2traces, id2name(list[k]), trace);
         }
+    }
 
-        var yaName;
-        if(trace.yaxis) {
-            yaName = id2name(trace.yaxis);
-            appendList(ax2traces, yaName, trace);
-        } else if(trace.yaxes) {
-            for(j = 0; j < trace.yaxes.length; j++) {
-                appendList(ax2traces, id2name(trace.yaxes[j]), trace);
-            }
-        }
+    // create lists
+    for(i = 0; i < fullData.length; i++) {
+        trace = fullData[i];
+        if(skipType(trace)) continue;
 
-        // Two things trigger axis visibility:
-        // 1. is not carpet
-        // 2. carpet that's not cheater
-        if(!traceIs(trace, 'carpet') || (trace.type === 'carpet' && !trace._cheater)) {
-            if(xaName) xaNonCheater[xaName] = 1;
-        }
+        append(listNames(trace, 'x'));
+        append(listNames(trace, 'y'));
+    }
 
-        // The above check for definitely-not-cheater is not adequate. This
-        // second list tracks which axes *could* be a cheater so that the
-        // full condition triggering hiding is:
-        //   *could* be a cheater and *is not definitely visible*
-        if(trace.type === 'carpet' && trace._cheater) {
-            if(xaName) xaCheater[xaName] = 1;
-        }
+    // look for axes in the data
+    for(i = 0; i < fullData.length; i++) {
+        trace = fullData[i];
+        if(skipType(trace)) continue;
+
+        xaName = getName(trace, 'x');
+        yaName = getName(trace, 'y');
 
         // check for default formatting tweaks
         if(traceIs(trace, '2dMap')) {
@@ -93,6 +103,72 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         }
     }
 
+    function includesOnly(desiredType, xaNameIn, yaNameIn) {
+        var result = false;
+        for(var k = 0; k < fullData.length; k++) {
+            var otherTrace = fullData[k];
+            if(skipType(otherTrace)) continue;
+
+            if(
+                xaNameIn !== getName(otherTrace, 'x') ||
+                yaNameIn !== getName(otherTrace, 'y')
+            ) continue;
+
+            var found = false;
+
+            if(desiredType === 'cheater' && traceIs(trace, 'carpet') && trace._cheater !== false) {
+                found = true;
+            } else if(trace.type === desiredType) {
+                found = true;
+            }
+
+            if(!found) {
+                result = false;
+                break;
+            }
+            result = true;
+        }
+        return result;
+    }
+
+    var funnelOnlyX = {};
+    var funnelOnlyY = {};
+    var cheaterOnlyX = {};
+
+    for(i = 0; i < fullData.length; i++) {
+        trace = fullData[i];
+        if(skipType(trace)) continue;
+
+        xaName = getName(trace, 'x');
+        yaName = getName(trace, 'y');
+
+        if(funnelOnlyX[xaName] !== false) funnelOnlyX[xaName] = includesOnly('funnel', xaName, yaName);
+        if(funnelOnlyY[yaName] !== false) funnelOnlyY[yaName] = includesOnly('funnel', xaName, yaName);
+        if(cheaterOnlyX[xaName] !== false) cheaterOnlyX[xaName] = includesOnly('cheater', xaName, yaName);
+    }
+
+    for(i = 0; i < fullData.length; i++) {
+        trace = fullData[i];
+        if(skipType(trace)) continue;
+
+        xaName = getName(trace, 'x');
+        yaName = getName(trace, 'y');
+
+        if(traceIs(trace, 'carpet') && trace._cheater) {
+            if(cheaterOnlyX[xaName] && xaName) hideX[xaName] = 1;
+        }
+
+        if(trace.type === 'funnel') {
+            if(funnelOnlyX[xaName] && trace.orientation === 'h') {
+                hideX[xaName] = 1;
+            }
+
+            if(funnelOnlyY[yaName] && trace.orientation === 'v') {
+                hideY[yaName] = 1;
+            }
+        }
+    }
+
     var subplots = layoutOut._subplots;
     var xIds = subplots.xaxis;
     var yIds = subplots.yaxis;
@@ -176,7 +252,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
             bgColor: bgColor,
             calendar: layoutOut.calendar,
             automargin: true,
-            cheateronly: axLetter === 'x' && xaCheater[axName] && !xaNonCheater[axName],
+            visibleDflt: (axLetter === 'x' && !!hideX[axName]) || (axLetter === 'y' && !!hideY[axName]),
             splomStash: ((layoutOut._splomAxes || {})[axLetter] || {})[id]
         };
 

src/plots/cartesian/tick_label_defaults.js

@@ -13,7 +13,27 @@ var Lib = require('../../lib');
 var layoutAttributes = require('./layout_attributes');
 var handleArrayContainerDefaults = require('../array_container_defaults');
 
-module.exports = function handleTickLabelDefaults(containerIn, containerOut, coerce, axType, options) {
+module.exports = function handleTickLabelDefaults(containerIn, containerOut, coerce, axType, options, config) {
+    if(!config || config.pass === 1) {
+        handlePrefixSuffix(containerIn, containerOut, coerce, axType, options);
+    }
+
+    if(!config || config.pass === 2) {
+        handleOtherDefaults(containerIn, containerOut, coerce, axType, options);
+    }
+};
+
+function handlePrefixSuffix(containerIn, containerOut, coerce, axType, options) {
+    var showAttrDflt = getShowAttrDflt(containerIn);
+
+    var tickPrefix = coerce('tickprefix');
+    if(tickPrefix) coerce('showtickprefix', showAttrDflt);
+
+    var tickSuffix = coerce('ticksuffix', options.tickSuffixDflt);
+    if(tickSuffix) coerce('showticksuffix', showAttrDflt);
+}
+
+function handleOtherDefaults(containerIn, containerOut, coerce, axType, options) {
     var showAttrDflt = getShowAttrDflt(containerIn);
 
     var tickPrefix = coerce('tickprefix');
@@ -54,7 +74,7 @@ module.exports = function handleTickLabelDefaults(containerIn, containerOut, coe
             }
         }
     }
-};
+}
 
 /*
  * Attributes 'showexponent', 'showtickprefix' and 'showticksuffix'