Add quiver trace type for vector field visualization

draftlogs/7710_add.md

@@ -0,0 +1 @@
+- Add `quiver` trace type to visualize vector fields using arrows [[#7710](https://github.com/plotly/plotly.js/pull/7710)]

lib/index-strict.js

@@ -52,6 +52,7 @@ Plotly.register([
     require('../src/traces/scatterpolargl/strict'),
     require('./barpolar'),
     require('./scattersmith'),
+    require('./quiver'),
 
     // components
     require('./calendars'),

lib/index.js

@@ -52,6 +52,7 @@ Plotly.register([
     require('./scatterpolargl'),
     require('./barpolar'),
     require('./scattersmith'),
+    require('./quiver'),
 
     // components
     require('./calendars'),

lib/quiver.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('../src/traces/quiver');

src/components/legend/style.js

@@ -686,7 +686,7 @@ function getGradientDirection(reversescale, isRadial) {
 function getStyleGuide(d) {
     var trace = d[0].trace;
     var contours = trace.contours;
-    var showLine = subTypes.hasLines(trace);
+    var showLine = subTypes.hasLines(trace) || (trace.visible && trace.type === 'quiver');
     var showMarker = subTypes.hasMarkers(trace);
 
     var showFill = trace.visible && trace.fill && trace.fill !== 'none';

src/traces/quiver/attributes.js

@@ -0,0 +1,212 @@
+'use strict';
+
+var baseAttrs = require('../../plots/attributes');
+var hovertemplateAttrs = require('../../plots/template_attributes').hovertemplateAttrs;
+var fontAttrs = require('../../plots/font_attributes');
+var axisHoverFormat = require('../../plots/cartesian/axis_format_attributes').axisHoverFormat;
+var extendFlat = require('../../lib/extend').extendFlat;
+var colorScaleAttrs = require('../../components/colorscale/attributes');
+var dash = require('../../components/drawing/attributes').dash;
+var annotationAttrs = require('../../components/annotations/attributes');
+var scatterAttrs = require('../scatter/attributes');
+
+var attrs = {
+    x: {
+        valType: 'data_array',
+        editType: 'calc+clearAxisTypes',
+        anim: true,
+        description: 'Sets the x coordinates of the arrow locations.'
+    },
+    x0: scatterAttrs.x0,
+    dx: scatterAttrs.dx,
+    y: {
+        valType: 'data_array',
+        editType: 'calc+clearAxisTypes',
+        anim: true,
+        description: 'Sets the y coordinates of the arrow locations.'
+    },
+    y0: scatterAttrs.y0,
+    dy: scatterAttrs.dy,
+    u: {
+        valType: 'data_array',
+        editType: 'calc',
+        anim: true,
+        description: 'Sets the x components of the arrow vectors.'
+    },
+    v: {
+        valType: 'data_array',
+        editType: 'calc',
+        anim: true,
+        description: 'Sets the y components of the arrow vectors.'
+    },
+    sizemode: {
+        valType: 'enumerated',
+        values: ['scaled', 'absolute', 'raw'],
+        editType: 'calc',
+        dflt: 'scaled',
+        description: [
+            'Determines whether `sizeref` is set as a *scaled* (unitless) scalar',
+            '(normalized by the max u/v norm in the vector field), as an *absolute*',
+            'value (in the same units as the vector field), or *raw* to use the',
+            'raw vector lengths.'
+        ].join(' ')
+    },
+    sizeref: {
+        valType: 'number',
+        min: 0,
+        editType: 'calc',
+        description: [
+            'Adjusts the arrow size scaling.',
+            'The arrow length is determined by the vector norm multiplied by `sizeref`,',
+            'optionally normalized when `sizemode` is *scaled*.'
+        ].join(' ')
+    },
+    anchor: {
+        valType: 'enumerated',
+        values: ['tip', 'tail', 'center'],
+        dflt: 'tail',
+        editType: 'calc',
+        description: [
+            'Sets the arrows\' anchor with respect to their (x,y) positions.',
+            'Use *tail* to place (x,y) at the base, *tip* to place (x,y) at the head,',
+            'or *center* to center the arrow on (x,y).'
+        ].join(' ')
+    },
+    hoverdistance: {
+        valType: 'number',
+        min: -1,
+        dflt: 20,
+        editType: 'calc',
+        description: 'Maximum distance (in pixels) to look for nearby arrows on hover.'
+    },
+
+    xhoverformat: axisHoverFormat('x'),
+    yhoverformat: axisHoverFormat('y'),
+    uhoverformat: axisHoverFormat('u', 'noDate'),
+    vhoverformat: axisHoverFormat('v', 'noDate'),
+
+    // Text and labels
+    text: {
+        valType: 'data_array',
+        editType: 'calc',
+        anim: true,
+        description: 'Sets text elements associated with each (x,y) pair.'
+    },
+    textposition: {
+        valType: 'enumerated',
+        values: [
+            'top left', 'top center', 'top right',
+            'middle left', 'middle center', 'middle right',
+            'bottom left', 'bottom center', 'bottom right'
+        ],
+        dflt: 'middle center',
+        editType: 'calc',
+        description: 'Sets the positions of the `text` elements with respects to the (x,y) coordinates.'
+    },
+    // Text font
+    textfont: fontAttrs({
+        editType: 'calc',
+        colorEditType: 'style',
+        arrayOk: true,
+        description: 'Sets the text font.'
+    }),
+
+    // Marker: color, colorscale, arrowhead sizing, and line styling for arrows
+    marker: extendFlat(
+        {
+            arrowsize: extendFlat({}, annotationAttrs.arrowsize, {
+                editType: 'calc',
+                description: [
+                    'Sets the size of the arrow head relative to `marker.line.width`.',
+                    'A value of 1 (default) gives a head about 3x as wide as the line.'
+                ].join(' ')
+            }),
+            line: {
+                width: {
+                    valType: 'number',
+                    min: 0,
+                    dflt: 1,
+                    editType: 'style',
+                    description: 'Sets the width (in px) of the arrow lines.'
+                },
+                dash: dash,
+                editType: 'style'
+            },
+            editType: 'calc'
+        },
+        colorScaleAttrs('marker', {
+            showScaleDflt: true,
+            editTypeOverride: 'calc'
+        })
+    ),
+
+    // Selection and styling
+    selected: {
+        line: {
+            color: {
+                valType: 'color',
+                editType: 'style',
+                description: 'Sets the line color of selected points.'
+            },
+            width: {
+                valType: 'number',
+                min: 0,
+                editType: 'style',
+                description: 'Sets the line width of selected points.'
+            },
+            editType: 'style'
+        },
+        textfont: {
+            color: {
+                valType: 'color',
+                editType: 'style',
+                description: 'Sets the text font color of selected points, applied only when a selection exists.'
+            },
+            editType: 'style'
+        },
+        editType: 'style'
+    },
+    unselected: {
+        line: {
+            color: {
+                valType: 'color',
+                editType: 'style',
+                description: 'Sets the line color of unselected points.'
+            },
+            width: {
+                valType: 'number',
+                min: 0,
+                editType: 'style',
+                description: 'Sets the line width of unselected points.'
+            },
+            editType: 'style'
+        },
+        textfont: {
+            color: {
+                valType: 'color',
+                editType: 'style',
+                description: 'Sets the text font color of unselected points, applied only when a selection exists.'
+            },
+            editType: 'style'
+        },
+        editType: 'style'
+    }
+};
+
+// Extend with base attributes (includes hoverinfo, etc.), keeping the
+// quiver-specific attributes layered on top of the shared base attributes.
+attrs = extendFlat({}, baseAttrs, attrs);
+
+// Add hoverinfo with proper flags for quiver
+// We need to create a new object to avoid mutating the shared base attributes
+attrs.hoverinfo = extendFlat({}, baseAttrs.hoverinfo, {
+    flags: ['x', 'y', 'u', 'v', 'text', 'name'],
+    dflt: 'all'
+});
+
+// Add hovertemplate
+attrs.hovertemplate = extendFlat({}, hovertemplateAttrs({}, {
+    keys: ['x', 'y', 'u', 'v', 'text', 'name']
+}));
+
+module.exports = attrs;