histomicsui 1.8.1.dev163__tar.gz → 1.8.1.dev194__tar.gz

{histomicsui-1.8.1.dev163 → histomicsui-1.8.1.dev194}/.pre-commit-config.yaml

@@ -48,7 +48,7 @@ repos:
   - id: codespell
     args:
       - --ignore-words-list
-      - "hist,indext,pixelx,thex,subtile,afterAll"
+      - "hist,indext,pixelx,thex,subtile,afterAll,groupE"
       - --exclude-file=histomicsui/web_client/package-lock.json
 - repo: https://github.com/syntaqx/git-hooks
   rev: v0.0.18

{histomicsui-1.8.1.dev163/histomicsui.egg-info → histomicsui-1.8.1.dev194}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: histomicsui
-Version: 1.8.1.dev163
+Version: 1.8.1.dev194
 Summary: Organize, visualize, and analyze histology images.
 Home-page: https://github.com/DigitalSlideArchive/histomicsui
 Author: Kitware, Inc.

histomicsui-1.8.1.dev194/docs/annotation_group_restrictions.rst

@@ -0,0 +1,41 @@
+Restricting Annotations to Allowed Groups
+==========================================
+
+An annotation document can restrict which style groups its elements may be assigned to by setting an ``allowed_groups`` key in the annotation's ``attributes``:
+
+::
+
+    {
+      "name": "restricted annotation",
+      "attributes": {
+        "allowed_groups": ["groupA", "groupB"]
+      },
+      "elements": [...]
+    }
+
+``allowed_groups`` may also be given as a JSON-stringified array for convenience when setting it through the UI metadata editor:
+
+::
+
+    {
+      "attributes": {
+        "allowed_groups": "[\"groupA\", \"groupB\"]"
+      }
+    }
+
+When this restriction is present, the Draw panel and the annotation element context menu will only offer the listed groups instead of every style group that exists.
+
+Validation
+----------
+
+``allowed_groups`` is only honored when it is a non-empty array of non-empty strings, or a string that parses as JSON into such an array. Any other value - a missing key, a non-array/non-JSON-array value, an unparsable string, an empty array, or an array containing no valid strings - is treated as *unrestricted*, and every existing style group is offered as usual. Duplicate entries are ignored.
+
+Auto-creation of missing groups
+--------------------------------
+
+If ``allowed_groups`` names a style group that does not yet exist, it is automatically created the first time the restriction is encountered, by copying the style (fill color, line color, line width, pattern) of the default group. The newly created groups are persisted immediately. This can happen from either the Draw panel or the annotation context menu, whichever sees the restricted annotation first.
+
+Effect on the current selection
+--------------------------------
+
+- **Draw panel**: If the currently active style group is not one of the annotation's allowed groups, the Draw panel automatically switches to the first allowed group that exists.

{histomicsui-1.8.1.dev163 → histomicsui-1.8.1.dev194}/docs/config_options.rst

@@ -56,6 +56,10 @@ _________________
           fillColor: rgba(0, 128, 0, 0.25)
           lineColor: rgb(0, 128, 0)
           lineWidth: 2
+          # patterns can be none, circle, triangle, diamond, flower(number),
+          # star(number), jack(number), where number is from 1 to 16.  Not
+          # specifying a pattern is the same as none.
+          pattern: star5
         -
           id: Blue
           fillColor: rgba(0, 0, 255, 0.25)
@@ -75,6 +79,15 @@ If a hotkey is specified for a group, it will only be active if the group was lo
         action: group
         param: Red
 
+Unselected Annotation Capacity
+______________________________
+When annotation elements are selected, the annotations not included in the user's selection have their opacity decreased to 0.33 times their specified opacity. This can be modified:
+::
+    ---
+    # A lower value will make unselected annotations more transparent.
+    unselectedOpacityMultiplier: 0.33
+
+
 UI Settings
 ___________
 

