rename option to raw

plotly · archmoj · Mar 28, 2024 · Mar 18, 2024 · Mar 18, 2024 · Mar 18, 2024
commit df7ad4517c229907e1254e3b314f27654f2d73f4
diff --git a/draftlogs/6938_add.md b/draftlogs/6938_add.md
@@ -0,0 +1,2 @@
+ - Add "raw" sizemode to cone trace [[#6938](https://github.com/plotly/plotly.js/pull/6938)]
+
diff --git a/src/traces/cone/attributes.js b/src/traces/cone/attributes.js
@@ -96,14 +96,14 @@ var attrs = {

    sizemode: {
        valType: 'enumerated',
-        values: ['scaled', 'absolute', 'vector'],
+        values: ['scaled', 'absolute', 'raw'],
        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).',
-            'To display sizes in actual vector scale use *vector*.'
+            'To display sizes in actual vector length use *raw*.'
        ].join(' ')
    },
    sizeref: {
@@ -116,8 +116,8 @@ 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 *raw*, 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.'
        ].join(' ')

diff --git a/src/traces/cone/convert.js b/src/traces/cone/convert.js
@@ -89,7 +89,7 @@ function convert(scene, trace) {
        coneOpts.coneSize = trace.sizeref && trace._normMax ?
            trace.sizeref / trace._normMax :
            0.5;
-    } else if(sizemode === 'vector') {
+    } else if(sizemode === 'raw') {
        coneOpts.coneSize = trace.sizeref;
    }
    coneOpts.coneSizemode = sizemode;

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

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

    coerce('anchor');


diff --git a/stackgl_modules/index.js b/stackgl_modules/index.js
@@ -13782,7 +13782,7 @@ module.exports = function(vectorfield, bounds) {
 	var positionVectors = [];
 	var vectorScale = Infinity;
 	var skipIt = false;
-	var vectorSizemode = vectorfield.coneSizemode === 'vector';
+	var vectorSizemode = vectorfield.coneSizemode === 'raw';
 	for (var i = 0; i < positions.length; i++) {
 		var p = positions[i];
 		minX = Math.min(p[0], minX);

diff --git a/stackgl_modules/package-lock.json b/stackgl_modules/package-lock.json
diff --git a/stackgl_modules/package.json b/stackgl_modules/package.json
@@ -13,7 +13,7 @@
    "box-intersect": "plotly/box-intersect#v1.1.0",
    "convex-hull": "^1.0.3",
    "delaunay-triangulate": "^1.1.6",
-    "gl-cone3d": "github:gl-vis/gl-cone3d#9cf07db8d3526dbe85e9fa671857416cc3ed63e2",
+    "gl-cone3d": "github:gl-vis/gl-cone3d#846764e2c95157fcfcf1ef264401c3cf665faaaa",
    "gl-error3d": "^1.0.16",
    "gl-heatmap2d": "^1.1.1",
    "gl-line3d": "1.2.1",

diff --git a/test/image/baselines/zz-gl3d_cone-sizemode_vector.png b/test/image/baselines/zz-gl3d_cone-sizemode_vector.png
diff --git a/test/image/baselines/zz-gl3d_cone-sizemode_vector2.png b/test/image/baselines/zz-gl3d_cone-sizemode_vector2.png
diff --git a/test/image/mocks/zz-gl3d_cone-sizemode_vector.json b/test/image/mocks/zz-gl3d_cone-sizemode_vector.json
@@ -8,10 +8,10 @@
      "u": [1, 0, 0],
      "v": [0, 3, 0],
      "w": [0, 0, 2],
-      "sizemode": "vector",
+      "sizemode": "raw",
      "anchor": "tip",
      "colorbar": {
-        "title": { "text": "vector<br>sizeref: 1" },
+        "title": { "text": "raw<br>sizeref: 1" },
        "x": 0,
        "xanchor": "right"
      }
@@ -24,10 +24,10 @@
      "u": [0.5, 0, 0],
      "v": [0, 1.5, 0],
      "w": [0, 0, 1],
-      "sizemode": "vector",
+      "sizemode": "raw",
      "anchor": "tip",
      "colorbar": {
-        "title": { "text": "vector<br>sizeref: 1" }
+        "title": { "text": "rawr<br>sizeref: 1" }
      },
      "scene": "scene2"
    }

diff --git a/test/image/mocks/zz-gl3d_cone-sizemode_vector2.json b/test/image/mocks/zz-gl3d_cone-sizemode_vector2.json
@@ -8,11 +8,11 @@
      "u": [1, 0, 0],
      "v": [0, 3, 0],
      "w": [0, 0, 2],
-      "sizemode": "vector",
+      "sizemode": "raw",
      "anchor": "tip",
      "sizeref": 0.5,
      "colorbar": {
-        "title": { "text": "vector<br>sizeref: 2" },
+        "title": { "text": "raw<br>sizeref: 2" },
        "x": 0,
        "xanchor": "right"
      }
@@ -25,11 +25,11 @@
      "u": [0.5, 0, 0],
      "v": [0, 1.5, 0],
      "w": [0, 0, 1],
-      "sizemode": "vector",
+      "sizemode": "raw",
      "anchor": "tip",
      "sizeref": 2,
      "colorbar": {
-        "title": { "text": "vector<br>sizeref: 2" }
+        "title": { "text": "raw<br>sizeref: 2" }
      },
      "scene": "scene2"
    }

diff --git a/test/image/mocks/zz-gl3d_cone-sizemode_vector3.json b/test/image/mocks/zz-gl3d_cone-sizemode_vector3.json
@@ -2,7 +2,7 @@
  "data": [
    {
      "type": "cone",
-      "sizemode": "vector",
+      "sizemode": "raw",
      "anchor": "tip",
      "u": [
        0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,

diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -22456,18 +22456,18 @@
     "valType": "boolean"
    },
    "sizemode": {
-     "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). To display sizes in actual vector scale use *vector*.",
+     "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). To display sizes in actual vector length use *raw*.",
     "dflt": "scaled",
     "editType": "calc",
     "valType": "enumerated",
     "values": [
      "scaled",
      "absolute",
-      "vector"
+      "raw"
     ]
    },
    "sizeref": {
-     "description": "Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. 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.",
+     "description": "Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. 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 *raw*, 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.",
     "editType": "calc",
     "min": 0,
     "valType": "number"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Add "raw" sizemode to cone trace [[#6938](https://github.com/plotly/plotly.js/pull/6938)]