Merge pull request #1202 from girder/config-metadata

Allow configuring which metadata can be added to items

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Added an internal field to report populated tile levels in some sources ([#1197](../../pull/1197), [#1199](../../pull/1199))
 - Allow specifying an empty style dict ([#1200](../../pull/1200))
 - Allow rounding histogram bin edges and reducing bin counts ([#1201](../../pull/1201))
+- Allow configuring which metadata can be added to items ([#1202](../../pull/1202))
 
 ### Changes
 - Change how extensions and fallback priorities interact ([#1192](../../pull/1192))

docs/girder_config_options.rst

@@ -45,6 +45,9 @@ The yaml file has the following structure:
 .large_image_config.yaml
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
+Items Lists
+...........
+
 This is used to specify how items appear in item lists.  There are two settings, one for folders in the main Girder UI and one for folders in dialogs (such as when browsing in the file dialog).
 
 ::
@@ -128,6 +131,46 @@ This is used to specify how items appear in item lists.  There are two settings,
 
 If there are no large images in a folder, none of the image columns will appear.
 
+Item Metadata
+.............
+
+By default, item metadata can contain any keys and values.  These can be given better titles and restricted in their data types.
+
+::
+
+    ---
+    # If present, offer to add these specific keys and restrict their datatypes
+    itemMetadata:
+      -
+        # value is the key name within the metadata
+        value: stain
+        # title is the displayed titles
+        title: Stain
+        # description is used as both a tooltip and as placeholder text
+        description: Staining method
+        # if required is true, the delete button does not appear
+        required: true
+        # If a regex is specified, the value must match
+        # regex: '^(Eosin|H&E|Other)$'
+        # If an enum is specified, the value is set via a dropdown select box
+        enum:
+          - Eosin
+          - H&E
+          - Other
+        # If a default is specified, when the value is created, it will show
+        # this value in the control
+        default: H&E
+      -
+        value: rating
+        # type can be "number", "integer", or "text" (default)
+        type: number
+        # minimum and maximum are inclusive
+        minimum: 0
+        maximum: 10
+        # Exclusive values can be specified instead
+        # exclusiveMinimum: 0
+        # exclusiveMaximum: 10
+
 Editing Configuration Files
 ---------------------------
 

girder/girder_large_image/web_client/stylesheets/metadataWidget.styl

@@ -0,0 +1,5 @@
+.g-widget-metadata-key-edit
+  font-weight bold
+
+.g-widget-metadata-row.editing .g-widget-metadata-value-input.g-widget-metadata-lientry
+  height inherit

girder/girder_large_image/web_client/templates/metadataWidget.pug

@@ -0,0 +1,22 @@
+if (accessLevel >= AccessType.WRITE)
+  .btn-group.pull-right
+    button.g-widget-metadata-add-button.btn.btn-sm.btn-primary.btn-default.dropdown-toggle(data-toggle="dropdown", title="Add Metadata")
+      i.icon-plus
+    ul.dropdown-menu.pull-right(role="menu")
+      if limetadata
+        for entry in limetadata
+          if entry && entry.value
+            li.li-metadata-menuitem(role="presentation")
+              a.li-add-metadata(metadata-key=entry.value)
+                = entry.title || entry.value
+      li(role="presentation")
+        a.g-add-simple-metadata(role="menuitem")
+          | Simple
+      li(role="presentation")
+        a.g-add-json-metadata
+          | JSON
+
+.g-widget-metadata-header
+  i.icon-tags
+  |  #{title}
+.g-widget-metadata-container

girder/girder_large_image/web_client/templates/metadatumEditWidget.pug

@@ -0,0 +1,30 @@
+if !lientry
+  input.input-sm.form-control.g-widget-metadata-key-input(type="text", value=key, placeholder="Key")
+else
+  span.g-widget-metadata-key-edit.g-widget-metadata-key-input(key=key)
+    = lientry.title || key
+
+if !lientry
+  - var rows = value.length <= 40 ? 1 : (value.length <= 100 ? 3 : 5)
+  textarea.input-sm.form-control.g-widget-metadata-value-input(placeholder="Value", rows=rows)
+    = value
+else
+  if lientry.enum
+    select.input-sm.form-control.g-widget-metadata-value-input.g-widget-metadata-lientry(title=lientry.description)
+      for enumval in lientry.enum
+        option(value=enumval, selected=enumval === value ? 'selected' : null)
+          = enumval
+  else
+    input.input-sm.form-control.g-widget-metadata-value-input.g-widget-metadata-lientry(placeholder=lientry.description || "Value", value=value, title=lientry.description)
+
+button.btn.btn-sm.btn-warning.g-widget-metadata-cancel-button(title="Cancel")
+  i.icon-cancel
+button.btn.btn-sm.btn-primary.g-widget-metadata-save-button(title="Accept")
+  i.icon-ok
+if !newDatum
+  if !lientry
+    button.btn.btn-sm.btn-primary.g-widget-metadata-toggle-button(title="Convert to JSON")
+      i.icon-cog
+  if !lientry || !lientry.required
+    button.btn.btn-sm.btn-danger.g-widget-metadata-delete-button(title="Delete")
+      i.icon-trash

girder/girder_large_image/web_client/views/configView.js

@@ -247,15 +247,15 @@ var ConfigView = View.extend({
         }
         if (ConfigView._lastliconfig === folderId && !reload) {
             if (callback) {
-                callback(ConfigView._liconfig);
+                callback(ConfigView._liconfig || {});
             }
             return $.Deferred().resolve(ConfigView._liconfig);
         }
         if (ConfigView._liconfigSettingsRequest) {
             if (ConfigView._nextliconfig === folderId) {
                 if (callback) {
-                    ConfigView._liconfigSettingsRequest.done(() => {
-                        callback(ConfigView._liconfig);
+                    ConfigView._liconfigSettingsRequest.done((val) => {
+                        callback(val || {});
                     });
                 }
                 return ConfigView._liconfigSettingsRequest;
@@ -269,7 +269,7 @@ var ConfigView = View.extend({
             val = val || {};
             ConfigView._lastliconfig = folderId;
             ConfigView._liconfigSettingsRequest = null;
-            ConfigView._liconfig = val || {};
+            ConfigView._liconfig = val;
             if (callback) {
                 callback(ConfigView._liconfig);
             }

girder/girder_large_image/web_client/views/index.js

@@ -2,10 +2,12 @@ import ConfigView from './configView';
 import ImageViewerSelectWidget from './imageViewerSelectWidget';
 import * as imageViewerWidget from './imageViewerWidget';
 import ItemViewWidget from './itemViewWidget';
+import * as MetadataWidget from './metadataWidget';
 
 export {
     ConfigView,
     ImageViewerSelectWidget,
     imageViewerWidget,
-    ItemViewWidget
+    ItemViewWidget,
+    MetadataWidget
 };