Skip to content

Fix issue where styles weren't reset when re-using SVGs in colorbar #5217

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.

Sign up for GitHub

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 3 commits into from
Oct 19, 2020
Merged

Fix issue where styles weren't reset when re-using SVGs in colorbar #5217

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9319e2e
Fix issue where styles weren't reset when re-using SVGs in colorbar
Oct 17, 2020
018be00
Add test to check colorbar attrs match on newPlot/react
Oct 19, 2020
f5ad0cc
Factor out getCBFillAttributes into helper function
Oct 19, 2020
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
1 change: 1 addition & 0 deletions src/components/colorbar/draw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,7 @@ function drawColorBar(g, opts, gd) {

var fills = g.select('.' + cn.cbfills)
.selectAll('rect.' + cn.cbfill)
.attr('style', '')
.data(fillLevels);
fills.enter().append('rect')
.classed(cn.cbfill, true)
Expand Down
39 changes: 39 additions & 0 deletions test/jasmine/tests/colorbar_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,5 +524,44 @@ describe('Test colorbar:', function() {
.catch(failTest)
.then(done);
});

it('creates the same colorbars attributes in newPlot and react', function(done) {
var z = [[1, 10], [100, 1000]];

var expectedAttrs = [];
var actualAttrs = [];

Copy link
Contributor

Choose a reason for hiding this comment

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

The test looks great.
Non-blocking, but maybe you could add a getter function to avoid duplication:
Something like:

function pushItemsTo(a) {
    var colorbars = d3.select(gd).selectAll('.colorbar');
    colorbars.selectAll('.cbfill').each(function() {
        var attrsForElem = {};
        for(var i = 0; i < this.attributes.length; i++) {
            var attr = this.attributes.item(i);
            attrsForElem[attr.name] = attr.value;
        }
        a.push(attrsForElem);
    });
}

Plotly.newPlot(gd, [{type: 'contour', z: z}])
.then(function() {
    pushItemsTo(expectedAttrs);

    return Plotly.newPlot(gd, [{type: 'heatmap', z: z}])
    .then(function() {
        return Plotly.react(gd, [{type: 'contour', z: z}]);
    });
})
.then(function() {
    pushItemsTo(actualAttrs);

    expect(actualAttrs).toEqual(expectedAttrs);
})

Copy link
Author

Choose a reason for hiding this comment

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

Done 🙂

Plotly.newPlot(gd, [{type: 'contour', z: z}])
.then(function() {
var colorbars = d3.select(gd).selectAll('.colorbar');
colorbars.selectAll('.cbfill').each(function() {
var attrsForElem = {};
for(var i = 0; i < this.attributes.length; i++) {
var attr = this.attributes.item(i);
attrsForElem[attr.name] = attr.value;
}
expectedAttrs.push(attrsForElem);
});

return Plotly.newPlot(gd, [{type: 'heatmap', z: z}])
.then(function() {
return Plotly.react(gd, [{type: 'contour', z: z}]);
});
})
.then(function() {
var colorbars = d3.select(gd).selectAll('.colorbar');
colorbars.selectAll('.cbfill').each(function() {
var attrsForElem = {};
for(var i = 0; i < this.attributes.length; i++) {
var attr = this.attributes.item(i);
attrsForElem[attr.name] = attr.value;
}
actualAttrs.push(attrsForElem);
});
expect(actualAttrs).toEqual(expectedAttrs);
})
.catch(failTest)
.then(done);
});
});
});