Fix/update viewport ds list upon seg delete - OHIF-2425 #5729

dxlin · 2026-01-20T03:32:19Z

Context

A potential solution for
#5728
(Also a test noted in #5498)

Overlay UI is missing segmentations when they are added then removed from the segmentation panel as it is still contained in the viewport's display set list.

Changes & Results

Segmentation displayset layer is removed as part of the segmentation delete routine. Additionally, for segmentations created within viewer and not from an image source, it is cleaned up from the overall display set list (so as not to clutter the UI).

Testing

User is now able to add segmentation via overlay UI, delete (whether by accident or on purpose), and still add it back to same viewport via overlay UI without refreshing page.

Checklist

PR

[] My Pull Request title is descriptive, accurate and follows the
semantic-release format and guidelines.

Code

[] My code has been well-documented (function documentation, inline comments,
etc.)

Public Documentation Updates

[] The documentation page has been updated as necessary for any public API
additions or removals.

Tested Environment

System:
OS: Windows 11 10.0.26200
CPU: (16) x64 Intel(R) Core(TM) i7-10700 CPU @ 2.90GHz
Memory: 2.85 GB / 15.72 GB
Binaries:
Node: 22.16.0
Yarn: 1.22.22
npm: 10.9.2
Browsers:
Chrome: 144.0.7559.59
Edge: Chromium (143.0.3650.66)

[] OS:
[] Node version:
[] Browser:

-resolves segmentation missing from list (from when PACS) -safety check for missing representation (for when segmentation is deleted)

…tted to PACS)

netlify · 2026-01-20T03:32:25Z

✅ Deploy Preview for ohif-dev ready!

Name	Link
🔨 Latest commit	`68c52c1`
🔍 Latest deploy log	https://app.netlify.com/projects/ohif-dev/deploys/697c5797c7a089000709dfec
😎 Deploy Preview	https://deploy-preview-5729--ohif-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

dxlin · 2026-01-20T03:37:32Z

Quick note that this only resolves for segmentations, RTStructs are still under investigation (is not able to be loaded a second time after the first delete).

jbocce · 2026-01-20T19:05:16Z

Fixes #5728
Closes OHIF-2425

…ateViewportDSListUponSegDelete

…again in removeDisplaySetLayer)

dxlin · 2026-01-26T07:50:51Z

Hi @jbocce,

Latest commit for PR now correctly works for both segmentations and RTStructs. removeDisplaySetLayer handles segmentation representation so was not needed to be removed again.

As the commands for delete segmentation and removeDisplaySetLayer are pretty close, would it make sense to incorporate the displaySetService.deleteDisplaySet(segmentationid) snippet to removeDisplaySetLayer (this should also fix nothing happening when a segmentation created within the ohif is removed as a layer from overlay menu unless that is desired behaviour)?

jbocce · 2026-01-29T16:03:23Z

extensions/cornerstone/src/services/SegmentationService/SegmentationService.ts

