Add "overwrite" kwarg to all update* figure methods.#1726
Merged
Conversation
When True, update operations will overwrite the prior version of all properties. When False (the default), updates are applied recursively and prior properties are retained if not updated.
Contributor
|
@emmanuelle are you able to do a review pass on this one please? |
Contributor
|
@nicolaskruchten @jonmmease sorry I forgot about this one, I'll review it soon! |
Contributor
|
Looks good to me, thanks 💃 We should also update the tutorial https://plot.ly/python/creating-and-updating-figures/ with an example of |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Closes #1717
This PR adds a new
overwritekwarg to all of the figureupdate*methods. The default behavior, withoverwrite=False, is to apply updates recursively to the existing nested property structure. Withoverwrite=True, the prior value of existing properties is overwritten with the provided value.