contours on desired locations

Author: archmoj

src/traces/surface/attributes.js

@@ -43,6 +43,14 @@ function makeContourAttr(axLetter) {
                 'dimension are drawn.'
             ].join(' ')
         },
+        locations: {
+            valType: 'data_array',
+            dflt: [],
+            role: 'info',
+            description: [
+                'Specifies the location(s) of contours on the', axLetter, 'axis.'
+            ].join(' ')
+        },
         onpoints: {
             valType: 'number',
             role: 'info',

src/traces/surface/convert.js

@@ -25,6 +25,7 @@ function SurfaceTrace(scene, surface, uid) {
     this.surface = surface;
     this.data = null;
     this.showContour = [false, false, false];
+    this.contourLocations = [[], [], []];
     this.onPointsContour = [false, false]; // note: only available on x & y not z.
     this.minValues = [Infinity, Infinity, Infinity];
     this.maxValues = [-Infinity, -Infinity, -Infinity];
@@ -349,7 +350,18 @@ proto.setContourLevels = function() {
     var nlevels = [[], [], []];
     var needsUpdate = false;
 
-    var i, j;
+    function insertIfNewLevel(arr, newValue) {
+        var found = false;
+        for(var k = 0; k < arr.length; k++) {
+            if(newValue === arr[k]) {
+                found = true;
+                break;
+            }
+        }
+        if(found === false) arr.push(newValue);
+    }
+
+    var i, j, value;
 
     for(i = 0; i < 3; ++i) {
         if(this.showContour[i]) {
@@ -374,7 +386,6 @@ proto.setContourLevels = function() {
                         this.getXat(q, 0) * this.scene.dataScale[i] :
                         this.getYat(0, q) * this.scene.dataScale[i];
 
-                    var value;
                     if(ratio < 1) {
                         var prev = (i === 0) ?
                             this.getXat(q - 1, 0) * this.scene.dataScale[i] :
@@ -385,17 +396,17 @@ proto.setContourLevels = function() {
                         value = here;
                     }
 
-                    var found = false;
-                    for(j = 0; j < nlevels[i].length; j++) {
-                        if(value === nlevels[i][j]) {
-                            found = true;
-                            break;
-                        }
-                    }
-                    if(found === false) nlevels[i].push(value);
+                    insertIfNewLevel(nlevels[i], value);
                 }
             }
 
+            var locations = this.contourLocations[i];
+            if(locations.length) {
+                for(j = 0; j < locations.length; j++) {
+                    value = locations[j] * this.scene.dataScale[i];
+                    insertIfNewLevel(nlevels[i], value);
+                }
+            }
         }
     }
 
@@ -591,9 +602,11 @@ proto.update = function(data) {
             }
             params.contourWidth[i] = contourParams.width;
 
+            this.contourLocations[i] = contourParams.locations;
             if(i < 2) this.onPointsContour[i] = contourParams.onpoints;
         } else {
             this.showContour[i] = false;
+            this.contourLocations[i] = [];
             if(i < 2) this.onPointsContour[i] = 0;
         }
 

src/traces/surface/defaults.js

@@ -74,6 +74,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
             coerce(contourDim + '.color');
             coerce(contourDim + '.width');
             coerce(contourDim + '.usecolormap');
+            coerce(contourDim + '.locations');
             if(i < 2) coerce(contourDim + '.onpoints');
         }
 

test/image/mocks/gl3d_surface_contour_on-xy-data-points.json

@@ -5,7 +5,7 @@
         "contours": {
             "x": { "show": true, "onpoints": 1 },
             "y": { "show": true, "onpoints": 1 },
-            "z": { "show": false}
+            "z": { "show": false }
         },
         "x": [0, 0.25, 0.5, 0.75, 1],
         "y": [0, 0.25, 0.5, 0.75, 1],
@@ -22,7 +22,7 @@
             "contours": {
                 "x": { "show": true, "onpoints": 0.5 },
                 "y": { "show": true, "onpoints": 0.5 },
-                "z": { "show": false}
+                "z": { "show": false }
             },
             "x": [1.5, 1.75, 2, 2.25, 2.5],
             "y": [0, 0.25, 0.5, 0.75, 1],

test/image/mocks/gl3d_surface_contour_on-xyz-locations.json

@@ -0,0 +1,57 @@
+{
+    "data": [
+        {
+        "type": "surface",
+        "contours": {
+            "x": { "show": true, "locations": [0.2, 0.25, 0.3, 0.35, 0.4] },
+            "y": { "show": true, "locations": [0.2, 0.3, 0.4, 0.5] },
+            "z": { "show": true, "locations": [0.7, 0.75, 0.8] }
+        },
+        "x": [0, 0.25, 0.5, 0.75, 1],
+        "y": [0, 0.25, 0.5, 0.75, 1],
+        "z": [
+            [0, 1, 0, 1, 0],
+            [1, 0, 1, 0, 1],
+            [0, 1, 0, 1, 0],
+            [1, 0, 1, 0, 1],
+            [0, 1, 0, 1, 0]
+        ]
+        },
+        {
+            "type": "surface",
+            "contours": {
+                "x": { "show": true, "locations": [1.7, 1.75, 1.8] },
+                "y": { "show": true, "locations": [0.5, 0.6, 0.8, 0.8] },
+                "z": { "show": true, "locations": [0.2, 0.25, 0.3] }
+            },
+            "x": [1.5, 1.75, 2, 2.25, 2.5],
+            "y": [0, 0.25, 0.5, 0.75, 1],
+            "z": [
+                [0, 1, 0, 1, 0],
+                [1, 0, 1, 0, 1],
+                [0, 1, 0, 1, 0],
+                [1, 0, 1, 0, 1],
+                [0, 1, 0, 1, 0]
+            ]
+        }
+    ],
+    "layout": {
+        "title": "Surface contours on desired locations",
+        "width": 900,
+        "height": 600,
+        "scene": {
+            "xaxis": { "nticks": 1 },
+            "yaxis": { "nticks": 1 },
+            "zaxis": { "nticks": 1 },
+            "camera": {
+                "eye": { "x": 0, "y": -0.9, "z": 1.8 },
+                "center": { "x": 0, "y": 0, "z": 0 }
+            },
+            "aspectratio": {
+                "x": 2,
+                "y": 1,
+                "z": 1
+            }
+        }
+    }
+}

test/jasmine/tests/surface_test.js

@@ -63,6 +63,7 @@ describe('Test surface', function() {
             expect(traceOut.contours.y).toEqual(Lib.extendDeep({}, fullOpts, {
                 show: true,
                 onpoints: 0,
+                locations: [],
                 color: '#444',
                 width: 2,
                 usecolormap: false