Split view user label

[Rdornier]

Hello @knabar, @will-moore,

Small contribution on Split_View_Figure plugin, asked by one of our users. I added support to enter a custom label, which enable users to also not put any labels.

The corresponding python script will be updated accordingly in another PR

[Rdornier]

Linked PR ome/omero-scripts#229

[will-moore]

Changes work fine with the updated script (and will also work without the updated script if you don't choose the Custom option). 👍

[Rdornier]

Thanks👍
I'm also on the way to add a different label for each image. Currently, the same custom label is applied to all images. I should finish the fix this week

[Rdornier]

Should be fine now

[will-moore]

The layout gets a bit messy if the images have long names:

Either need to restrict the width of that chooser, or put it on it's own row.

[Rdornier]

Thanks @will-moore for the review.
I've put the custom label in a new row, to not interfere with the above table.

[will-moore]

Works fine and layout is fixed.

Good to merge, but need to be sure we don't release this before the corresponding script is released, as you get an error if you try to export the figure without the updated script.

[sbesson]

need to be sure we don't release this before the corresponding script is released, as you get an error if you try to export the figure without the updated script.

Is there a mechanism to be defensive about this? Specifically, in a scenario where the new script parameters is not available server side, could the functionality be disabled in the UI or could the script execution fallback to supported parameters?

[will-moore]

@sbesson I don't know of a way to achieve that with regular scripts. I've just added functionality into OMERO.figure for the app to check the version of the script, but there's nothing like that for webclient.

The error is Invalid parameters: VALUE LIST for "Image_Labels": Custom not in ['Image Name', 'Datasets', 'Tags']. It's pretty hard for the webclient to handle that and to pass different arguments to the script or give the user a message that they must update the script etc.

However, you only get this error IF you choose the new 'Custom' option, so I think that this is quite limited exposure to this issue for most users. If users continue to export as before then this PR will continue to work with the old script (just tested):

[sbesson]

Since

omero-web/omeroweb/webclient/views.py

Lines 4408 to 4411 in 2636e2f

	scriptService = conn.getScriptService()
	scriptId = scriptService.getScriptID(scriptPath)
	if scriptId < 0:
	raise AttributeError("No script found for path '%s'" % scriptPath)

is already retrieving the script ID to store it in the context, I would think the script parameters retrievable via IScript.getParams could give the information either using the script version or by checking the input parameters?

[will-moore]

Ah, yes - that's a good idea to handle it in the script UI rather than in the run_script() handling...

@Rdornier This works for me to only show "Custom" options if they're supported in the script...

--- a/omeroweb/webclient/templates/webclient/scripts/split_view_figure.html
+++ b/omeroweb/webclient/templates/webclient/scripts/split_view_figure.html
@@ -199,7 +199,9 @@
                     <option value="Image Name"  selected="True"  >Image Name</option>
                     <option value="Datasets"  >Datasets</option>
                     <option value="Tags"  >Tags</option>
-                    <option value="Custom"  >Custom</option>
+                    {% if custom_labels_supported %}
+                      <option value="Custom"  >Custom</option>
+                    {% endif %}
                 </select>
             </td>
         {% for c in channels %}
@@ -225,6 +227,7 @@
                 </table>
             </td>
         </tr>
+        {% if custom_labels_supported %}
         <tr>
             <td>
                 <div title="Custom label" class="customLabelInput" style="display:none">
@@ -233,6 +236,8 @@
                 </div>
             </td>
         </tr>
+        {% endif %}
+        custom_labels_supported {{ custom_labels_supported }}
     </table>
     {% endblock %}
 


diff --git a/omeroweb/webclient/views.py b/omeroweb/webclient/views.py
index 3b2d9fb78..78a876da7 100755
--- a/omeroweb/webclient/views.py
+++ b/omeroweb/webclient/views.py
@@ -4410,6 +4410,11 @@ def figure_script(request, scriptName, conn=None, **kwargs):
     if scriptId < 0:
         raise AttributeError("No script found for path '%s'" % scriptPath)
 
+    if scriptName == "SplitView":
+        # Check we have script that supports custom labels
+        params = scriptService.getParams(scriptId)
+        context["custom_labels_supported"] = "All_labels" in params.inputs
+
     context["template"] = template
     context["scriptId"] = scriptId

[Rdornier]

@will-moore Thanks for the code changes. It should check the script now

[will-moore]

I think that line was just for debugging in my example - can be removed