plotly.js/src/traces/quiver/defaults.js

The open source javascript graphing library that powers plotly

'use strict';

var Lib = require('../../lib');
var attributes = require('./attributes');
var handleXYDefaults = require('../scatter/xy_defaults');
var hasColorscale = require('../../components/colorscale/helpers').hasColorscale;
var colorscaleDefaults = require('../../components/colorscale/defaults');

module.exports = 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;
    }

    var u = coerce('u');
    var v = coerce('v');

    // If u/v are missing, default to zeros so the trace participates in calc/category logic
    if(!Lib.isArrayOrTypedArray(u) || u.length === 0) {
        traceOut.u = new Array(len);
        for(var i = 0; i < len; i++) traceOut.u[i] = 0;
    }
    if(!Lib.isArrayOrTypedArray(v) || v.length === 0) {
        traceOut.v = new Array(len);
        for(var j = 0; j < len; j++) traceOut.v[j] = 0;
    }

    coerce('arrowref');

    // Sizing API inspired by cone, but not identical
    coerce('lengthmode');
    coerce('lengthfactor');
    coerce('anchor');

    // Arrow styling
    coerce('marker.arrowsize');

    // Line styling under marker.line
    coerce('marker.line.width');
    coerce('marker.line.dash');

    // Text
    coerce('text');
    coerce('textposition');
    Lib.coerceFont(coerce, 'textfont', layout.font);

    // Hover
    coerce('hovertemplate');
    coerce('xhoverformat');
    coerce('yhoverformat');
    coerce('uhoverformat');
    coerce('vhoverformat');

    // Colorscale defaults (adds colorscale, showscale, colorbar, etc.)
    // Ensure traceOut.marker exists before colorscaleDefaults, which captures
    // a reference to it via npMaybe at the start of its execution.
    if(!traceOut.marker) traceOut.marker = {};
    coerce('marker.color', defaultColor);
    var withColorscale = hasColorscale(traceIn, 'marker') || (traceIn.marker || {}).coloraxis;
    traceOut._hasColorscale = !!withColorscale;
    if(withColorscale) {
        colorscaleDefaults(traceIn, traceOut, layout, coerce, { prefix: 'marker.', cLetter: 'c' });
    }

    // Provide trace.line for compat with shared code (legend, getTraceColor)
    var markerLine = traceOut.marker.line || {};
    var mc = traceOut.marker.color;
    traceOut.line = {
        width: markerLine.width,
        color: Lib.isArrayOrTypedArray(mc) ? defaultColor : mc,
        dash: markerLine.dash
    };

    // Selection styling
    coerce('selected.marker.color');
    coerce('selected.marker.line.width');
    coerce('selected.textfont.color');
    coerce('unselected.marker.color');
    coerce('unselected.marker.line.width');
    coerce('unselected.textfont.color');

};