add funnel - new trace files

Author: archmoj

src/traces/funnel/arrays_to_calcdata.js

@@ -0,0 +1,31 @@
+/**
+* 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';
+
+var mergeArray = require('../../lib').mergeArray;
+
+// arrayOk attributes, merge them into calcdata array
+module.exports = function arraysToCalcdata(cd, trace) {
+    for(var i = 0; i < cd.length; i++) cd[i].i = i;
+
+    mergeArray(trace.text, cd, 'tx');
+    mergeArray(trace.hovertext, cd, 'htx');
+
+    var marker = trace.marker;
+    if(marker) {
+        mergeArray(marker.opacity, cd, 'mo');
+        mergeArray(marker.color, cd, 'mc');
+
+        var markerLine = marker.line;
+        if(markerLine) {
+            mergeArray(markerLine.color, cd, 'mlc');
+            mergeArray(markerLine.width, cd, 'mlw');
+        }
+    }
+};

src/traces/funnel/attributes.js

@@ -0,0 +1,92 @@
+/**
+* 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';
+
+var pieAtts = require('../pie/attributes');
+var barAttrs = require('../bar/attributes');
+var lineAttrs = require('../scatter/attributes').line;
+var extendFlat = require('../../lib/extend').extendFlat;
+var Color = require('../../components/color');
+
+module.exports = {
+    x: barAttrs.x,
+    x0: barAttrs.x0,
+    dx: barAttrs.dx,
+    y: barAttrs.y,
+    y0: barAttrs.y0,
+    dy: barAttrs.dy,
+
+    hovertext: barAttrs.hovertext,
+    hovertemplate: barAttrs.hovertemplate,
+
+    textinfo: extendFlat({}, pieAtts.textinfo, {
+        editType: 'plot',
+        flags: ['label', 'text', 'percent of initial', 'percent of previous', 'percent of total', 'value'],
+        description: [
+            'Determines which trace information appear on the graph.'
+        ].join(' ')
+    }),
+
+    text: barAttrs.text,
+    textposition: extendFlat({}, barAttrs.textposition, {dflt: 'auto'}),
+    insidetextcenter: {
+        valType: 'boolean',
+        dflt: false,
+        role: 'info',
+        editType: 'plot',
+        description: [
+            'Determines if texts are kept at center in `textposition` *inside* mode.'
+        ].join(' ')
+    },
+    textfont: barAttrs.textfont,
+    insidetextfont: barAttrs.insidetextfont,
+    outsidetextfont: barAttrs.outsidetextfont,
+    constraintext: barAttrs.constraintext,
+
+    cliponaxis: barAttrs.cliponaxis,
+    orientation: barAttrs.orientation,
+
+    offset: barAttrs.offset,
+    width: barAttrs.width,
+
+    marker: barAttrs.marker,
+
+    connector: {
+        fillcolor: {
+            valType: 'color',
+            role: 'style',
+            editType: 'plot', // TODO: could we set this to 'style' ?
+            description: [
+                'Sets the fill color.'
+            ].join(' ')
+        },
+        line: {
+            color: extendFlat({}, lineAttrs.color, {dflt: Color.defaultLine}),
+            width: extendFlat({}, lineAttrs.width, {
+                dflt: 0,
+                editType: 'plot', // TODO: could we set this to 'style' ?
+            }),
+            dash: lineAttrs.dash,
+            editType: 'plot' // TODO: could we set this to 'style' ?
+        },
+        visible: {
+            valType: 'boolean',
+            dflt: true,
+            role: 'info',
+            editType: 'plot',
+            description: [
+                'Determines if connector regions and lines are drawn.'
+            ].join(' ')
+        },
+        editType: 'plot'
+    },
+
+    offsetgroup: barAttrs.offsetgroup,
+    alignmentgroup: barAttrs.offsetgroup
+};

src/traces/funnel/calc.js

@@ -0,0 +1,89 @@
+/**
+* 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';
+
+var Axes = require('../../plots/cartesian/axes');
+var arraysToCalcdata = require('./arrays_to_calcdata');
+var calcSelection = require('../scatter/calc_selection');
+var BADNUM = require('../../constants/numerical').BADNUM;
+
+module.exports = function calc(gd, trace) {
+    var xa = Axes.getFromId(gd, trace.xaxis || 'x');
+    var ya = Axes.getFromId(gd, trace.yaxis || 'y');
+    var size, pos, i, cdi;
+
+    if(trace.orientation === 'h') {
+        size = xa.makeCalcdata(trace, 'x');
+        pos = ya.makeCalcdata(trace, 'y');
+    } else {
+        size = ya.makeCalcdata(trace, 'y');
+        pos = xa.makeCalcdata(trace, 'x');
+    }
+
+    // create the "calculated data" to plot
+    var serieslen = Math.min(pos.length, size.length);
+    var cd = new Array(serieslen);
+
+    trace._base = [];
+
+    // set position and size
+    for(i = 0; i < serieslen; i++) {
+        // treat negative values as bad numbers
+        if(size[i] < 0) size[i] = BADNUM;
+
+        var connectToNext = false;
+        if(size[i] !== BADNUM) {
+            if(i + 1 < serieslen && size[i + 1] !== BADNUM) {
+                connectToNext = true;
+            }
+        }
+
+        cdi = cd[i] = {
+            p: pos[i],
+            s: size[i],
+            cNext: connectToNext
+        };
+
+        trace._base[i] = -0.5 * size[i];
+
+        if(trace.ids) {
+            cdi.id = String(trace.ids[i]);
+        }
+
+        // calculate total values
+        if(i === 0) cd[0].vTotal = 0;
+        cd[0].vTotal += fixNum(cdi.s);
+
+        // ratio from initial value
+        cdi.begR = fixNum(cdi.s) / fixNum(cd[0].s);
+    }
+
+    var prevGoodNum;
+    for(i = 0; i < serieslen; i++) {
+        cdi = cd[i];
+        if(cdi.s === BADNUM) continue;
+
+        // ratio of total value
+        cdi.sumR = cdi.s / cd[0].vTotal;
+
+        // ratio of previous (good) value
+        cdi.difR = (prevGoodNum !== undefined) ? cdi.s / prevGoodNum : 1;
+
+        prevGoodNum = cdi.s;
+    }
+
+    arraysToCalcdata(cd, trace);
+    calcSelection(cd, trace);
+
+    return cd;
+};
+
+function fixNum(a) {
+    return (a === BADNUM) ? 0 : a;
+}

src/traces/funnel/cross_trace_calc.js

@@ -0,0 +1,88 @@
+/**
+* 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';
+
+var setGroupPositions = require('../bar/cross_trace_calc').setGroupPositions;
+
+module.exports = function crossTraceCalc(gd, plotinfo) {
+    var fullLayout = gd._fullLayout;
+    var fullData = gd._fullData;
+    var calcdata = gd.calcdata;
+    var xa = plotinfo.xaxis;
+    var ya = plotinfo.yaxis;
+    var includeOtherTypes = false;
+    var funnels = [];
+    var funnelsVert = [];
+    var funnelsHorz = [];
+    var cd, i;
+
+    var mayHideX = false;
+    var mayHideY = false;
+
+    for(i = 0; i < fullData.length; i++) {
+        var fullTrace = fullData[i];
+        var isHorizontal = (fullTrace.orientation === 'h');
+
+        if(
+            fullTrace.visible === true &&
+            fullTrace.xaxis === xa._id &&
+            fullTrace.yaxis === ya._id
+        ) {
+            if(fullTrace.type === 'funnel') {
+                cd = calcdata[i];
+
+                if(isHorizontal) {
+                    funnelsHorz.push(cd);
+                    mayHideX = true;
+                } else {
+                    funnelsVert.push(cd);
+                    mayHideY = true;
+                }
+
+                funnels.push(cd);
+            } else { // TODO: figure out which trace types should be exluded here?
+                includeOtherTypes = true;
+            }
+        }
+    }
+
+    if(!includeOtherTypes) {
+        if(mayHideX) xa._hide = true;
+        if(mayHideY) ya._hide = true;
+    }
+
+    // funnel version of 'barmode', 'barnorm', 'bargap' and 'bargroupgap'
+    var mockGd = {
+        _fullLayout: {
+            _axisMatchGroups: fullLayout._axisMatchGroups,
+            _alignmentOpts: fullLayout._alignmentOpts,
+            barmode: fullLayout.funnelmode,
+            barnorm: fullLayout.funnelnorm,
+            bargap: fullLayout.funnelgap,
+            bargroupgap: fullLayout.funnelgroupgap
+        }
+    };
+
+    setGroupPositions(mockGd, xa, ya, funnelsVert);
+    setGroupPositions(mockGd, ya, xa, funnelsHorz);
+
+    for(i = 0; i < funnels.length; i++) {
+        cd = funnels[i];
+
+        for(var j = 0; j < cd.length; j++) {
+            if(j + 1 < cd.length) {
+                cd[j].nextP0 = cd[j + 1].p0;
+                cd[j].nextS0 = cd[j + 1].s0;
+
+                cd[j].nextP1 = cd[j + 1].p1;
+                cd[j].nextS1 = cd[j + 1].s1;
+            }
+        }
+    }
+};

src/traces/funnel/defaults.js

@@ -0,0 +1,79 @@
+/**
+* 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';
+
+var Lib = require('../../lib');
+
+var handleGroupingDefaults = require('../bar/defaults').handleGroupingDefaults;
+var handleText = require('../bar/defaults').handleText;
+var handleXYDefaults = require('../scatter/xy_defaults');
+var attributes = require('./attributes');
+var Color = require('../../components/color');
+
+function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
+    function coerce(attr, dflt) {
+        return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
+    }
+
+    var len = handleXYDefaults(traceIn, traceOut, layout, coerce);
+    if(!len) {
+        traceOut.visible = false;
+        return;
+    }
+
+    coerce('orientation', (traceOut.x && !traceOut.y) ? 'h' : 'v');
+    coerce('offset');
+    coerce('width');
+
+    coerce('text');
+    coerce('textinfo');
+
+    coerce('hovertext');
+    coerce('hovertemplate');
+
+    handleText(traceIn, traceOut, layout, coerce, false);
+
+    coerce('marker.color', defaultColor);
+    coerce('marker.line.color', Color.defaultLine);
+    coerce('marker.line.width');
+
+    var connectorVisible = coerce('connector.visible');
+    if(connectorVisible) {
+        coerce('connector.fillcolor', Color.addOpacity(defaultColor, 0.5));
+
+        var connectorLineWidth = coerce('connector.line.width');
+        if(connectorLineWidth) {
+            coerce('connector.line.color');
+            coerce('connector.line.dash');
+        }
+    }
+}
+
+function crossTraceDefaults(fullData, fullLayout) {
+    var traceIn, traceOut;
+
+    function coerce(attr) {
+        return Lib.coerce(traceOut._input, traceOut, attributes, attr);
+    }
+
+    if(fullLayout.funnelmode === 'group') {
+        for(var i = 0; i < fullData.length; i++) {
+            traceOut = fullData[i];
+            traceIn = traceOut._input;
+
+            handleGroupingDefaults(traceIn, traceOut, fullLayout, coerce);
+        }
+    }
+}
+
+module.exports = {
+    supplyDefaults: supplyDefaults,
+    crossTraceDefaults: crossTraceDefaults,
+    handleGroupingDefaults: handleGroupingDefaults
+};