Force line collection to always respect colormap #2299
Conversation
Codecov ReportBase: 88.09% // Head: 88.06% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #2299 +/- ##
==========================================
- Coverage 88.09% 88.06% -0.04%
==========================================
Files 247 247
Lines 23563 23476 -87
==========================================
- Hits 20758 20673 -85
+ Misses 2805 2803 -2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
Looks good, can you add a changelog entry? (in the 1.6.0 section - you might need to rebase) |
Carifio24
force-pushed
the
scatter-line-bug
branch
from
913c806
to
f715379
Compare
|
@astrofrog I've rebased and added an entry in the changelog |
|
@Carifio24 - could you rebase this? |
Carifio24
force-pushed
the
scatter-line-bug
branch
from
f715379
to
ec0e3bb
Compare
|
@astrofrog I've just rebased |
…ne edges will always be colormapped.
Carifio24
force-pushed
the
scatter-line-bug
branch
from
ec0e3bb
to
2d27081
Compare
|
Just rebasing to resolve a conflict |
Carifio24
force-pushed
the
scatter-line-bug
branch
from
2d27081
to
6b25b1b
Compare
The scatter viewer currently has a bug (noticed by @victoriaono) where the line collection that connects points will only obey the selected colormap if that colormap was set before a line was first displayed on the viewer. Additionally, if a fixed color is set after the line displays, subsequent colormap usage will not be respected. See the video below for an example.
scatter-line-bug-2022-05-21_18.14.18.mp4
This PR creates consistent behavior by calling
set_color(None)inside the line collection'sset_linearcolormethod. The reason for this has to do with how the behavior is implemented insidematplotlib. Whenever the colormap mode is Fixed, we callset_linearcolorwithcolor=self.state.colorhere. This call's the artist'sset_colormethod, which ultimately callsset_facecolorand sets_original_facecolorto that color.However, when
cmap_modeis set toLinear, we callset_mpl_artist_cmaphere without a color argument, which doesn't doesn't callset_color, and so_original_facecolorremains as the solid color. The artist's_edge_is_mappedattribute is set to false if_original_edgecolorhas a color value, which means that the edgecolors of the artist are set to the original edgecolor, rather than the colormapped colors. This is why things work if we set the colormap before the line first displays - we haven't made a call to the line collection'sset_colormethod yet, so_original_facecoloris stillNone. By callingset_color(None), we reset_original_facecolortoNone, allowing the line collection edges to be colormapped.