silx.gui.plot.PlotWidget: Changed add* methods return value to return the item instead of its legend
#3996
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
t20100
force-pushed
the
plot-add-return-items
branch
from
6a91b1e to
5f3ac3d
Compare
|
Added some tests, ready for review. |
t20100
force-pushed
the
plot-add-return-items
branch
from
5f3ac3d to
85ff3cf
Compare
vallsv
approved these changes
Dec 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Merge PR #3988 first!
This PR introduces a breaking API change:
PlotWidget.add*methods (namelyaddCurve,addImage,addHistogram,addScatter,addShape,addMarker,addXMarker,addYMarker) now returns the created/updated PlotWidget item instead of its legend.To mitigate this API break,
PlotWidget.remove*methods andPlotWidget.get*methods were update to accept an item instance as theirlegendattribute. Together withsetActive*methods accepting item, this should make the API change seamless for code that was using the legend as an identifier of the item in thePlotWidgetwithout using it otherwise.PlotWidget.get*methods log a warning when passed an item instance since this call is no longer needed.Changes to
examples/and tests were minimal and actually not needed to make it run.closes #3990