fix(proxy): make ProxyManager.load return _id_remap

Kitware · May 14, 2024 · 175d92d · 175d92d
1 parent 15985e8
commit 175d92d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/api.md b/docs/api.md
@@ -65,7 +65,10 @@ def save(self, file_output=None):
     """Export state (definition+data) into a file"""
 
 def load(self, file_input=None, file_content=None):
-    """Load previously exported state from a file"""
+    """
+    Load previously exported state from a file.
+    Return the proxy id remap which is a dict with proxy id's found in the provided state as keys and the corresponding freshly created proxy id's as values.
+    """
 ```
 
 __Commit / Reset__

diff --git a/trame_simput/core/proxy.py b/trame_simput/core/proxy.py
@@ -857,6 +857,8 @@ def load(self, file_input=None, file_content=None):
         )
         self._emit("created", ids=_new_ids)
 
+        return _id_remap
+
     # -------------------------------------------------------------------------
     # Commit / Reset
     # -------------------------------------------------------------------------