Add annotated range selection items: AnnotatedXRangeSelection and AnnotatedYRangeSelection

Author: PierreRaybaut

CHANGELOG.md

@@ -14,6 +14,10 @@
 * X and Y range selection items:
   * Added support for item title in parameters data set (`RangeShapeParam`)
   * This concerns the `XRangeSelection` and `YRangeSelection` items
+* New annotated X and Y range selection items:
+  * Added `AnnotatedXRangeSelection` and `AnnotatedYRangeSelection` items
+  * These items provide X and Y range selection with an annotation label
+  * They can be created using `make.annotated_xrange` and `make.annotated_yrange` functions
 
 🧹 API cleanup: removed deprecated update methods (use `update_item` instead)
 

doc/features/items/overview.rst

@@ -72,6 +72,8 @@ The following annotation items are available:
 
 * :py:class:`.AnnotatedPoint`
 * :py:class:`.AnnotatedSegment`
+* :py:class:`.AnnotatedXRangeSelection`
+* :py:class:`.AnnotatedYRangeSelection`
 * :py:class:`.AnnotatedRectangle`
 * :py:class:`.AnnotatedObliqueRectangle`
 * :py:class:`.AnnotatedEllipse`

doc/features/items/reference.rst

@@ -118,6 +118,10 @@ Annotations
    :members:
 .. autoclass:: plotpy.items.AnnotatedSegment
    :members:
+.. autoclass:: plotpy.items.AnnotatedXRangeSelection
+   :members:
+.. autoclass:: plotpy.items.AnnotatedYRangeSelection
+   :members:
 .. autoclass:: plotpy.items.AnnotatedRectangle
    :members:
 .. autoclass:: plotpy.items.AnnotatedObliqueRectangle

plotpy/builder/annotation.py

@@ -30,6 +30,8 @@
     AnnotatedPolygon,
     AnnotatedRectangle,
     AnnotatedSegment,
+    AnnotatedXRangeSelection,
+    AnnotatedYRangeSelection,
 )
 from plotpy.styles import AnnotationParam
 
