Fix: Prevent loss of domain information when template field is present in layout #7283
Conversation
| newFullLayout[key].domain = oldFullLayout[key].domain; | ||
| } else if (newDomain[0] !== oldDomain[0] || newDomain[1] !== oldDomain[1]) { | ||
| // what you're asking for HAS changed, so clear _inputDomain and let us start from scratch | ||
| newFullLayout[key]._inputDomain = null; |
There was a problem hiding this comment.
I think nestedProperty(...).set(null) is actually equivalent to delete newFullLayout[key]._inputDomain
There was a problem hiding this comment.
@alexcjohnson Using delete may be slower comparing to setting to null. No?
There was a problem hiding this comment.
I suppose that’s faster and should be equivalent. This is not a high volume operation so I wouldn’t be too concerned about it, but we can leave it if you prefer.
There was a problem hiding this comment.
I was using this syntax for consistency with the other places in the codebase that delete this field, but I don't have a strong opinion on which we use.
There was a problem hiding this comment.
@marthacryan Maybe worth leaving a comment explaining why we do nothing in the else case? (I know we discussed but... for posterity)
There was a problem hiding this comment.
Ah yeah good point Emily!
There was a problem hiding this comment.
@alexcjohnson I added a comment explaining the else case based off of this explanation from you about that case:
"this situation is perhaps actually ambiguous: did you pass back in the previous layout as modified by Plotly.js, so we should assume you really wanted _inputDomain to still apply? or did you explicitly set the new domain and it just happened to match the old final calculated domain - in which case we should clear _inputDomain. I guess generally oldDomain will be some random floating point number so it's unlikely you matched it exactly. better to assume you passed back in the same layout object and change nothing in this case."
Let me know if you have any corrections!
|
@marthacryan Thanks very much for another excellent PR. 🏆 |
marthacryan
changed the title
|
@marthacryan Could you please add a test to lock the bug you fixed in this PR? |
@archmoj Done! I added it to the |
marthacryan
changed the title
Alternative fix to plotly/plotly.py#4794. Other fix is #7282.
Context:
editTypefrom'calc'to'plot'is more of a downgrade than something that should fix this issue._inputDomain, but that this line was returning indiffFlagsbefore it reached the yaxis to reset it_inputDomainin thechangedfunction was actually incorrect. It should be reset in its own separate crawl of the layout._inputDomaininto thediffLayoutfunction because it has access to both the old layout and the new layout.