Refactor: update--> .set_data for more consistent naming scheme.

Author: CSSFrancis

Examples/Benchmarks/plot_benchmark_comparison.py

@@ -26,7 +26,7 @@
 +---------------+---------------------------------------------------------------+
 | Library       | What is timed                                                 |
 +===============+===============================================================+
-| anyplotlib    | ``plot.update(data)`` — float → uint8 normalise → base64      |
+| anyplotlib    | ``plot.set_data(data)`` — float → uint8 normalise → base64    |
 |               | encode → LUT rebuild → state-dict assembly → json.dumps →     |
 |               | traitlet dispatch to JS renderer.                             |
 +---------------+---------------------------------------------------------------+
@@ -228,7 +228,7 @@ def _measure_js_ms_all(pairs, n_warmup=3, n_samples=12):
 
     def _make_apl_update(plot, frames, idx):
         def _fn():
-            plot.update(frames[idx[0] % len(frames)])
+            plot.set_data(frames[idx[0] % len(frames)])
             idx[0] += 1
         return _fn
 
@@ -306,7 +306,7 @@ def _fn():
     _new_ys_apl = rng.standard_normal(n_pts).cumsum().astype(np.float32)
 
     def _make_apl1d(plot, new_y):
-        def _fn(): plot.update(new_y)
+        def _fn(): plot.set_data(new_y)
         return _fn
 
     results_1d["anyplotlib"][n_pts] = _timeit_min_ms(

Examples/Interactive/plot_interactive_fft.py

@@ -175,7 +175,7 @@ def _roi_released(event):
     log_mag, freq_x, freq_y = _compute_fft(image, x0, y0, w, h)
 
     # Push updated FFT into the right panel
-    v_fft.update(log_mag, x_axis=freq_x, y_axis=freq_y, units="1/\u00c5")
+    v_fft.set_data(log_mag, x_axis=freq_x, y_axis=freq_y, units="1/\u00c5")
 
 
 fig

Examples/plot_3d.py

@@ -63,11 +63,11 @@
 # %%
 # Update the surface data live
 # ----------------------------
-# Call :meth:`~anyplotlib.figure_plots.Plot3D.update` to replace the geometry
+# Call :meth:`~anyplotlib.figure_plots.Plot3D.set_data` to replace the geometry
 # without recreating the panel.
 
 ZZ2 = np.cos(np.sqrt(XX ** 2 + YY ** 2))
-surf.update(XX, YY, ZZ2)
+surf.set_data(XX, YY, ZZ2)
 surf.set_colormap("plasma")
 surf.set_view(azimuth=30, elevation=40)
 

Examples/plot_bar.py

@@ -8,7 +8,7 @@
 * Vertical and horizontal orientations, per-bar colours, category labels
 * **Grouped bars** — pass a 2-D *height* array ``(N, G)``
 * **Log-scale value axis** — ``log_scale=True``
-* Live data updates via :meth:`~anyplotlib.figure_plots.PlotBar.update`
+* Live data updates via :meth:`~anyplotlib.figure_plots.PlotBar.set_data`
 """
 import numpy as np
 import anyplotlib as vw
@@ -117,7 +117,7 @@
 # Side-by-side comparison — update data live
 # -------------------------------------------
 # Place two :class:`~anyplotlib.figure_plots.PlotBar` panels in one figure.
-# Call :meth:`~anyplotlib.figure_plots.PlotBar.update` to swap in Q2 data —
+# Call :meth:`~anyplotlib.figure_plots.PlotBar.set_data` to swap in Q2 data —
 # the value-axis range recalculates automatically.
 
 q1 = np.array([42, 55, 48, 63, 71, 68, 74, 81, 66, 59, 52, 78], dtype=float)
@@ -134,7 +134,7 @@
     all_months, q1, width=0.6,
     color="#ff7043", show_values=False, y_units="Q2 sales",
 )
-bar_right.update(q2)    # swap in Q2 — axis range recalculates automatically
+bar_right.set_data(q2)    # swap in Q2 — axis range recalculates automatically
 
 fig5
 
@@ -206,7 +206,7 @@
 # -------------------------------------------
 # Place two :class:`~anyplotlib.figure_plots.PlotBar` panels in one
 # :func:`~anyplotlib.figure_plots.subplots` figure.  Call
-# :meth:`~anyplotlib.figure_plots.PlotBar.update` to swap in Q2 data for the
+# :meth:`~anyplotlib.figure_plots.PlotBar.set_data` to swap in Q2 data for the
 # right panel, demonstrating how the axis range re-calculates automatically.
 
 quarters = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
@@ -236,7 +236,7 @@
 )
 
 # Swap in Q2 data — range is recalculated automatically
-bar_right.update(q2)
+bar_right.set_data(q2)
 
 fig3
 

anyplotlib/figure_plots.py

@@ -698,6 +698,8 @@ def __init__(self, data: np.ndarray,
         if origin == "lower":
             data = np.flipud(data)
 
+        self._data: np.ndarray = data.astype(float)
+
         x_axis_given = x_axis is not None
         y_axis_given = y_axis is not None
         if x_axis is None:
@@ -785,9 +787,20 @@ def to_state_dict(self) -> dict:
         return d
 
     # ------------------------------------------------------------------
-    # Data update
+    # Data
     # ------------------------------------------------------------------
-    def update(self, data: np.ndarray,
+    @property
+    def data(self) -> np.ndarray:
+        """The image data in the original user coordinate system (read-only).
+
+        Returns a float64 copy with ``writeable=False``.  To replace the
+        data call :meth:`set_data`.
+        """
+        arr = np.flipud(self._data).copy() if self._origin == "lower" else self._data.copy()
+        arr.flags.writeable = False
+        return arr
+
+    def set_data(self, data: np.ndarray,
                x_axis=None, y_axis=None, units: str | None = None) -> None:
         """Replace the image data.
 
@@ -804,6 +817,7 @@ def update(self, data: np.ndarray,
         if self._origin == "lower":
             data = np.flipud(data)
 
+        self._data = data.astype(float)
         img_u8, vmin, vmax = _normalize_image(data)
         self._raw_u8, self._raw_vmin, self._raw_vmax = img_u8, vmin, vmax
 
@@ -1278,9 +1292,9 @@ def __init__(self, data: np.ndarray,
                                       allowed=MarkerRegistry._KNOWN_MESH)
 
     # ------------------------------------------------------------------
-    # Data update
+    # Data
     # ------------------------------------------------------------------
-    def update(self, data: np.ndarray,
+    def set_data(self, data: np.ndarray,
                x_edges=None, y_edges=None, units: str | None = None) -> None:
         """Replace the mesh data (and optionally the edge arrays)."""
         data = np.asarray(data)
@@ -1535,7 +1549,7 @@ def set_zoom(self, zoom: float) -> None:
         self._state["zoom"] = float(zoom)
         self._push()
 
-    def update(self, x, y, z) -> None:
+    def set_data(self, x, y, z) -> None:
         """Replace the geometry data."""
         # Re-run the same logic as __init__ for the stored geom_type
         geom_type = self._state["geom_type"]
@@ -1856,9 +1870,20 @@ def on_primary_click(event):
         return Line1D(self, None)
 
     # ------------------------------------------------------------------
-    # Data update
+    # Data
     # ------------------------------------------------------------------
-    def update(self, data: np.ndarray, x_axis=None,
+    @property
+    def data(self) -> np.ndarray:
+        """The primary line's y-data (read-only).
+
+        Returns a float64 copy with ``writeable=False``.  To replace the
+        data call :meth:`set_data`.
+        """
+        arr = self._state["data"].copy()
+        arr.flags.writeable = False
+        return arr
+
+    def set_data(self, data: np.ndarray, x_axis=None,
                units: str | None = None, y_units: str | None = None) -> None:
         """Replace the primary line's y-data and optionally its x-axis / units.
 
@@ -3070,9 +3095,9 @@ def to_state_dict(self) -> dict:
         return d
 
     # ------------------------------------------------------------------
-    # Data update
+    # Data
     # ------------------------------------------------------------------
-    def update(self, height, x=None, x_labels=None, *, x_centers=None) -> None:
+    def set_data(self, height, x=None, x_labels=None, *, x_centers=None) -> None:
         """Replace bar heights; recalculates the value-axis range automatically.
 
         Parameters

tests/test_bar.py

@@ -14,7 +14,7 @@
   * Range / padding calculations
   * Grouped bars – 2-D height array, group_labels, group_colors
   * Log scale – log_scale flag, clamping, set_log_scale()
-  * update() – value replacement and axis recalculation
+  * set_data() – value replacement and axis recalculation
   * Display-setting mutations: set_color, set_colors, set_show_values, set_log_scale
   * _push() contract – state is propagated to the Figure
   * Layout JSON reflects "bar" kind for PlotBar panels
@@ -275,17 +275,17 @@ def test_repr_shows_groups(self):
         p = ax.bar([0, 1], [[1, 2], [3, 4]])
         assert "groups=2" in repr(p)
 
-    def test_update_2d_values(self):
+    def test_set_data_2d_values(self):
         fig, ax = apl.subplots(1, 1)
         p = ax.bar(["A", "B"], [[1, 2], [3, 4]])
-        p.update([[10, 20], [30, 40]])
+        p.set_data([[10, 20], [30, 40]])
         assert _state(p)["values"] == pytest.approx(np.array([[10, 20], [30, 40]]))
 
-    def test_update_group_count_mismatch_raises(self):
+    def test_set_data_group_count_mismatch_raises(self):
         fig, ax = apl.subplots(1, 1)
         p = ax.bar(["A", "B"], [[1, 2], [3, 4]])  # groups=2
         with pytest.raises(ValueError, match="Group count mismatch"):
-            p.update([[1, 2, 3], [4, 5, 6]])       # 3 groups → error
+            p.set_data([[1, 2, 3], [4, 5, 6]])       # 3 groups → error
 
 
 # ─────────────────────────────────────────────────────────────────────────────
@@ -341,55 +341,55 @@ def test_set_log_scale_push(self):
 
 
 # ─────────────────────────────────────────────────────────────────────────────
-# 6. update() — value replacement
+# 6. set_data() — value replacement
 # ─────────────────────────────────────────────────────────────────────────────
 
-class TestPlotBarUpdate:
+class TestPlotBarSetData:
 
     def test_update_replaces_values(self):
         p = _make_bar([1, 2, 3])
-        p.update([10, 20, 30])
+        p.set_data([10, 20, 30])
         assert _state(p)["values"] == pytest.approx(np.array([[10.0], [20.0], [30.0]]))
 
     def test_update_recalculates_data_max(self):
         p = _make_bar([1, 2, 3])
-        p.update([100, 200, 300])
+        p.set_data([100, 200, 300])
         assert _state(p)["data_max"] > 300.0
 
     def test_update_recalculates_data_min(self):
         p = _make_bar([1, 2, 3])
-        p.update([-50, -20, -10])
+        p.set_data([-50, -20, -10])
         assert _state(p)["data_min"] < -50.0
 
     def test_update_with_new_x_centers(self):
         p = _make_bar([1, 2, 3])
-        p.update([4, 5, 6], x_centers=[0.5, 1.5, 2.5])
+        p.set_data([4, 5, 6], x_centers=[0.5, 1.5, 2.5])
         assert _state(p)["x_centers"] == pytest.approx([0.5, 1.5, 2.5])
 
     def test_update_with_new_x(self):
         p = _make_bar([1, 2, 3])
-        p.update([4, 5, 6], x=[0.5, 1.5, 2.5])
+        p.set_data([4, 5, 6], x=[0.5, 1.5, 2.5])
         assert _state(p)["x_centers"] == pytest.approx([0.5, 1.5, 2.5])
 
     def test_update_with_new_x_labels(self):
         p = _make_bar([1, 2, 3], x_labels=["a", "b", "c"])
-        p.update([4, 5, 6], x_labels=["x", "y", "z"])
+        p.set_data([4, 5, 6], x_labels=["x", "y", "z"])
         assert _state(p)["x_labels"] == ["x", "y", "z"]
 
     def test_update_preserves_orient(self):
         p = _make_bar([1, 2, 3], orient="h")
-        p.update([4, 5, 6])
+        p.set_data([4, 5, 6])
         assert _state(p)["orient"] == "h"
 
     def test_update_preserves_baseline(self):
         p = _make_bar([1, 2, 3], baseline=2.0)
-        p.update([10, 20, 30])
+        p.set_data([10, 20, 30])
         assert _state(p)["baseline"] == pytest.approx(2.0)
 
-    def test_update_3d_raises(self):
+    def test_set_data_3d_raises(self):
         p = _make_bar([1, 2, 3])
         with pytest.raises(ValueError, match="1-D or 2-D"):
-            p.update(np.zeros((2, 2, 2)))
+            p.set_data(np.zeros((2, 2, 2)))
 
 
 # ─────────────────────────────────────────────────────────────────────────────
@@ -441,7 +441,7 @@ def test_panel_json_contains_kind_bar(self):
     def test_panel_json_values_after_update(self):
         fig, ax = apl.subplots(1, 1)
         p = ax.bar([1, 2, 3])
-        p.update([7, 8, 9])
+        p.set_data([7, 8, 9])
         trait_name = f"panel_{p._id}_json"
         data = json.loads(getattr(fig, trait_name))
         assert data["values"] == pytest.approx(np.array([[7.0], [8.0], [9.0]]))

tests/test_benchmarks_py.py

@@ -13,7 +13,7 @@
 1. ``_normalize_image(data)``       — NumPy cast + min/max + scale + uint8
 2. ``Plot2D._encode_bytes(img_u8)`` — base64.b64encode
 3. ``json.dumps(plot.to_state_dict())`` — full end-to-end (2D and 1D)
-4. ``plot.update(data)``            — complete Python-side round-trip
+4. ``plot.set_data(data)``          — complete Python-side round-trip
 
 Workflow
 --------
@@ -219,15 +219,15 @@ def test_bench_py_serialize_1d(n_pts, update_benchmarks):
 
 
 # ---------------------------------------------------------------------------
-# Full plot.update() round-trip (normalize + encode + build_lut + push)
+# Full plot.set_data() round-trip (normalize + encode + build_lut + push)
 # ---------------------------------------------------------------------------
 
 @pytest.mark.parametrize(
     "h,w,is_slow", _IMSHOW_SIZES,
     ids=[f"{h}x{w}" for h, w, _ in _IMSHOW_SIZES],
 )
-def test_bench_py_update_2d(h, w, is_slow, update_benchmarks, run_slow):
-    """Python: full ``plot.update(data)`` round-trip for a ``{h}×{w}`` image.
+def test_bench_py_set_data_2d(h, w, is_slow, update_benchmarks, run_slow):
+    """Python: full ``plot.set_data(data)`` round-trip for a ``{h}×{w}`` image.
 
     Covers the complete Python-side cost of a live data refresh:
     ``_normalize_image`` + ``_encode_bytes`` + ``_build_colormap_lut``
@@ -245,7 +245,7 @@ def test_bench_py_update_2d(h, w, is_slow, update_benchmarks, run_slow):
     idx    = [0]
 
     def _one_update():
-        plot.update(frames[idx[0] % len(frames)])
+        plot.set_data(frames[idx[0] % len(frames)])
         idx[0] += 1
 
     timing = _timeit_ms(stmt=_one_update)

tests/test_imshow_params.py

@@ -135,19 +135,19 @@ def test_lower_flips_data(self):
         assert stored[0, :].max() == 255   # top row contains the global max
         assert stored[-1, :].min() == 0    # bottom row contains the global min
 
-    def test_lower_update_reapplies_flip(self):
-        """update() with origin='lower' automatically re-flips new data."""
+    def test_lower_set_data_reapplies_flip(self):
+        """set_data() with origin='lower' automatically re-flips new data."""
         fig, ax = apl.subplots()
         v = ax.imshow(DATA, origin="lower")
-        v.update(DATA)
+        v.set_data(DATA)
         stored = _decoded(v)
         assert stored[0, :].max() == 255
         assert stored[-1, :].min() == 0
 
-    def test_lower_update_reverses_new_y_axis(self):
+    def test_lower_set_data_reverses_new_y_axis(self):
         fig, ax = apl.subplots()
         v = ax.imshow(DATA, origin="lower")
-        v.update(DATA, y_axis=Y)
+        v.set_data(DATA, y_axis=Y)
         assert v._state["y_axis"][0]  == pytest.approx(40.0)
         assert v._state["y_axis"][-1] == pytest.approx(10.0)
 

tests/test_widgets.py

@@ -588,7 +588,7 @@ def test_drag_rectangle_updates_fft(self):
         def on_rect_changed(event):
             log_mag, freq_x, freq_y = self._compute_fft(
                 img, event.x, event.y, event.w, event.h)
-            v_fft.update(log_mag, x_axis=freq_x, y_axis=freq_y, units="1/Å")
+            v_fft.set_data(log_mag, x_axis=freq_x, y_axis=freq_y, units="1/Å")
             updates.append({"x": event.x, "y": event.y,
                             "w": event.w, "h": event.h})