Skip to content

Let plot_dataset take back the colorbars it returns #8448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jens Hedegaard Nielsen (jenshnielsen) wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −2
Open

Let plot_dataset take back the colorbars it returns #8448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/changes/newsfragments/8388.improved
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
The ``colorbars`` argument of :func:`.plot_dataset` and :func:`.plot_by_id` now
accepts a sequence that may contain ``None``. Both functions return a list of
colorbars in which the entries for 1D plots are ``None``, so passing the result
back in, which is how you plot into the same axes again, did not match the
declared argument type. A sequence of colorbars is still accepted.
7 changes: 5 additions & 2 deletions src/qcodes/dataset/plotting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,10 @@ def heatmaphandler(**kwargs: Any) -> Any:
def plot_dataset(
dataset: DataSetProtocol,
axes: Axes | Sequence[Axes] | None = None,
colorbars: Colorbar | Sequence[Colorbar] | Sequence[None] | None = None,
# ``Sequence[Colorbar | None]`` so that the list of colorbars returned by
# this function can be passed straight back in, which is how you plot into
# the same axes again. A ``Sequence[Colorbar]`` is also one of these.
colorbars: Colorbar | Sequence[Colorbar | None] | None = None,
rescale_axes: bool = True,
auto_color_scale: bool | None = None,
cutoff_percentile: tuple[float, float] | float | None = None,
Expand Down Expand Up @@ -417,7 +420,7 @@ def plot_and_save_image(
def plot_by_id(
run_id: int,
axes: Axes | Sequence[Axes] | None = None,
colorbars: Colorbar | Sequence[Colorbar] | None = None,
colorbars: Colorbar | Sequence[Colorbar | None] | None = None,
rescale_axes: bool = True,
auto_color_scale: bool | None = None,
cutoff_percentile: tuple[float, float] | float | None = None,
Expand Down
Loading