Skip to content

Sort transform #1609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 10, 2017
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions src/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -344,13 +344,25 @@ lib.mergeArray = function(traceAttr, cd, cdAttr) {
}
};

lib.getTargetArray = function(trace, target) {
/** Returns target as set by 'target' transform attribute
*
* @param {object} trace : full trace object
* @param {object} transformOpts : transform option object
* - target (string} :
* either an attribute string referencing an array in the trace object, or
* a set array.
*
* @return {array or false} : the target array (NOT a copy!!) or false if invalid
*/
lib.getTargetArray = function(trace, transformOpts) {
var target = transformOpts.target;

if(typeof target === 'string' && target) {
var array = lib.nestedProperty(trace, target).get();

return Array.isArray(array) ? array : [];
return Array.isArray(array) ? array : false;
} else if(Array.isArray(target)) {
return target;
}
else if(Array.isArray(target)) return target.slice();

return false;
};
Expand Down
7 changes: 3 additions & 4 deletions src/transforms/filter.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,11 @@ exports.supplyDefaults = function(transformIn) {
exports.calcTransform = function(gd, trace, opts) {
if(!opts.enabled) return;

var targetArray = Lib.getTargetArray(trace, opts);
if(!targetArray) return;

var target = opts.target;
var targetArray = Lib.getTargetArray(trace, target);
var len = targetArray.length;

if(!len) return;

var targetCalendar = opts.targetcalendar;

// even if you provide targetcalendar, if target is a string and there
Expand Down
11 changes: 5 additions & 6 deletions src/transforms/sort.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,23 +73,22 @@ exports.supplyDefaults = function(transformIn) {
exports.calcTransform = function(gd, trace, opts) {
if(!opts.enabled) return;

var targetArray = Lib.getTargetArray(trace, opts);
if(!targetArray) return;

var target = opts.target;
var targetArray = Lib.getTargetArray(trace, target);
var len = targetArray.length;

if(!len) return;

var arrayAttrs = PlotSchema.findArrayAttributes(trace);
var d2c = Axes.getDataToCoordFunc(gd, trace, target, targetArray);
var indices = getIndices(opts, targetArray, d2c);

for(var i = 0; i < arrayAttrs.length; i++) {
var np = Lib.nestedProperty(trace, arrayAttrs[i]);
var arrayCopy = np.get().slice();
var arrayOld = np.get();
var arrayNew = new Array(len);

for(var j = 0; j < len; j++) {
arrayNew[j] = arrayCopy[indices[j]];
arrayNew[j] = arrayOld[indices[j]];
}

np.set(arrayNew);
Expand Down
52 changes: 52 additions & 0 deletions test/jasmine/tests/transform_sort_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,58 @@ describe('Test sort transform calc:', function() {
expect(out[0].marker.color).toEqual([0.4, 0.1, 0.1, 0.2, 0.2, 0.3, 0.3]);
expect(out[0].marker.size).toEqual([10, 10, 1, 20, 6, 5, 0]);
});

it('should truncate transformed arrays to target array length (short target case)', function() {
var out = _transform([
extend({
transforms: [{
order: 'descending',
target: [0, 1]
}]
}
), extend({
text: ['A', 'B'],
transforms: [{ target: 'text' }]
})]);

expect(out[0].x).toEqual([-1, -2]);
expect(out[0].y).toEqual([2, 1]);
expect(out[0].ids).toEqual(['n1', 'n0']);
expect(out[0].marker.color).toEqual([0.2, 0.1]);
expect(out[0].marker.size).toEqual([20, 10]);

expect(out[1].x).toEqual([-2, -1]);
expect(out[1].y).toEqual([1, 2]);
expect(out[1].ids).toEqual(['n0', 'n1']);
expect(out[1].marker.color).toEqual([0.1, 0.2]);
expect(out[1].marker.size).toEqual([10, 20]);
});

it('should truncate transformed arrays to target array length (long target case)', function() {
var out = _transform([
extend({
transforms: [{
order: 'descending',
target: [0, 1, 2, 0, 1, 2, 3, 0, 1, 2, 3]
}]
}
), extend({
text: ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I'],
transforms: [{ target: 'text' }]
})]);

expect(out[0].x).toEqual([1, undefined, -2, 3, undefined, -1, 1, undefined, -2, 0, undefined]);
expect(out[0].y).toEqual([1, undefined, 3, 3, undefined, 2, 2, undefined, 1, 1, undefined]);
expect(out[0].ids).toEqual(['p3', undefined, 'n2', 'p2', undefined, 'n1', 'p1', undefined, 'n0', 'z', undefined]);
expect(out[0].marker.color).toEqual([0.4, undefined, 0.3, 0.3, undefined, 0.2, 0.2, undefined, 0.1, 0.1, undefined]);
expect(out[0].marker.size).toEqual([10, undefined, 5, 0, undefined, 20, 6, undefined, 10, 1, undefined]);

expect(out[1].x).toEqual([-2, -1, -2, 0, 1, 3, 1, undefined, undefined]);
expect(out[1].y).toEqual([1, 2, 3, 1, 2, 3, 1, undefined, undefined]);
expect(out[1].ids).toEqual(['n0', 'n1', 'n2', 'z', 'p1', 'p2', 'p3', undefined, undefined]);
expect(out[1].marker.color).toEqual([0.1, 0.2, 0.3, 0.1, 0.2, 0.3, 0.4, undefined, undefined]);
expect(out[1].marker.size).toEqual([10, 20, 5, 1, 6, 0, 10, undefined, undefined]);
});
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice tests! 🎉

});

describe('Test sort transform interactions:', function() {
Expand Down