set mpl style parameters from napari theme

Author: Chris-N-K

src/napari_matplotlib/base.py

@@ -5,6 +5,7 @@
 import matplotlib
 import matplotlib.style as mplstyle
 import napari
+from napari.utils.theme import get_theme
 from matplotlib.backends.backend_qtagg import (  # type: ignore[attr-defined]
     FigureCanvasQTAgg,
     NavigationToolbar2QT,
@@ -13,7 +14,7 @@
 from qtpy.QtGui import QIcon
 from qtpy.QtWidgets import QLabel, QVBoxLayout, QWidget
 
-from .util import Interval, from_napari_css_get_size_of
+from .util import Interval, from_napari_css_get_size_of, style_sheet_from_theme
 
 __all__ = ["BaseNapariMPLWidget", "NapariMPLWidget", "SingleAxesWidget"]
 
@@ -45,10 +46,11 @@ def __init__(
     ):
         super().__init__(parent=parent)
         self.viewer = napari_viewer
-        self._mpl_style_sheet_path: Optional[Path] = None
+        #self._mpl_style_sheet_path: Optional[Path] = None
+        self.napari_theme_style_sheet = style_sheet_from_theme(get_theme(napari_viewer.theme, as_dict=False))
 
         # Sets figure.* style
-        with mplstyle.context(self.mpl_style_sheet_path):
+        with mplstyle.context(self.napari_theme_style_sheet):
             self.canvas = FigureCanvasQTAgg()  # type: ignore[no-untyped-call]
 
         self.canvas.figure.set_layout_engine("constrained")
@@ -68,23 +70,23 @@ def figure(self) -> Figure:
         """Matplotlib figure."""
         return self.canvas.figure
 
-    @property
-    def mpl_style_sheet_path(self) -> Path:
-        """
-        Path to the set Matplotlib style sheet.
-        """
-        if self._mpl_style_sheet_path is not None:
-            return self._mpl_style_sheet_path
-        elif (_CUSTOM_STYLE_PATH).exists():
-            return _CUSTOM_STYLE_PATH
-        elif self._napari_theme_has_light_bg():
-            return Path(__file__).parent / "styles" / "light.mplstyle"
-        else:
-            return Path(__file__).parent / "styles" / "dark.mplstyle"
-
-    @mpl_style_sheet_path.setter
-    def mpl_style_sheet_path(self, path: Path) -> None:
-        self._mpl_style_sheet_path = Path(path)
+    #@property
+    #def mpl_style_sheet_path(self) -> Path:
+    #    """
+    #    Path to the set Matplotlib style sheet.
+    #    """
+    #    if self._mpl_style_sheet_path is not None:
+    #        return self._mpl_style_sheet_path
+    #    elif (_CUSTOM_STYLE_PATH).exists():
+    #        return _CUSTOM_STYLE_PATH
+    #    elif self._napari_theme_has_light_bg():
+    #        return Path(__file__).parent / "styles" / "light.mplstyle"
+    #    else:
+    #        return Path(__file__).parent / "styles" / "dark.mplstyle"
+
+    #@mpl_style_sheet_path.setter
+    #def mpl_style_sheet_path(self, path: Path) -> None:
+    #    self._mpl_style_sheet_path = Path(path)
 
     def add_single_axes(self) -> None:
         """
@@ -94,13 +96,14 @@ def add_single_axes(self) -> None:
         """
         # Sets axes.* style.
         # Does not set any text styling set by axes.* keys
-        with mplstyle.context(self.mpl_style_sheet_path):
+        with mplstyle.context(self.napari_theme_style_sheet):
             self.axes = self.figure.add_subplot()
 
     def _on_napari_theme_changed(self) -> None:
         """
         Called when the napari theme is changed.
         """
+        self.napari_theme_style_sheet = style_sheet_from_theme(get_theme(self.napari_viewer.theme, as_dict=False))
         self._replace_toolbar_icons()
 
     def _napari_theme_has_light_bg(self) -> bool:
@@ -252,7 +255,7 @@ def _draw(self) -> None:
         """
         # Clearing axes sets new defaults, so need to make sure style is applied when
         # this happens
-        with mplstyle.context(self.mpl_style_sheet_path):
+        with mplstyle.context(self.napari_theme_style_sheet):
             self.clear()
         if self.n_selected_layers in self.n_layers_input and all(
             isinstance(layer, self.input_layer_types) for layer in self.layers
@@ -300,7 +303,7 @@ def clear(self) -> None:
         """
         Clear the axes.
         """
-        with mplstyle.context(self.mpl_style_sheet_path):
+        with mplstyle.context(self.napari_theme_style_sheet):
             self.axes.clear()
 
 

src/napari_matplotlib/util.py

@@ -1,8 +1,9 @@
-from typing import Optional, Union
+from typing import Dict, Optional, Union
 from warnings import warn
 
 import napari.qt
 import tinycss2
+from napari.utils.theme import Theme
 from qtpy.QtCore import QSize
 
 
@@ -138,3 +139,29 @@ def from_napari_css_get_size_of(
         RuntimeWarning,
     )
     return QSize(*fallback)
+
+
+def style_sheet_from_theme(theme: Theme) -> Dict[str, str]:
+    return {
+        'axes.edgecolor':theme.secondary.as_hex(),
+        # alternatively "axes.facecolor" could be background color or not be set at all, 
+        # but this causes problems when saving figure as image
+        'axes.facecolor':theme.canvas.as_hex(),
+        'axes.labelcolor':theme.text.as_hex(),
+        'boxplot.boxprops.color':theme.text.as_hex(),
+        'boxplot.capprops.color':theme.text.as_hex(),
+        'boxplot.flierprops.markeredgecolor':theme.text.as_hex(),
+        'boxplot.whiskerprops.color':theme.text.as_hex(),
+        'figure.edgecolor':theme.secondary.as_hex(),
+        # alternatively "figure.facecolor" could not be set, but this causes problems 
+        # when saving figure as image
+        'figure.facecolor':theme.background.as_hex(),
+        'grid.color':theme.foreground.as_hex(),
+        'legend.edgecolor':theme.secondary.as_hex(),
+        'legend.facecolor':theme.background.as_hex(),
+        'text.color':theme.text.as_hex(),
+        'xtick.color':theme.secondary.as_hex(),
+        'xtick.labelcolor':theme.text.as_hex(),
+        'ytick.color':theme.secondary.as_hex(),
+        'ytick.labelcolor':theme.text.as_hex(),
+    }