{histomicsui-1.8.1.dev163 → histomicsui-1.8.1.dev194/histomicsui.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: histomicsui
-Version: 1.8.1.dev163
+Version: 1.8.1.dev194
 Summary: Organize, visualize, and analyze histology images.
 Home-page: https://github.com/DigitalSlideArchive/histomicsui
 Author: Kitware, Inc.

{histomicsui-1.8.1.dev163 → histomicsui-1.8.1.dev194}/histomicsui.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ tox.ini
 .circleci/config.yml
 .circleci/get_version.py
 .circleci/publish_pypi.sh
+docs/annotation_group_restrictions.rst
 docs/config_options.rst
 docs/controls.rst
 docs/slicer_cli_plugins.rst
@@ -69,6 +70,7 @@ tests/test_files/sample_girder_id.anot
 tests/test_files/test_analysis_detection.xml
 tests/test_files/test_analysis_features.xml
 tests/web_client_specs/.eslintrc
+tests/web_client_specs/allowedGroupsSpec.js
 tests/web_client_specs/analysisSpec.js
 tests/web_client_specs/annotationSpec.js
 tests/web_client_specs/girderUISpec.js

{histomicsui-1.8.1.dev163 → histomicsui-1.8.1.dev194}/histomicsui.egg-info/scm_file_list.json

@@ -1,33 +1,28 @@
 {
   "files": [
+    ".circleci/config.yml",
+    ".circleci/get_version.py",
+    ".circleci/publish_pypi.sh",
     ".editorconfig",
-    "LICENSE",
-    "NOTICE",
-    "codecov.yml",
-    "pyproject.toml",
-    "setup.cfg",
     ".git-blame-ignore-revs",
     ".gitignore",
     ".pre-commit-config.yaml",
+    "LICENSE",
     "MANIFEST.in",
+    "NOTICE",
     "README.rst",
-    "requirements-dev.txt",
-    "ruff.toml",
-    "setup.py",
-    "tox.ini",
-    ".circleci/config.yml",
-    ".circleci/get_version.py",
-    ".circleci/publish_pypi.sh",
+    "codecov.yml",
+    "docs/annotation_group_restrictions.rst",
     "docs/config_options.rst",
     "docs/controls.rst",
-    "docs/slicer_cli_plugins.rst",
     "docs/images/cut.gif",
     "docs/images/difference.gif",
     "docs/images/intersect.gif",
     "docs/images/union.gif",
     "docs/images/xor.gif",
-    "histomicsui/constants.py",
+    "docs/slicer_cli_plugins.rst",
     "histomicsui/__init__.py",
+    "histomicsui/constants.py",
     "histomicsui/girder_worker_plugin.py",
     "histomicsui/handlers.py",
     "histomicsui/models/__init__.py",
@@ -40,28 +35,15 @@
     "histomicsui/models/slide.py",
     "histomicsui/rest/__init__.py",
     "histomicsui/rest/aperio.py",
-    "histomicsui/rest/image_browse_resource.py",
     "histomicsui/rest/hui_resource.py",
+    "histomicsui/rest/image_browse_resource.py",
     "histomicsui/rest/system.py",
     "histomicsui/rest/tcga.py",
-    "histomicsui/web_client/routes.js",
     "histomicsui/web_client/.gitignore",
     "histomicsui/web_client/app.js",
-    "histomicsui/web_client/events.js",
-    "histomicsui/web_client/histomicsui.ts",
-    "histomicsui/web_client/index.html",
-    "histomicsui/web_client/index.js",
-    "histomicsui/web_client/main.js",
-    "histomicsui/web_client/package-lock.json",
-    "histomicsui/web_client/package.json",
-    "histomicsui/web_client/playwright.config.ts",
-    "histomicsui/web_client/router.js",
-    "histomicsui/web_client/tsconfig.json",
-    "histomicsui/web_client/vite-env.d.ts",
-    "histomicsui/web_client/vite.config.ts",
-    "histomicsui/web_client/collections/index.js",
     "histomicsui/web_client/collections/StyleCollection.js",
     "histomicsui/web_client/collections/UserCollection.js",
+    "histomicsui/web_client/collections/index.js",
     "histomicsui/web_client/dialogs/confirmDialog.js",
     "histomicsui/web_client/dialogs/editElement.js",
     "histomicsui/web_client/dialogs/editRegionOfInterest.js",
@@ -71,9 +53,15 @@
     "histomicsui/web_client/dialogs/openAnnotatedImage.js",
     "histomicsui/web_client/dialogs/openImage.js",
     "histomicsui/web_client/dialogs/saveAnnotation.js",
-    "histomicsui/web_client/models/index.js",
+    "histomicsui/web_client/events.js",
+    "histomicsui/web_client/histomicsui.ts",
+    "histomicsui/web_client/index.html",
+    "histomicsui/web_client/index.js",
+    "histomicsui/web_client/main.js",
     "histomicsui/web_client/models/StyleModel.js",
-    "histomicsui/web_client/panels/index.js",
+    "histomicsui/web_client/models/index.js",
+    "histomicsui/web_client/package-lock.json",
+    "histomicsui/web_client/package.json",
     "histomicsui/web_client/panels/AnnotationSelector.js",
     "histomicsui/web_client/panels/DrawWidget.js",
     "histomicsui/web_client/panels/FrameSelectorWidget.js",
@@ -82,13 +70,17 @@
     "histomicsui/web_client/panels/OverviewWidget.js",
     "histomicsui/web_client/panels/RegionSelector.js",
     "histomicsui/web_client/panels/ZoomWidget.js",
+    "histomicsui/web_client/panels/index.js",
+    "histomicsui/web_client/playwright.config.ts",
+    "histomicsui/web_client/router.js",
+    "histomicsui/web_client/routes.js",
     "histomicsui/web_client/static/favicon.png",
     "histomicsui/web_client/stylesheets/body/configView.styl",
     "histomicsui/web_client/stylesheets/body/image.styl",
+    "histomicsui/web_client/stylesheets/dialogs/editStyleGroups.styl",
     "histomicsui/web_client/stylesheets/dialogs/metadataPlot.styl",
     "histomicsui/web_client/stylesheets/dialogs/openAnnotatedImage.styl",
     "histomicsui/web_client/stylesheets/dialogs/saveAnnotation.styl",
-    "histomicsui/web_client/stylesheets/dialogs/editStyleGroups.styl",
     "histomicsui/web_client/stylesheets/layout/header.styl",
     "histomicsui/web_client/stylesheets/layout/headerAnalyses.styl",
     "histomicsui/web_client/stylesheets/layout/headerImage.styl",
@@ -105,7 +97,6 @@
     "histomicsui/web_client/stylesheets/popover/annotationPopover.styl",
     "histomicsui/web_client/stylesheets/views/itemList.styl",
     "histomicsui/web_client/stylesheets/views/searchResultsView.styl",
-    "histomicsui/web_client/templates/elementProps.pug",
     "histomicsui/web_client/templates/body/configView.pug",
     "histomicsui/web_client/templates/body/image.pug",
     "histomicsui/web_client/templates/dialogs/annotatedImageList.pug",
@@ -117,6 +108,7 @@
     "histomicsui/web_client/templates/dialogs/openAnnotatedImage.pug",
     "histomicsui/web_client/templates/dialogs/openImage.pug",
     "histomicsui/web_client/templates/dialogs/saveAnnotation.pug",
+    "histomicsui/web_client/templates/elementProps.pug",
     "histomicsui/web_client/templates/layout/header.pug",
     "histomicsui/web_client/templates/layout/headerAnalyses.pug",
     "histomicsui/web_client/templates/layout/headerImage.pug",
@@ -136,57 +128,69 @@
     "histomicsui/web_client/templates/popover/annotationPopover.pug",
     "histomicsui/web_client/templates/popover/annotationPopoverMetadata.pug",
     "histomicsui/web_client/templates/popover/pixelmapContextMenu.pug",
+    "histomicsui/web_client/tests/server.ts",
+    "histomicsui/web_client/tests/spec/viewer.spec.ts",
+    "histomicsui/web_client/tests/util.ts",
+    "histomicsui/web_client/tsconfig.json",
+    "histomicsui/web_client/utilities/allowedGroups.js",
+    "histomicsui/web_client/vendor/localStorage/driver.js",
+    "histomicsui/web_client/vendor/localStorage/localstorage.js",
+    "histomicsui/web_client/vendor/localStorage/sync.js",
+    "histomicsui/web_client/vendor/localStorage/utils.js",
     "histomicsui/web_client/views/HierarchyWidget.js",
     "histomicsui/web_client/views/JobDetailsWidget.js",
     "histomicsui/web_client/views/View.js",
+    "histomicsui/web_client/views/body/ConfigView.js",
+    "histomicsui/web_client/views/body/ImageView.js",
+    "histomicsui/web_client/views/body/index.js",
     "histomicsui/web_client/views/index.js",
     "histomicsui/web_client/views/itemList.js",
     "histomicsui/web_client/views/itemPage.js",
-    "histomicsui/web_client/views/searchResultsView.js",
-    "histomicsui/web_client/views/utils.js",
-    "histomicsui/web_client/views/body/index.js",
-    "histomicsui/web_client/views/body/ConfigView.js",
-    "histomicsui/web_client/views/body/ImageView.js",
-    "histomicsui/web_client/views/layout/HeaderView.js",
     "histomicsui/web_client/views/layout/HeaderAnalysesView.js",
     "histomicsui/web_client/views/layout/HeaderImageView.js",
     "histomicsui/web_client/views/layout/HeaderUserView.js",
+    "histomicsui/web_client/views/layout/HeaderView.js",
     "histomicsui/web_client/views/layout/LoginView.js",
     "histomicsui/web_client/views/layout/index.js",
-    "histomicsui/web_client/views/popover/PixelmapContextMenu.js",
-    "histomicsui/web_client/views/popover/index.js",
     "histomicsui/web_client/views/popover/AnnotationContextMenu.js",
     "histomicsui/web_client/views/popover/AnnotationPopover.js",
-    "histomicsui/web_client/vue/index.js",
+    "histomicsui/web_client/views/popover/PixelmapContextMenu.js",
+    "histomicsui/web_client/views/popover/index.js",
+    "histomicsui/web_client/views/searchResultsView.js",
+    "histomicsui/web_client/views/utils.js",
+    "histomicsui/web_client/vite-env.d.ts",
+    "histomicsui/web_client/vite.config.ts",
     "histomicsui/web_client/vue/components/AnnotationHistoryBrowser.vue",
-    "histomicsui/web_client/vue/components/ColorPickerInput.vue",
     "histomicsui/web_client/vue/components/AnnotationHistoryBrowserContainer.vue",
     "histomicsui/web_client/vue/components/AnnotationHistoryGroup.vue",
+    "histomicsui/web_client/vue/components/ColorPickerInput.vue",
     "histomicsui/web_client/vue/components/EditHeatmapOrGridData.vue",
     "histomicsui/web_client/vue/components/EditHeatmapOrGridDataContainer.vue",
-    "histomicsui/web_client/tests/server.ts",
-    "histomicsui/web_client/tests/util.ts",
-    "histomicsui/web_client/tests/spec/viewer.spec.ts",
-    "histomicsui/web_client/vendor/localStorage/driver.js",
-    "histomicsui/web_client/vendor/localStorage/localstorage.js",
-    "histomicsui/web_client/vendor/localStorage/sync.js",
-    "histomicsui/web_client/vendor/localStorage/utils.js",
+    "histomicsui/web_client/vue/index.js",
+    "pyproject.toml",
+    "requirements-dev.txt",
+    "ruff.toml",
+    "sample_data/Easy1.png",
+    "sample_data/sample_svs_image.TCGA-DU-6399-01A-01-TS1.e8eb65de-d63e-42db-af6f-14fefbbdf7bd.svs",
+    "setup.cfg",
+    "setup.py",
     "tests/__init__.py",
+    "tests/conftest.py",
     "tests/datastore.py",
     "tests/girder_utilities.py",
-    "tests/test_image_browse_endpoints.py",
-    "tests/test_load.py",
-    "tests/test_tcga.py",
-    "tests/conftest.py",
-    "tests/test_handlers.py",
-    "tests/test_hui_rest.py",
     "tests/test_files/.histomicsui_config.yaml",
     "tests/test_files/sample.anot",
     "tests/test_files/sample.meta",
     "tests/test_files/sample_girder_id.anot",
     "tests/test_files/test_analysis_detection.xml",
     "tests/test_files/test_analysis_features.xml",
+    "tests/test_handlers.py",
+    "tests/test_hui_rest.py",
+    "tests/test_image_browse_endpoints.py",
+    "tests/test_load.py",
+    "tests/test_tcga.py",
     "tests/web_client_specs/.eslintrc",
+    "tests/web_client_specs/allowedGroupsSpec.js",
     "tests/web_client_specs/analysisSpec.js",
     "tests/web_client_specs/annotationSpec.js",
     "tests/web_client_specs/girderUISpec.js",
@@ -198,7 +202,6 @@
     "tests/web_client_specs/overviewPanelSpec.js",
     "tests/web_client_specs/panelLayoutSpec.js",
     "tests/web_client_specs/pixelmapCategorySpec.js",
-    "sample_data/Easy1.png",
-    "sample_data/sample_svs_image.TCGA-DU-6399-01A-01-TS1.e8eb65de-d63e-42db-af6f-14fefbbdf7bd.svs"
+    "tox.ini"
   ]
 }

histomicsui-1.8.1.dev194/histomicsui.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.8.0",
+  "distance": 194,
+  "node": "g639dbd6339b7b24f5ba7ea6c20a827632d7ec5c2",
+  "dirty": false,
+  "branch": "girder-5",
+  "node_date": "2026-08-11"
+}