@@ -138,6 +140,8 @@ def __annotated_shape(
         transform_matrix,
         readonly,
         private,
+        section: str = "plot",
+        option: str = "shape/drag",
     ):
         param = self.__get_annotationparam(
             title=title,
@@ -155,7 +159,7 @@ def __annotated_shape(
             shape = shapeclass(points, annotationparam=param)
         else:
             shape = shapeclass(*points, annotationparam=param)
-        shape.set_style("plot", "shape/drag")
+        shape.set_style(section, option)
         return shape
 
     def annotated_rectangle(
@@ -385,6 +389,108 @@ def annotated_segment(
             private,
         )
 
+    def annotated_xrange(
+        self,
+        x0: float,
+        x1: float,
+        title: str | None = None,
+        subtitle: str | None = None,
+        show_label: bool | None = None,
+        show_computations: bool | None = None,
+        show_subtitle: bool | None = None,
+        format: str | None = None,
+        uncertainty: float | None = None,
+        transform_matrix: np.ndarray | None = None,
+        readonly: bool | None = None,
+        private: bool | None = None,
+    ) -> AnnotatedXRangeSelection:
+        """Make an annotated x-range selection `plot item`
+
+        Args:
+            x0: lower x coordinate
+            x1: upper x coordinate
+            title: label name. Default is None
+            subtitle: label subtitle. Default is None
+            show_label: show label. Default is None
+            show_computations: show computations. Default is None
+            show_subtitle: show subtitle. Default is None
+            format: string formatting. Default is None
+            uncertainty: measurement relative uncertainty. Default is None
+            transform_matrix: transform matrix. Default is None
+            readonly: readonly. Default is None
+            private: private. Default is None
+
+        Returns:
+            :py:class:`.AnnotatedXRangeSelection` object
+        """
+        return self.__annotated_shape(
+            AnnotatedXRangeSelection,
+            (x0, x1),
+            title,
+            subtitle,
+            show_label,
+            show_computations,
+            show_subtitle,
+            format,
+            uncertainty,
+            transform_matrix,
+            readonly,
+            private,
+            section="plot",
+            option="range",
+        )
+
+    def annotated_yrange(
+        self,
+        y0: float,
+        y1: float,
+        title: str | None = None,
+        subtitle: str | None = None,
+        show_label: bool | None = None,
+        show_computations: bool | None = None,
+        show_subtitle: bool | None = None,
+        format: str | None = None,
+        uncertainty: float | None = None,
+        transform_matrix: np.ndarray | None = None,
+        readonly: bool | None = None,
+        private: bool | None = None,
+    ) -> AnnotatedYRangeSelection:
+        """Make an annotated y-range selection `plot item`
+
+        Args:
+            y0: lower y coordinate
+            y1: upper y coordinate
+            title: label name. Default is None
+            subtitle: label subtitle. Default is None
+            show_label: show label. Default is None
+            show_computations: show computations. Default is None
+            show_subtitle: show subtitle. Default is None
+            format: string formatting. Default is None
+            uncertainty: measurement relative uncertainty. Default is None
+            transform_matrix: transform matrix. Default is None
+            readonly: readonly. Default is None
+            private: private. Default is None
+
+        Returns:
+            :py:class:`.AnnotatedYRangeSelection` object
+        """
+        return self.__annotated_shape(
+            AnnotatedYRangeSelection,
+            (y0, y1),
+            title,
+            subtitle,
+            show_label,
+            show_computations,
+            show_subtitle,
+            format,
+            uncertainty,
+            transform_matrix,
+            readonly,
+            private,
+            section="plot",
+            option="range",
+        )
+
     def annotated_polygon(
         self,
         points: np.ndarray,

plotpy/config.py

@@ -513,6 +513,25 @@ def get_plotpy_defaults() -> dict[str, int | float | str | bool]:
             "shape/label/bgalpha": 0.25,
             "shape/label/abspos": False,
             "shape/label/move_anchor": True,
+            "range/line/style": "SolidLine",
+            "range/line/color": "#93ffdb",
+            "range/line/width": 1.0,
+            "range/sel_line/style": "SolidLine",
+            "range/sel_line/color": "#33ffdb",
+            "range/sel_line/width": 2.0,
+            "range/fill": "#33ffdb",
+            "range/shade": 0.1,
+            "range/symbol/marker": "Ellipse",
+            "range/symbol/size": 7,
+            "range/symbol/edgecolor": "#93ffdb",
+            "range/symbol/facecolor": "#93ffdb",
+            "range/symbol/alpha": 1.0,
+            "range/sel_symbol/marker": "Ellipse",
+            "range/sel_symbol/size": 9,
+            "range/sel_symbol/edgecolor": "#33ffdb",
+            "range/sel_symbol/facecolor": "#33ffdb",
+            "range/sel_symbol/alpha": 0.9,
+            "range/multi/color": "#806060",
             "label/symbol/marker": "NoSymbol",
             "label/symbol/size": 0,
             "label/symbol/edgecolor": MAIN_BG_COLOR,

plotpy/data/icons/xrange.png renamed to plotpy/data/icons/shapes/xrange.png

@@ -616,6 +616,8 @@ def register_serializable_items(modname, classnames):
         "Axes",
         "AnnotatedPoint",
         "AnnotatedSegment",
+        "AnnotatedXRangeSelection",
+        "AnnotatedYRangeSelection",
         "AnnotatedRectangle",
         "AnnotatedObliqueRectangle",
         "AnnotatedEllipse",

plotpy/data/icons/yrange.png renamed to plotpy/data/icons/shapes/yrange.png

@@ -11,6 +11,8 @@
     AnnotatedRectangle,
     AnnotatedPolygon,
     AnnotatedSegment,
+    AnnotatedXRangeSelection,
+    AnnotatedYRangeSelection,
     AnnotatedShape,
 )
 from .contour import ContourItem, create_contour_items