Skip to content

Figure can accept rects or extents as an dict with keys indicating subplot names #1014

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

Merged
clewis7 merged 3 commits into from
Mar 17, 2026
Merged

Figure can accept rects or extents as an dict with keys indicating subplot names #1014

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09907f5
extents or rects can also be an OrderedDict
kushalkolar Mar 17, 2026
d969a79
black
kushalkolar Mar 17, 2026
159a40e
even better, just regular dict
kushalkolar Mar 17, 2026
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
33 changes: 21 additions & 12 deletions fastplotlib/layouts/_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
import os
from inspect import getfullargspec
from itertools import product, chain
import os
from pathlib import Path

import numpy as np
from typing import Literal, Iterable
from inspect import getfullargspec
from warnings import warn

import pygfx
import numpy as np

import pygfx
from rendercanvas import BaseRenderCanvas

from ._utils import (
Expand All @@ -27,8 +26,8 @@ class Figure:
def __init__(
self,
shape: tuple[int, int] = (1, 1),
rects: list[tuple | np.ndarray] = None,
extents: list[tuple | np.ndarray] = None,
rects: list[tuple | np.ndarray] | dict[str, tuple | np.ndarray] = None,
extents: list[tuple | np.ndarray] | dict[str, tuple | np.ndarray] = None,
cameras: (
Literal["2d", "3d"]
| Iterable[Iterable[Literal["2d", "3d"]]]
Expand Down Expand Up @@ -60,15 +59,17 @@ def __init__(
shape: tuple[int, int], default (1, 1)
shape [n_rows, n_cols] that defines a grid of subplots

rects: list of tuples or arrays
list of rects (x, y, width, height) that define the subplots.
rects: list of tuples or arrays, or a dict mapping subplot name -> rect
list or dict of rects (x, y, width, height) that define the subplots.
If it is a dict, the keys are used as the subplot names.
rects can be defined in absolute pixels or as a fraction of the canvas.
If width & height <= 1 the rect is assumed to be fractional.
Conversely, if width & height > 1 the rect is assumed to be in absolute pixels.
width & height must be > 0. Negative values are not allowed.

extents: list of tuples or arrays
list of extents (xmin, xmax, ymin, ymax) that define the subplots.
extents: list of tuples or arrays, or a dict mapping subplot name -> extent
list or dict of extents (xmin, xmax, ymin, ymax) that define the subplots.
If it is a dict, the keys are used as the subplot names.
extents can be defined in absolute pixels or as a fraction of the canvas.
If xmax & ymax <= 1 the extent is assumed to be fractional.
Conversely, if xmax & ymax > 1 the extent is assumed to be in absolute pixels.
Expand Down Expand Up @@ -120,7 +121,7 @@ def __init__(
starting size of canvas in absolute pixels, default (500, 300)

names: list or array of str, optional
subplot names
subplot names, ignored if extents or rects are provided as a dict

"""
# create canvas and renderer
Expand Down Expand Up @@ -148,6 +149,10 @@ def __init__(
self._fpl_overlay_scene = pygfx.Scene()

if rects is not None:
if isinstance(rects, dict):
# the actual rects are the dict values, subplot names are the keys
names, rects = zip(*rects.items())

if not all(isinstance(v, (np.ndarray, tuple, list)) for v in rects):
raise TypeError(
f"rects must a list of arrays, tuples, or lists of rects (x, y, w, h), you have passed: {rects}"
Expand All @@ -157,6 +162,10 @@ def __init__(
extents = [None] * n_subplots

elif extents is not None:
if isinstance(extents, dict):
# the actual extents are the dict values, subplot names are the keys
names, extents = zip(*extents.items())

if not all(isinstance(v, (np.ndarray, tuple, list)) for v in extents):
raise TypeError(
f"extents must a list of arrays, tuples, or lists of extents (xmin, xmax, ymin, ymax), "
Expand Down
Loading