{histomicsui-1.8.1.dev163 → histomicsui-1.8.1.dev194}/tests/test_files/.histomicsui_config.yaml

@@ -1,4 +1,5 @@
 ---
+unselectedOpacityMultiplier: 0.5
 annotationGroups:
   # If replaceGroups isn't present or false, groups will be merged with
   # existing groups.  Those that have the same name will be updated.  If

histomicsui-1.8.1.dev194/tests/web_client_specs/allowedGroupsSpec.js

@@ -0,0 +1,371 @@
+/* globals describe, it, expect, waitsFor, runs, huiTest, girderTest */
+
+girderTest.importPlugin(
+    'jobs', 'large_image', 'large_image_annotation', 'slicer_cli_web', 'histomicsui'
+);
+girderTest.addScripts([
+    '/static/built/plugins/histomicsui/huiTest.js',
+    '/static/built/plugins/histomicsui/extra/sinon.js'
+]);
+
+girderTest.promise.done(function () {
+    huiTest.startApp();
+
+    describe('allowed_groups annotation metadata tests', function () {
+        var girder, largeImageAnnotation, histomicsUI;
+
+        /**
+         * POST a new annotation with the given name/attributes/elements and fetch it back into a
+         * fresh AnnotationModel, storing the result on `result.annotation`.
+         */
+        function createAnnotation(name, attributes, elements, result) {
+            var annotationId;
+            runs(function () {
+                girder.rest.restRequest({
+                    url: 'annotation?itemId=' + huiTest.imageId(),
+                    contentType: 'application/json',
+                    processData: false,
+                    type: 'POST',
+                    data: JSON.stringify({
+                        name: name,
+                        attributes: attributes,
+                        elements: elements
+                    })
+                }).then(function (resp) {
+                    annotationId = resp._id;
+                    return null;
+                });
+            });
+            waitsFor(function () {
+                return annotationId !== undefined;
+            });
+            girderTest.waitForLoad();
+            runs(function () {
+                result.annotation = new largeImageAnnotation.models.AnnotationModel({
+                    _id: annotationId
+                });
+                result.fetched = false;
+                result.annotation.fetch().then(function () {
+                    result.fetched = true;
+                    return null;
+                });
+            });
+            waitsFor(function () {
+                return result.fetched;
+            });
+        }
+
+        function rectangleElement(x, y) {
+            return {type: 'rectangle', center: [x, y, 0], width: 4, height: 4};
+        }
+
+        describe('setup', function () {
+            it('login', function () {
+                huiTest.login();
+            });
+
+            it('open image', function () {
+                huiTest.openImage('image');
+            });
+
+            it('access plugin namespaces', function () {
+                girder = window.girder;
+                largeImageAnnotation = girder.plugins.large_image_annotation;
+                histomicsUI = girder.plugins.histomicsui;
+            });
+        });
+
+        describe('#1/#2: no restriction (missing or empty allowed_groups)', function () {
+            var result = {};
+            var drawWidget;
+
+            it('creates an annotation with no allowed_groups key', function () {
+                createAnnotation('unrestricted annotation', {}, [rectangleElement(0, 0)], result);
+            });
+
+            it('offers every existing group in the Draw panel dropdown', function () {
+                var bodyView = huiTest.app.bodyView;
+                bodyView.annotations.add(result.annotation);
+                bodyView._editAnnotation(result.annotation);
+                drawWidget = bodyView.drawWidget;
+                waitsFor(function () {
+                    return !!drawWidget._groups.length;
+                });
+                runs(function () {
+                    expect(drawWidget._getAllowedGroups()).toBe(null);
+                    var expectedIds = drawWidget._groups.map(function (m) { return m.id; }).sort();
+                    var values = drawWidget.$('.h-style-group option').map(function () {
+                        return this.value;
+                    }).get().sort();
+                    expect(values).toEqual(expectedIds);
+                });
+            });
+
+            it('offers every existing group in the context menu', function () {
+                var bodyView = huiTest.app.bodyView;
+                var element = result.annotation.elements().first();
+                bodyView._resetSelection();
+                bodyView._selectElement(element);
+                var groups = bodyView.contextMenu._getAnnotationGroups();
+                var expectedIds = bodyView.contextMenu.styles.map(function (m) { return m.id; });
+                expect(groups.sort()).toEqual(expectedIds.sort());
+            });
+
+            it('treats an empty allowed_groups list the same as no restriction', function () {
+                result.annotation.get('annotation').attributes = {allowed_groups: []};
+                expect(drawWidget._getAllowedGroups()).toBe(null);
+                result.annotation.get('annotation').attributes = {allowed_groups: 'not-an-array'};
+                expect(drawWidget._getAllowedGroups()).toBe(null);
+            });
+
+            it('accepts a JSON-stringified array as allowed_groups', function () {
+                result.annotation.get('annotation').attributes = {
+                    allowed_groups: '["groupA", "groupB"]'
+                };
+                expect(drawWidget._getAllowedGroups()).toEqual(['groupA', 'groupB']);
+                result.annotation.get('annotation').attributes = {allowed_groups: '[]'};
+                expect(drawWidget._getAllowedGroups()).toBe(null);
+            });
+        });
+
+        describe('#3/#4: restricted annotation, including auto-created groups', function () {
+            var result = {};
+            var drawWidget;
+            var defaultStyle;
+
+            it('records the default group style for comparison', function () {
+                // StyleModel has no url/urlRoot; styles are only persisted via
+                // backbone.localStorage, which is patched onto the *collection*. So a
+                // bare model must be fetched through a StyleCollection, not directly.
+                var styles = new histomicsUI.collections.StyleCollection();
+                var fetched = false;
+                runs(function () {
+                    styles.fetch().always(function () {
+                        fetched = true;
+                    });
+                });
+                waitsFor(function () {
+                    return fetched;
+                });
+                runs(function () {
+                    defaultStyle = styles.get('default');
+                });
+            });
+
+            it('creates an annotation restricted to a mix of missing groups', function () {
+                createAnnotation('restricted annotation', {
+                    allowed_groups: ['groupA', 'groupB']
+                }, [rectangleElement(10, 10)], result);
+            });
+
+            it('#4a/#4b: auto-creates every missing allowed group using the default style', function () {
+                var bodyView = huiTest.app.bodyView;
+                bodyView.annotations.add(result.annotation);
+                bodyView._editAnnotation(result.annotation);
+                drawWidget = bodyView.drawWidget;
+                waitsFor(function () {
+                    return drawWidget._groups.has('groupA') && drawWidget._groups.has('groupB');
+                });
+                runs(function () {
+                    ['groupA', 'groupB'].forEach(function (groupId) {
+                        var created = drawWidget._groups.get(groupId).toJSON();
+                        expect(created.fillColor).toBe(defaultStyle.get('fillColor'));
+                        expect(created.lineColor).toBe(defaultStyle.get('lineColor'));
+                        expect(created.lineWidth).toBe(defaultStyle.get('lineWidth'));
+                        expect(created.pattern).toBe(defaultStyle.get('pattern'));
+                    });
+                    // the active style switches to the first allowed group
+                    expect(drawWidget._style.id).toBe('groupA');
+                });
+            });
+
+            it('#3/#4c: restriction is immediately reflected in the Draw panel dropdown', function () {
+                var values = drawWidget.$('.h-style-group option').map(function () {
+                    return this.value;
+                }).get();
+                expect(values).toEqual(['groupA', 'groupB']);
+            });
+
+            it('#3/#4c: restriction is immediately reflected in the context menu', function () {
+                var bodyView = huiTest.app.bodyView;
+                // select an element of the restricted annotation so the context menu's group
+                // list reflects it, rather than a stale selection left over from a previous
+                // describe block
+                var element = result.annotation.elements().first();
+                bodyView._resetSelection();
+                bodyView._selectElement(element);
+
+                var groups = bodyView.contextMenu._getAnnotationGroups();
+                expect(groups.sort()).toEqual(['groupA', 'groupB']);
+            });
+        });
+
+        describe('#5: context menu ignores active selection, uses the clicked annotation', function () {
+            var restricted = {};
+            var unrestricted = {};
+
+            it('creates a restricted and an unrestricted annotation', function () {
+                createAnnotation('restricted annotation for #5', {
+                    allowed_groups: ['groupE', 'groupF']
+                }, [rectangleElement(30, 30)], restricted);
+            });
+
+            it('creates the unrestricted annotation', function () {
+                createAnnotation('unrestricted annotation for #5', {}, [rectangleElement(40, 40)], unrestricted);
+            });
+
+            it('auto-creates the restricted annotation\'s allowed groups (groupE/groupF) as styles', function () {
+                // briefly edit the restricted annotation in the Draw panel to create groupE and
+                // groupF before switching the active annotation below.
+                var bodyView = huiTest.app.bodyView;
+                bodyView.annotations.add(restricted.annotation);
+                bodyView._editAnnotation(restricted.annotation);
+                waitsFor(function () {
+                    return !!bodyView.drawWidget &&
+                        bodyView.drawWidget._groups.has('groupE') &&
+                        bodyView.drawWidget._groups.has('groupF');
+                });
+            });
+
+            it('restricts the context menu to the clicked element\'s annotation regardless of the active annotation/group/shape', function () {
+                var bodyView = huiTest.app.bodyView;
+
+                runs(function () {
+                    bodyView.annotations.add(unrestricted.annotation);
+                    bodyView._editAnnotation(unrestricted.annotation);
+                });
+                waitsFor(function () {
+                    return !!bodyView.drawWidget && !!bodyView.drawWidget._groups.length;
+                });
+                runs(function () {
+                    // pick an arbitrary style group in the Draw panel to prove the context menu
+                    // restriction is independent of it
+                    bodyView.drawWidget.setStyleGroupById(bodyView.drawWidget._groups.first().id);
+
+                    var element = restricted.annotation.elements().first();
+                    bodyView._resetSelection();
+                    bodyView._selectElement(element);
+
+                    var groups = bodyView.contextMenu._getAnnotationGroups();
+                    expect(groups.sort()).toEqual(['groupE', 'groupF']);
+                });
+            });
+
+            it('renders the clicked annotation\'s restriction on selection, not the active annotation\'s (regression)', function () {
+                var bodyView = huiTest.app.bodyView;
+
+                runs(function () {
+                    // keep the *unrestricted* annotation active in the panel
+                    bodyView._editAnnotation(unrestricted.annotation);
+                });
+                waitsFor(function () {
+                    return !!bodyView.drawWidget && !!bodyView.drawWidget._groups.length;
+                });
+                runs(function () {
+                    // Selecting an element fires the context menu's render synchronously.
+                    // This asserts on the DOM produced by that render, which is the path that
+                    // regressed. Previously `originalAnnotation` was assigned only after `add`,
+                    // so the render fell back to the active annotation and offered the wrong
+                    // groups when the active annotation did not match the selected one.
+                    var element = restricted.annotation.elements().first();
+                    bodyView._resetSelection();
+                    bodyView._selectElement(element);
+
+                    var renderedGroups = bodyView.contextMenu.$('.h-set-group').map(function () {
+                        return window.$(this).data('group');
+                    }).get();
+                    expect(renderedGroups.sort()).toEqual(['groupE', 'groupF']);
+                });
+            });
+        });
+
+        describe('#3/#5: live metadata updates without reselecting or reloading', function () {
+            var result = {};
+            var drawWidget;
+
+            it('creates an annotation with no restriction', function () {
+                createAnnotation('live-update annotation', {}, [rectangleElement(50, 50)], result);
+            });
+
+            it('opens the annotation while unrestricted', function () {
+                var bodyView = huiTest.app.bodyView;
+                bodyView.annotations.add(result.annotation);
+                bodyView._editAnnotation(result.annotation);
+                drawWidget = bodyView.drawWidget;
+                waitsFor(function () {
+                    return !!drawWidget._groups.length;
+                });
+                runs(function () {
+                    expect(drawWidget._getAllowedGroups()).toBe(null);
+                });
+            });
+
+            it('immediately restricts the Draw panel and context menu when allowed_groups is added, without reselecting', function () {
+                var bodyView = huiTest.app.bodyView;
+
+                var element = result.annotation.elements().first();
+                bodyView._resetSelection();
+                bodyView._selectElement(element);
+
+                // simulate editing the annotation's metadata via the "Edit annotation" dialog,
+                // which mutates attributes directly and triggers 'change:annotation' rather than
+                // calling .set()
+                result.annotation.get('annotation').attributes = {allowed_groups: ['groupG', 'groupH']};
+                result.annotation.trigger('change:annotation', result.annotation, {});
+
+                waitsFor(function () {
+                    // the Draw panel's `_groups` collection updates synchronously, but its dropdown
+                    // DOM is refreshed via a debounced render, so also wait for the DOM to catch up
+                    // before asserting on it
+                    return drawWidget._groups.has('groupG') && drawWidget._groups.has('groupH') &&
+                        drawWidget.$('.h-style-group option').length === 2;
+                });
+                runs(function () {
+                    expect(drawWidget._style.id).toBe('groupG');
+                    var drawValues = drawWidget.$('.h-style-group option').map(function () {
+                        return this.value;
+                    }).get();
+                    expect(drawValues).toEqual(['groupG', 'groupH']);
+                });
+                // the context menu keeps its own StyleCollection, refetched asynchronously via the
+                // 'h:styleGroupsEdited' event once the Draw panel auto-creates the newly allowed
+                // groups; wait for that refetch to complete before checking it
+                waitsFor(function () {
+                    return bodyView.contextMenu.styles.get('groupG') && bodyView.contextMenu.styles.get('groupH');
+                });
+                runs(function () {
+                    var contextGroups = bodyView.contextMenu._getAnnotationGroups();
+                    expect(contextGroups.sort()).toEqual(['groupG', 'groupH']);
+                });
+            });
+        });
+
+        describe('#3(consistency): the context menu auto-creates missing allowed groups', function () {
+            var restricted = {};
+
+            it('creates a restricted annotation that is never opened in the Draw panel', function () {
+                createAnnotation('context-only restricted annotation', {
+                    allowed_groups: ['groupK', 'groupL']
+                }, [rectangleElement(70, 70)], restricted);
+            });
+
+            it('auto-creates the allowed groups the first time the context menu sees them', function () {
+                var bodyView = huiTest.app.bodyView;
+                // the groups must not already exist from an earlier spec
+                expect(bodyView.contextMenu.styles.get('groupK')).toBe(undefined);
+                expect(bodyView.contextMenu.styles.get('groupL')).toBe(undefined);
+
+                // select an element of the restricted annotation without ever opening it in the
+                // Draw panel, so the context menu is the only code path that can create its groups
+                var element = restricted.annotation.elements().first();
+                bodyView._resetSelection();
+                bodyView._selectElement(element);
+
+                var groups = bodyView.contextMenu._getAnnotationGroups();
+                expect(groups.sort()).toEqual(['groupK', 'groupL']);
+                expect(bodyView.contextMenu.styles.get('groupK')).toBeTruthy();
+                expect(bodyView.contextMenu.styles.get('groupL')).toBeTruthy();
+            });
+        });
+    });
+});

