refactor!: rename _meshes and _volumes, remove id

meshes and volumes attributes are now public. This is a breaking change; accessing `nv._meshes` and `nv._volumes` will no longer work.

Additionally, the useless NiiVue.id attribute has been removed. The NiiVue JS lib doesn't have an id for each NiiVue object so this mirrors NiiVue's structure.

Author: AnthonyAndroulakis

examples/basic_multiplanar.ipynb

@@ -86,15 +86,6 @@
     "nv.opts.view_mode_hot_key = \"KeyN\""
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "nv.id"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,

examples/colormaps.ipynb

@@ -345,6 +345,16 @@
     "# Display for prints\n",
     "display(out)"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "339bc7d4-7138-4a66-a4f2-b473492bad54",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "nv"
+   ]
   }
  ],
  "metadata": {},

examples/mosaic.ipynb

@@ -295,7 +295,7 @@
     "nvols = nib.load(example4d).shape[-1]\n",
     "init_cols = np.ceil(np.sqrt(nib.load(example4d).shape[2]))\n",
     "\n",
-    "nv3.slice_mosaic_string = full_mosaic(coords4d, ncols=init_cols)\n",
+    "nv3.opts.slice_mosaic_string = full_mosaic(coords4d, ncols=init_cols)\n",
     "\n",
     "column_slider4d = widgets.IntSlider(\n",
     "    min=0, max=20, value=init_cols, description=\"Columns\"\n",
@@ -307,7 +307,7 @@
     "def update_mosaic4d(*args):\n",
     "    \"\"\"Update mosaic string.\"\"\"\n",
     "    nv3.volumes[0].frame4D = vol_slider4d.value\n",
-    "    nv3.slice_mosaic_string = full_mosaic(coords4d, ncols=column_slider4d.value)\n",
+    "    nv3.opts.slice_mosaic_string = full_mosaic(coords4d, ncols=column_slider4d.value)\n",
     "\n",
     "\n",
     "def update_view4d(*args):\n",

js/types.ts

@@ -78,7 +78,6 @@ export type MeshLayerModel = AnyModel<{
 }>;
 
 export type Model = AnyModel<{
-	id: string;
 	height: number;
 	volumes: Array<string>;
 	meshes: Array<string>;

js/widget.ts

@@ -11,7 +11,7 @@ import type {
 } from "./types.ts";
 import { render_volumes } from "./volume.ts";
 
-const nvMap = new Map<string, niivue.Niivue>();
+let nv: niivue.Niivue;
 
 function deserializeOptions(
 	options: Partial<Record<keyof niivue.NVConfigOptions, unknown>>,
@@ -518,18 +518,13 @@ function attachCanvasEventHandlers(nv: niivue.Niivue, model: Model) {
 
 export default {
 	async initialize({ model }: { model: Model }) {
-		const id = model.get("id");
-		console.log("Initializing called on model:", id);
 		const disposer = new Disposer();
 
-		let nv = nvMap.get(model.get("id"));
-
 		if (!nv) {
 			console.log("Creating new Niivue instance");
 			const serializedOpts = model.get("opts") ?? {};
 			const opts = deserializeOptions(serializedOpts);
 			nv = new niivue.Niivue(opts);
-			nvMap.set(model.get("id"), nv);
 		}
 
 		// Attach model event handlers
@@ -553,15 +548,11 @@ export default {
 			model.off("change:draw_lut");
 			model.off("change:draw_opacity");
 			model.off("change:change:draw_fill_overwrites");
-
-			// remove the nv instance
-			nvMap.delete(model.get("id"));
 		};
 	},
 	async render({ model, el }: { model: Model; el: HTMLElement }) {
-		const nv = nvMap.get(model.get("id"));
 		if (!nv) {
-			console.error("Niivue instance not found for model", model.get("id"));
+			console.error("Niivue instance not found for model", model);
 			return;
 		}
 

src/ipyniivue/widget.py

@@ -12,7 +12,6 @@
 import math
 import pathlib
 import typing
-import uuid
 import warnings
 
 import anywidget
@@ -331,8 +330,6 @@ class NiiVue(anywidget.AnyWidget):
 
     _esm = pathlib.Path(__file__).parent / "static" / "widget.js"
 
-    id = t.Unicode(read_only=True).tag(sync=True)
-
     height = t.Int().tag(sync=True)
     opts = t.Instance(ConfigOptions).tag(
         sync=True, to_json=serialize_options, from_json=deserialize_options
@@ -357,10 +354,6 @@ class NiiVue(anywidget.AnyWidget):
     draw_opacity = t.Float(0.8).tag(sync=True)
     draw_fill_overwrites = t.Bool(True).tag(sync=True)
 
-    @t.default("id")
-    def _default_id(self):
-        return str(uuid.uuid4())
-
     def __init__(self, height: int = 300, **options):  # noqa: D417
         r"""
         Initialize the NiiVue widget.