Add set/get methods for catalog style

Author: mwcraig

src/astro_image_display_api/interface_definition.py

@@ -124,9 +124,57 @@ def add_markers(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
         """
         raise NotImplementedError
 
-    # @abstractmethod
-    # def remove_all_markers(self):
-    #     raise NotImplementedError
+    @abstractmethod
+    def set_catalog_style(
+        self,
+        catalog_label: str | None = None,
+        shape: str = 'circle',
+        color: str = 'red',
+        size: float = 5.0,
+        **kwargs
+    ):
+        """
+        Set the style of the catalog markers.
+
+        Parameters
+        ----------
+        shape : str, optional
+            The shape of the markers. Default is ``'circle'``. The set of
+            supported shapes is listed below in the `Notes` section.
+        color : str, optional
+            The color of the markers. Default is ``'red'``. Permitted colors are
+            any CSS4 color name. CSS4 also permits hex RGB or RGBA colors.
+        size : float, optional
+            The size of the markers. Default is ``5.0``.
+
+        **kwargs
+            Additional keyword arguments to pass to the marker style.
+
+        Notes
+        -----
+        The following shapes are supported: "circle", "square", "crosshair", "plus",
+        "diamond".
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_catalog_style(self, catalog_label: str | None = None) -> dict:
+        """
+        Get the style of the catalog markers.
+
+        Returns
+        -------
+        dict
+            The style of the markers.
+
+        Raises
+        ------
+
+        ValueError
+            If there are multiple catalog styles set and the user has not
+            specified a `catalog_label` for which to get the style.
+        """
+        raise NotImplementedError
 
     @abstractmethod
     def reset_markers(self) -> None:

src/astro_image_display_api/widget_api_test.py

@@ -119,15 +119,46 @@ def test_zoom(self):
         self.image.zoom(2)
         assert self.image.zoom_level == 6  # 3 x 2
 
-    def test_marker_properties(self):
-        # Set the marker style
-        marker_style = {'color': 'yellow', 'radius': 10, 'type': 'cross'}
-        self.image.marker = marker_style
-        m_str = str(self.image.marker)
-        for key in marker_style.keys():
-            assert key in m_str
-
-    # TODO: add test that checks that retrieving markers with an unknown name issues no error
+    def test_set_get_catalog_style_no_labels(self):
+        # Check that getting without setting returns a dict that contains
+        # the minimum required keys
+        required_style_keys = ['color', 'shape', 'size']
+        marker_style = self.image.get_catalog_style()
+        for key in required_style_keys:
+            assert key in marker_style
+
+        # Check that setting a marker style works
+        marker_settings = dict(color='red', marker='x', size=10)
+        self.image.set_catalog_style(**marker_settings)
+
+        retrieved_style = self.image.get_catalog_style()
+        # Check that the marker style is set correctly
+        for key, value in marker_settings.items():
+            assert retrieved_style[key] == value
+
+        # Check that set accepts the output of get
+        self.image.set_catalog_style(**retrieved_style)
+
+    def test_set_get_catalog_style_with_single_label(self):
+        # Check that when there is only a single catalog label it is
+        # not necessary to provide the label on get.
+        set_style_input = dict(catalog_label='test1', color='blue',
+                                     shape='square', size=5)
+        self.image.set_catalog_style(**set_style_input)
+        retrieved_style = self.image.get_catalog_style()
+
+        assert set_style_input == retrieved_style
+
+    def test_get_catalog_style_with_multiple_labels_raises_error(self):
+        # Check that when there are multiple catalog labels, the
+        # get_catalog_style method raises an error if no label is given.
+        self.image.set_catalog_style(catalog_label='test1', color='blue',
+                                     shape='square', size=5)
+        self.image.set_catalog_style(catalog_label='test2', color='red',
+                                     shape='circle', size=10)
+
+        with pytest.raises(ValueError, match='Multiple catalog styles'):
+            self.image.get_catalog_style()
 
     def test_add_markers(self):
         data = np.arange(10).reshape(5, 2)