{histomicsui-1.8.1.dev163 → histomicsui-1.8.1.dev194}/tests/web_client_specs/annotationSpec.js

@@ -276,13 +276,21 @@ girderTest.promise.done(function () {
                     return $('.h-elements-container .h-element').length === 2;
                 }, 'point to be created');
                 runs(function () {
-                    expect($('.h-elements-container .h-element:last .h-element-label').text()).toBe('default point 2');
+                    // Elements are sorted lexically by label, so target the newly drawn point by
+                    // its label rather than by position.
+                    expect($('.h-elements-container .h-element .h-element-label').filter(function () {
+                        return $(this).text() === 'default point 2';
+                    }).length).toBe(1);
                 });
                 checkAutoSave('drawn 1', 2, annotationInfo);
             });
 
             it('delete the second point', function () {
-                $('.h-elements-container .h-element:last .h-delete-element').click();
+                // Elements are sorted lexically by label, so delete the just drawn point by its
+                // label rather than by position.
+                $('.h-elements-container .h-element').filter(function () {
+                    return $(this).find('.h-element-label').text() === 'default point 2';
+                }).find('.h-delete-element').click();
                 expect($('.h-elements-container .h-element').length).toBe(1);
                 checkAutoSave('drawn 1', 1, annotationInfo);
             });
