add vector sizemode option to cone

plotly · archmoj · Mar 28, 2024 · Mar 18, 2024 · Mar 18, 2024 · Mar 18, 2024
commit 0ae9c7fbc2fe0364b4f0ff28c7bcc02aa4612847
diff --git a/src/traces/cone/attributes.js b/src/traces/cone/attributes.js
@@ -96,13 +96,14 @@ var attrs = {

    sizemode: {
        valType: 'enumerated',
-        values: ['scaled', 'absolute'],
+        values: ['scaled', 'absolute', 'vector'],
        editType: 'calc',
        dflt: 'scaled',
        description: [
            'Determines whether `sizeref` is set as a *scaled* (i.e unitless) scalar',
            '(normalized by the max u/v/w norm in the vector field) or as',
-            '*absolute* value (in the same units as the vector field).'
+            '*absolute* value (in the same units as the vector field).',
+            'To display sizes in actual vector scale use *vector*.'
        ].join(' ')
    },
    sizeref: {
@@ -115,6 +116,7 @@ var attrs = {
            'This factor (computed internally) corresponds to the minimum "time" to travel across',
            'two successive x/y/z positions at the average velocity of those two successive positions.',
            'All cones in a given trace use the same factor.',
+            'With `sizemode` set to *vector*, its default value is *1*',
            'With `sizemode` set to *scaled*, `sizeref` is unitless, its default value is *0.5*',
            'With `sizemode` set to *absolute*, `sizeref` has the same units as the u/v/w vector field,',
            'its the default value is half the sample\'s maximum vector norm.'

diff --git a/src/traces/cone/convert.js b/src/traces/cone/convert.js
@@ -79,15 +79,20 @@ function convert(scene, trace) {
    coneOpts.vertexIntensityBounds = [cOpts.min / trace._normMax, cOpts.max / trace._normMax];
    coneOpts.coneOffset = anchor2coneOffset[trace.anchor];

-    if(trace.sizemode === 'scaled') {
+
+    var sizemode = trace.sizemode;
+    if(sizemode === 'scaled') {
        // unitless sizeref
        coneOpts.coneSize = trace.sizeref || 0.5;
-    } else {
+    } else if(sizemode === 'absolute') {
        // sizeref here has unit of velocity
        coneOpts.coneSize = trace.sizeref && trace._normMax ?
            trace.sizeref / trace._normMax :
            0.5;
+    } else if(sizemode === 'vector') {
+        coneOpts.coneSize = trace.sizeref;
    }
+    coneOpts.coneSizemode = sizemode;

    var meshData = conePlot(coneOpts);


diff --git a/src/traces/cone/defaults.js b/src/traces/cone/defaults.js
@@ -26,8 +26,8 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
        return;
    }

-    coerce('sizeref');
-    coerce('sizemode');
+    var sizemode = coerce('sizemode');
+    coerce('sizeref', sizemode === 'vector' ? 1 : 0.5);

    coerce('anchor');