Restore colorbar frame handling - #610
Merged
Merged
Conversation
This restores frame/frameon as a reliable public colorbar option again. Outer colorbars now treat it as a backwards-compatible alias for outline, while inset colorbars stop storing raw booleans as frame artists and therefore no longer crash during layout reflow when the frame is disabled. The change also adds regression tests for both the outer and inset paths. Closes #609
Contributor
There was a problem hiding this comment.
Pull request overview
Restores frame / frameon as reliable public colorbar options by treating them as a backward-compatible alias for outer colorbar outline, and by preventing inset colorbars from storing raw booleans as “frame artists” (avoiding crashes during layout reflow when the frame is disabled).
Changes:
- Add
frame/frameonparameters to the colorbar builder and route them appropriately for outer vs. inset colorbars. - Fix inset colorbar frame handling by storing an actual frame artist (or
None) instead of a boolean. - Add regression tests covering both outer and inset behavior for
frame=Falseandframeon=False.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
ultraplot/colorbar.py |
Accepts frame/frameon, treats them as aliases for outline on outer colorbars, and forwards inset frame intent into inset parsing. |
ultraplot/axes/base.py |
Updates public docs and ensures inset colorbar frame state is stored as an artist (or None) instead of a boolean. |
ultraplot/tests/test_colorbar.py |
Adds regression tests for outer frame→outline aliasing and inset frame=False not creating a frame artist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cvanelteren
enabled auto-merge (squash)
March 11, 2026 00:35
Collaborator
Author
|
Regression is not related to the PR -- merging |
K-Mirembe-Mercy
pushed a commit
to K-Mirembe-Mercy/UltraPlot
that referenced
this pull request
Mar 22, 2026
* Restore colorbar frame handling This restores frame/frameon as a reliable public colorbar option again. Outer colorbars now treat it as a backwards-compatible alias for outline, while inset colorbars stop storing raw booleans as frame artists and therefore no longer crash during layout reflow when the frame is disabled. The change also adds regression tests for both the outer and inset paths. Closes Ultraplot#609 * Clarify colorbar frame defaults in docs
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
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.
This restores frame/frameon as a reliable public colorbar option again. Outer colorbars now treat it as a backwards-compatible alias for outline, while inset colorbars stop storing raw booleans as frame artists and therefore no longer crash during layout reflow when the frame is disabled.
The change also adds regression tests for both the outer and inset paths.
Closes #609