@@ -312,7 +320,11 @@ girderTest.promise.done(function () {
                     return $('.h-elements-container .h-element').length === 2;
                 }, 'point to be created');
                 runs(function () {
-                    expect($('.h-elements-container .h-element:last .h-element-label').text()).toBe('default point 2');
+                    // Elements are sorted lexically by label, so target the newly drawn point by
+                    // its label rather than by position.
+                    expect($('.h-elements-container .h-element .h-element-label').filter(function () {
+                        return $(this).text() === 'default point 2';
+                    }).length).toBe(1);
                 });
                 checkAutoSave('drawn 1', 2, annotationInfo);
             });
@@ -349,7 +361,11 @@ girderTest.promise.done(function () {
             });
 
             it('delete the last point', function () {
-                $('.h-elements-container .h-element:last .h-delete-element').click();
+                // Elements are sorted lexically by label, so delete the just drawn point by its
+                // label rather than by position.
+                $('.h-elements-container .h-element').filter(function () {
+                    return $(this).find('.h-element-label').text() === 'default point 2';
+                }).find('.h-delete-element').click();
                 expect($('.h-elements-container .h-element').length).toBe(1);
 
                 // reset the draw state
@@ -609,6 +625,106 @@ girderTest.promise.done(function () {
             });
         });
 
