Skip to main content
Version: 3.13.0-beta.19 (Latest)

SegmentationService – method rename

The SegmentationService method for removing segmentation representations from a viewport has been renamed to better reflect its behavior.

Change​

3.12 (old)3.13 (new)
removeSegmentationRepresentationsremoveRepresentationsFromViewport

The signature is unchanged:

removeRepresentationsFromViewport(
  viewportId: string,
  specifier?: {
    segmentationId?: string;
    type?: SegmentationRepresentations;
  }
): void

Migration​

Replace calls to removeSegmentationRepresentations with removeRepresentationsFromViewport.

Before (3.12):

segmentationService.removeSegmentationRepresentations(viewportId);
// or with a specifier:
segmentationService.removeSegmentationRepresentations(viewportId, { segmentationId });

After (3.13):

segmentationService.removeRepresentationsFromViewport(viewportId);
// or with a specifier:
segmentationService.removeRepresentationsFromViewport(viewportId, { segmentationId });

Reason​

The new name makes it clear that the method removes representations from a specific viewport, rather than removing segmentations globally.