Use Matplotlib's plot customization dialog

Author: MagnusSletten

src/ert/gui/plotting/plot_window.py

@@ -51,10 +51,10 @@
 from ert.services import ServerBootFail
 from ert.utils import log_duration
 
-from .customization_dialog import PlotCustomizer
 from .plot_api import EnsembleObject, PlotApi, PlotApiKeyDefinition
-from .utils import PlotConfig, PlotContext
+from .utils import PlotConfigFactory, PlotContext
 from .utils.observation_locations import transform_observation_locations
+from .utils.plot_color_palettes import TABLEAU_10_COLOR_CYCLE
 from .utils.plot_types import ObservationPlotLocations
 from .utils.qt_creator import create_group_box, create_group_layout, create_side_panel
 from .widgets.data_type_keys_widget import DataTypeKeysWidget
@@ -206,8 +206,9 @@ def __init__(
                 self._key_definitions = []
             QApplication.restoreOverrideCursor()
 
-            self._plot_customizer = PlotCustomizer(self, self._key_definitions)
-            self._plot_customizer.settingsChanged.connect(self.keySelected)
+            self._titles: dict[str, str] = {}
+            self._x_labels: dict[str, str | None] = {}
+            self._y_labels: dict[str, str | None] = {}
             self._central_tab = QTabWidget()
 
             central_widget = QWidget()
@@ -266,7 +267,7 @@ def __init__(
 
             self._ensemble_selection_widget = EnsembleSelectionWidget(
                 plot_case_objects,
-                self._plot_customizer.get_plot_config().get_number_of_colors(),
+                len(TABLEAU_10_COLOR_CYCLE),
             )
 
             self._ensemble_selection_widget.ensembleSelectionChanged.connect(
@@ -543,9 +544,10 @@ def fetch_data(
                 except BaseException as e:
                     handle_exception(e)
 
-            plot_config = PlotConfig.create_copy(
-                self._plot_customizer.get_plot_config()
-            )
+            plot_config = PlotConfigFactory.create_plot_config_for_key(key_def)
+            plot_config.set_title(self._titles.get(key, key))
+            plot_config.set_x_label(self._x_labels.get(key))
+            plot_config.set_y_label(self._y_labels.get(key))
             plot_config.set_legend_enabled(self._general_options.legend_checkbox_state)
             plot_config.set_grid_enabled(self._general_options.grid_checkbox_state)
             plot_config.set_line_color_cycle(self._general_options.get_color_cycle())
@@ -656,7 +658,6 @@ def add_plot_widget(
         enabled: bool = True,
     ) -> None:
         plot_widget = PlotWidget(name, plotter)
-        plot_widget.customizationTriggered.connect(self.toggle_customize_dialog)
         plot_widget.axisLabelEditRequested.connect(self._edit_axis_label)
         plot_widget.titleEditRequested.connect(self._edit_title)
         plot_widget.layer_index_changed.connect(self.layer_index_changed)
@@ -669,11 +670,14 @@ def _edit_axis_label(self, axis: str) -> None:
         label_names = {"x": "x-label", "y": "y-label"}
         if axis not in label_names:
             raise ValueError(f"Unknown axis '{axis}'. Expected 'x' or 'y'.")
+        key_def = self.getSelectedKey()
+        if key_def is None:
+            return
         label_name = label_names[axis]
         title = f"Edit {label_name}"
         prompt = f"New {label_name}:"
-        plot_config = self._plot_customizer.get_plot_config()
-        current_label = plot_config.x_label() if axis == "x" else plot_config.y_label()
+        labels = self._x_labels if axis == "x" else self._y_labels
+        current_label = labels.get(key_def.key)
         if current_label is None:
             current_widget = self._central_tab.currentWidget()
             if isinstance(current_widget, PlotWidget) and current_widget._figure.axes:
@@ -689,38 +693,30 @@ def _edit_axis_label(self, axis: str) -> None:
         if not accepted:
             return
         new_label: str | None = new_label_text or None
-        if axis == "x":
-            plot_config.set_x_label(new_label)
-        else:
-            plot_config.set_y_label(new_label)
-        self._plot_customizer.update_plot_config(plot_config)
+        labels[key_def.key] = new_label
+        self.update_plot()
 
     def _edit_title(self) -> None:
+        key_def = self.getSelectedKey()
+        if key_def is None:
+            return
         title = "Edit title"
-        plot_config = self._plot_customizer.get_plot_config()
         new_title, accepted = self._general_options.get_text_input(
             title,
             "New title:",
-            plot_config.title(),
+            self._titles.get(key_def.key, key_def.key),
         )
         if not accepted:
             return
-        if new_title:
-            plot_config.set_title(new_title)
-        else:
-            key_def = self.getSelectedKey()
-            if key_def is None:
-                return
-            plot_config.set_title(key_def.key)
-        self._plot_customizer.update_plot_config(plot_config)
+        self._titles[key_def.key] = new_title or key_def.key
+        self.update_plot()
 
     @showWaitCursorWhileWaiting
     def keySelected(self) -> None:
         key_def = self.getSelectedKey()
         if key_def is None:
             self._show_no_data_message()
             return
-        self._plot_customizer.switch_plot_config_history(key_def)
 
         is_everest_specific_widget = key_def.metadata.get("data_origin") in {
             "everest_objectives",
@@ -835,9 +831,6 @@ def everest_available_widget_selection(
         self._prev_key_origin = key_def.metadata.get("data_origin")
         self.update_plot()
 
-    def toggle_customize_dialog(self) -> None:
-        self._plot_customizer.toggle_customization_dialog()
-
     def add_plot_widgets_from_plot_map(
         self, plot_map: dict[str, Callable[[], Plotter]]
     ) -> None:

src/ert/gui/plotting/widgets/plot_widget.py

@@ -17,7 +17,7 @@
 from PyQt6.QtCore import QStringListModel, Qt
 from PyQt6.QtCore import pyqtSignal as Signal
 from PyQt6.QtCore import pyqtSlot as Slot
-from PyQt6.QtGui import QAction, QCursor
+from PyQt6.QtGui import QCursor
 from PyQt6.QtWidgets import (
     QComboBox,
     QToolTip,
@@ -26,7 +26,6 @@
     QWidgetAction,
 )
 
-from ert.gui.icon_utils import load_icon
 from ert.gui.plotting.plot_api import EnsembleObject, PlotApiKeyDefinition
 from ert.gui.plotting.utils.plot_types import ObservationPlotLocations
 
@@ -55,7 +54,6 @@ def plot(
 
 
 class CustomNavigationToolbar(NavigationToolbar2QT):
-    customizationTriggered = Signal()
     layer_index_changed = Signal(int)
 
     def __init__(
@@ -67,14 +65,6 @@ def __init__(
     ) -> None:
         super().__init__(canvas, parent, coordinates)  # type: ignore
 
-        gear = load_icon("edit.svg")
-        customize_action = QAction(gear, "Customize", self)
-        customize_action.setToolTip("Customize plot settings")
-        customize_action.triggered.connect(self.customizationTriggered)
-        customize_action.triggered.connect(
-            lambda: self.logToolbarUsage(customize_action.text())
-        )
-
         layer_combobox = QComboBox()
         self._model = QStringListModel()
         layer_combobox.setModel(self._model)
@@ -84,10 +74,6 @@ def __init__(
             if str(action.text()).lower() == "subplots":
                 self.removeAction(action)
 
-            if str(action.text()).lower() == "customize":
-                self.insertAction(action, customize_action)
-                self.removeAction(action)
-
             # insert the layer widget before the coordinates widget
             if isinstance(action, QWidgetAction):
                 self._layer_action = self.insertWidget(action, layer_combobox)
@@ -120,7 +106,6 @@ def updateLayerWidget(self, layers: int) -> None:
 
 
 class PlotWidget(QWidget):
-    customizationTriggered = Signal()
     axisLabelEditRequested = Signal(str)
     titleEditRequested = Signal()
     layer_index_changed = Signal(int)
@@ -153,7 +138,6 @@ def __init__(
         vbox = QVBoxLayout()
         vbox.addWidget(self._canvas)
         self._toolbar = CustomNavigationToolbar(self._canvas, self)
-        self._toolbar.customizationTriggered.connect(self.customizationTriggered)
         self._toolbar.layer_index_changed.connect(self.layer_index_changed)
         self.updateLayerWidget.connect(self._toolbar.updateLayerWidget)
         self.resetLayerWidget.connect(self._toolbar.resetLayerWidget)

tests/ert/unit_tests/gui/tools/plot/test_plot_window.py

@@ -1039,6 +1039,9 @@ def _create_plot_window_for_text_edit(
     monkeypatch.setattr("ert.gui.plotting.plot_window.PlotApi", mock_plot_api_cls)
     plot_window = PlotWindow(config_file="", ens_path=Path(), parent=None)
     qtbot.addWidget(plot_window)
+    plot_window.getSelectedKey = MagicMock(
+        return_value=MagicMock(key="some_key", dimensionality=1, metadata={})
+    )
     return plot_window
 
 
@@ -1086,12 +1089,8 @@ def test_that_sidebar_axis_label_edit_uses_configured_or_visible_label(
     plot_window = _create_plot_window_for_text_edit(qtbot, monkeypatch)
     get_text_input = MagicMock(return_value=("", False))
     plot_window._general_options.get_text_input = get_text_input
-    plot_config = plot_window._plot_customizer.get_plot_config()
-    if axis == "x":
-        plot_config.set_x_label(configured_label)
-    else:
-        plot_config.set_y_label(configured_label)
-    plot_window._plot_customizer.update_plot_config(plot_config)
+    labels = plot_window._x_labels if axis == "x" else plot_window._y_labels
+    labels["some_key"] = configured_label
     current_widget = plot_window._central_tab.currentWidget()
     assert isinstance(current_widget, PlotWidget)
     if visible_label is not None:
@@ -1140,36 +1139,19 @@ def test_that_axis_label_edit_updates_or_preserves_persistent_config(
     plot_window = _create_plot_window_for_text_edit(qtbot, monkeypatch)
     get_text_input = MagicMock(return_value=(new_label, accepted))
     plot_window._general_options.get_text_input = get_text_input
-    plot_config = plot_window._plot_customizer.get_plot_config()
-    if axis == "x":
-        plot_config.set_x_label(current_label)
-    else:
-        plot_config.set_y_label(current_label)
-    plot_window._plot_customizer.update_plot_config(plot_config)
+    plot_window.update_plot = MagicMock()
+    labels = plot_window._x_labels if axis == "x" else plot_window._y_labels
+    labels["some_key"] = current_label
 
     plot_window._edit_axis_label(axis)
 
     expected_label = (new_label or None) if accepted else current_label
-    persisted_config = plot_window._plot_customizer.get_plot_config()
-    assert (
-        persisted_config.x_label() if axis == "x" else persisted_config.y_label()
-    ) == expected_label
+    assert labels["some_key"] == expected_label
     get_text_input.assert_called_once_with(
         f"Edit {axis}-label", f"New {axis}-label:", current_label
     )
 
 
-def _create_plot_window_for_title_edit(
-    qtbot: QtBot,
-    monkeypatch: pytest.MonkeyPatch,
-) -> PlotWindow:
-    plot_window = _create_plot_window_for_text_edit(qtbot, monkeypatch)
-    plot_window.getSelectedKey = MagicMock(
-        return_value=MagicMock(key="some_key", dimensionality=1, metadata={})
-    )
-    return plot_window
-
-
 @pytest.mark.parametrize(
     ("dialog_value", "expected_title", "accepted"),
     [
@@ -1190,19 +1172,15 @@ def test_that_title_edit_updates_or_preserves_persistent_config(
     expected_title: str,
     accepted: bool,
 ) -> None:
-    plot_window = _create_plot_window_for_title_edit(qtbot, monkeypatch)
+    plot_window = _create_plot_window_for_text_edit(qtbot, monkeypatch)
     get_text_input = MagicMock(return_value=(dialog_value, accepted))
     plot_window._general_options.get_text_input = get_text_input
     plot_window.update_plot = MagicMock()
-    plot_window._plot_customizer._emit_changed_signal = MagicMock()
-    plot_config = plot_window._plot_customizer.get_plot_config()
-    plot_config.set_title("Existing title")
-    plot_window._plot_customizer.update_plot_config(plot_config)
+    plot_window._titles["some_key"] = "Existing title"
 
     plot_window._edit_title()
 
-    persisted_config = plot_window._plot_customizer.get_plot_config()
-    assert persisted_config.title() == expected_title
+    assert plot_window._titles["some_key"] == expected_title
     get_text_input.assert_called_once_with("Edit title", "New title:", "Existing title")
 
 
@@ -1258,9 +1236,7 @@ def test_that_clearing_custom_title_restores_key_title_when_rendering(
     plot_window._general_options.get_text_input = MagicMock(return_value=("", True))
     plot_window.update_plot()
 
-    plot_config = plot_window._plot_customizer.get_plot_config()
-    plot_config.set_title("Custom title")
-    plot_window._plot_customizer.update_plot_config(plot_config)
+    plot_window._titles["some_key"] = "Custom title"
     plot_window._edit_title()
 
     plot_widget = plot_window._central_tab.currentWidget()