+        describe('Sort By', function () {
+            var drawWidget;
+            var testLabels = ['Alpha', 'Bravo', 'Charlie', 'Delta'];
+            var testIds = ['sort-test-alpha', 'sort-test-bravo', 'sort-test-charlie', 'sort-test-delta'];
+
+            function testElementLabels() {
+                return $('.h-elements-container .h-element-label').map(function () {
+                    return $(this).text();
+                }).get().filter(function (text) {
+                    return testLabels.indexOf(text) !== -1;
+                });
+            }
+
+            it('add elements with distinct labels, groups, and shapes', function () {
+                runs(function () {
+                    drawWidget = huiTest.app.bodyView.drawWidget;
+                    drawWidget.collection.add([
+                        {id: 'sort-test-charlie', type: 'point', label: {value: 'Charlie'}, group: 'rareGroup'},
+                        {id: 'sort-test-alpha', type: 'point', label: {value: 'Alpha'}, group: 'commonGroup'},
+                        {id: 'sort-test-bravo', type: 'rectangle', label: {value: 'Bravo'}, group: 'commonGroup'},
+                        {id: 'sort-test-delta', type: 'polyline', closed: false, label: {value: 'Delta'}, group: 'commonGroup'}
+                    ]);
+                });
+                waitsFor(function () {
+                    return testElementLabels().length === testLabels.length;
+                }, 'test elements to be added');
+            });
+
+            it('defaults to sorting by label, ascending', function () {
+                runs(function () {
+                    expect($('.h-sort-mode').val()).toBe('label');
+                    expect($('.h-sort-order i').hasClass('icon-sort-alt-up')).toBe(true);
+                    expect(testElementLabels()).toEqual(['Alpha', 'Bravo', 'Charlie', 'Delta']);
+                });
+            });
+
+            it('toggles to descending order', function () {
+                runs(function () {
+                    $('.h-sort-order').click();
+                });
+                runs(function () {
+                    expect($('.h-sort-order i').hasClass('icon-sort-alt-down')).toBe(true);
+                    expect($('.h-sort-order').attr('title')).toMatch(/^Sort descending/);
+                    expect(testElementLabels()).toEqual(['Delta', 'Charlie', 'Bravo', 'Alpha']);
+                });
+            });
+
+            it('toggles back to ascending order', function () {
+                runs(function () {
+                    $('.h-sort-order').click();
+                });
+                runs(function () {
+                    expect($('.h-sort-order i').hasClass('icon-sort-alt-up')).toBe(true);
+                    expect($('.h-sort-order').attr('title')).toMatch(/^Sort ascending/);
+                    expect(testElementLabels()).toEqual(['Alpha', 'Bravo', 'Charlie', 'Delta']);
+                });
+            });
+
+            it('sorts by group', function () {
+                runs(function () {
+                    $('.h-sort-mode').val('group').trigger('change');
+                });
+                runs(function () {
+                    var order = testElementLabels();
+                    // "commonGroup" sorts before "rareGroup" lexically.
+                    expect(order.indexOf('Charlie')).toBe(order.length - 1);
+                });
+            });
+
+            it('sorts by shape', function () {
+                runs(function () {
+                    $('.h-sort-mode').val('shape').trigger('change');
+                });
+                runs(function () {
+                    var order = testElementLabels();
+                    expect(order.indexOf('Delta')).toBeLessThan(order.indexOf('Bravo'));
+                });
+            });
+
+            it('sorts by count, rare groups first', function () {
+                runs(function () {
+                    $('.h-sort-mode').val('count').trigger('change');
+                });
+                runs(function () {
+                    var order = testElementLabels();
+                    expect(order[0]).toBe('Charlie');
+                });
+            });
+
+            it('removes the test elements and restores label sort', function () {
+                runs(function () {
+                    drawWidget.collection.remove(testIds);
+                    $('.h-sort-mode').val('label').trigger('change');
+                });
+                waitsFor(function () {
+                    return testElementLabels().length === 0;
+                }, 'test elements to be removed');
+            });
+        });
+
         describe('Annotation styles', function () {
             it('create a new annotation', function () {
                 $('.h-create-annotation').click();
@@ -1812,6 +1928,11 @@ girderTest.promise.done(function () {
         it('open image', function () {
             huiTest.openImage('image.svs', ['subfolder']);
         });
+        it('respects unselected opacity config', function () {
+            girderTest.waitForLoad();
+            expect(huiTest.app.bodyView._unselectedOpacityMultiplier).toBe(0.5);
+            expect(huiTest.app.bodyView.viewerWidget._unselectedOpacityMultiplier).toBe(0.5);
+        });
         it('create a new annotation', function () {
             girderTest.waitForLoad();
             runs(function () {

histomicsui-1.8.1.dev163/histomicsui.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "1.8.0",
-  "distance": 163,
-  "node": "g257221266a4c1e53190c222b5ef7aa81a30b5a1b",
-  "dirty": false,
-  "branch": "girder-5",
-  "node_date": "2026-07-06"
-}