+      const spInput = data as cstTypes.SegmentationPublicInput;
+      if (!spInput.representation?.type) {
+        // Safety check to prevent missing representation field error
+        console.warn(


When do we get into this situation? Do we actually have examples where the representation type is not defined? I tried the example for this PR, put a break point here and never hit it.

jbocce · 2026-01-29T16:32:35Z

extensions/cornerstone/src/commandsModule.ts

+
+      // Cleanup segmentation from display set if not from image source
+      const seg = segmentationService.getSegmentation(segmentationId);
+      if (seg && seg.predecessorImageId === undefined) {


A couple of things here...

We still want to do a segmentationService.remove(segmentationId); always - even when seg.predecessorImageId is defined. I tried the PR deployment, hydrated a SEG via double click but then could not delete it. Likely this if was the reason

The display set for the "manually" added display sets are created and added in setUpSegmentationEventHandlers. Likewise they should be deleted there as well - probably as a result of SEGMENTATION_REMOVED event.

I think it is best to use the displaySet.madeInClient flag to check if the display set should be deleted or not

So I think it is best to replace this whole if with segmentationService.remove(segmentationId); and do the display set deletion in setUpSegmentationEventHandlers

segmentationService.remove(segmentationId)
-The reason for the if statement was to resolve an issue with adding RTStructs back in after a deletion (issue resolved after keeping the remove inside if)
-> there may be difference with how SEG/RTstructs are handled/loaded via overlay and double clicking and this if statement may just be hiding some other issue

setUpSegmentationEventHandlers
-I see that the SEGMENTATION_REMOVED event is actually handled by SEGMENTATION_MODIFIED (ultimately by setupSegmentationModifiedHandler under utils\segmentationHandlers.ts), is the recommendation for a check to happen here and then delete the display set? or should the REMOVED event be pulled out and handled differently?

madeInClient
-I had previously attempted to try using this flag but it didn't match my expectations, admittedly I did not spend too much time trying to use it. I can try to look into this a bit more

jbocce · 2026-01-29T17:08:33Z

extensions/cornerstone/src/commandsModule.ts

+      }
+
+      // Cleanup segmentation from display set layer
+      const viewportId = viewportGridService.getActiveViewportId();


This code removes the layer display set only from the active viewport. But what happens if the segmentation were overlaying several viewports? I am also wondering if this is the correct place to do this or not, but I think it will do for now.

The actual removal of displaysetlayer was fine for the activeViewport in my testing; however, I can confirm the deleteDisplaySet will cause issues if the segmentation is loaded in another viewport.

segmentations from PACS/Image source should be fine as we should be trying to not delete the display set; however, those madeInClient will run into issues (I've found I needed to add some extra displayset null checks, but this may just be hiding a problem that I'm not handling the delete cleanly).

jbocce

Thanks very much for this. See my comments. Also as I noted in a private conversation with you please address removing a segmentation from a viewport as well. See the video...

ScreenHunter.Jan.29.10.34.mp4

…ateViewportDSListUponSegDelete

…play set)

dxlin · 2026-01-30T07:49:34Z

Added relevant code within removeSegmentationFromViewport as well; however, after pulling most recent commits (likely Jan. 27 ones) I'm running into a number of new issues with segmentations, will try to work through and apply suggestions noted in comments as well.

An example of new issue is I'm sometimes finding segmentations previously removed added back in now (additionally, adding segmentations to one viewport will end up adding it to other viewports with images that share a FoR).

dxlin added 2 commits January 19, 2026 21:13

-remove display set from viewport when segmentation deleted

b7702c8

-resolves segmentation missing from list (from when PACS) -safety check for missing representation (for when segmentation is deleted)

-fix for deleting segmentations creating within viewer (and not commi…

30c256e

…tted to PACS)

jbocce self-requested a review January 20, 2026 18:45

jbocce changed the title ~~Fix/update viewport ds list upon seg delete~~ Fix/update viewport ds list upon seg delete - OHIF-2425 Jan 21, 2026

dxlin added 2 commits January 25, 2026 23:34

Merge branch 'master' of https://github.com/ohif/viewers into fix/upd…

b0ea40d

…ateViewportDSListUponSegDelete

-prevent duplicate segmentation removal (deleteSegmentation and then …

3f048b9

…again in removeDisplaySetLayer)

jbocce reviewed Jan 29, 2026

View reviewed changes

jbocce requested changes Jan 29, 2026

View reviewed changes

dxlin added 2 commits January 30, 2026 01:58

Merge branch 'master' of https://github.com/ohif/viewers into fix/upd…

4a236b6

…ateViewportDSListUponSegDelete

-handle remove from viewport command (similar to delete, but keep dis…

68c52c1

…play set)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix/update viewport ds list upon seg delete - OHIF-2425 #5729

Fix/update viewport ds list upon seg delete - OHIF-2425 #5729

dxlin commented Jan 20, 2026

Uh oh!

netlify bot commented Jan 20, 2026 •

edited

Loading

Uh oh!

dxlin commented Jan 20, 2026 •

edited

Loading

Uh oh!

jbocce commented Jan 20, 2026 •

edited

Loading

Uh oh!

dxlin commented Jan 26, 2026

Uh oh!

jbocce Jan 29, 2026

Uh oh!

jbocce Jan 29, 2026 •

edited

Loading

Uh oh!

dxlin Jan 30, 2026

Uh oh!

jbocce Jan 29, 2026

Uh oh!

dxlin Jan 30, 2026

Uh oh!

jbocce left a comment

Uh oh!

dxlin commented Jan 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Fix/update viewport ds list upon seg delete - OHIF-2425 #5729

Are you sure you want to change the base?

Fix/update viewport ds list upon seg delete - OHIF-2425 #5729

Conversation

dxlin commented Jan 20, 2026

Context

Changes & Results

Testing

Checklist

PR

Code

Public Documentation Updates

Tested Environment

Uh oh!

netlify bot commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for ohif-dev ready!

Uh oh!

dxlin commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jbocce commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dxlin commented Jan 26, 2026

Uh oh!

jbocce Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

jbocce Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dxlin Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jbocce Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

dxlin Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jbocce left a comment

Choose a reason for hiding this comment

Uh oh!

dxlin commented Jan 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Jan 20, 2026 •

edited

Loading

dxlin commented Jan 20, 2026 •

edited

Loading

jbocce commented Jan 20, 2026 •

edited

Loading

jbocce Jan 29, 2026 •

edited

Loading