Skip to main content

Function: removeSegmentationRepresentations()

removeSegmentationRepresentations(viewportId, specifier, immediate?): object[]

Removes all segmentation representations from a viewport.

Parameters​

• viewportId: string

The ID of the viewport.

• specifier

• specifier.segmentationId?: string

• specifier.type?: SegmentationRepresentations

• immediate?: boolean

Optional. If true, the removal is performed immediately.

Returns​

object[]

Remarks​

If no specifier is provided, all segmentation representations for the viewport are removed. If a segmentationId specifier is provided, only the segmentation representation with the specified segmentationId and type are removed. If a type specifier is provided, only the segmentation representation with the specified type are removed. If both a segmentationId and type specifier are provided, only the segmentation representation with the specified segmentationId and type are removed.

Defined in​

tools/src/stateManagement/segmentation/removeSegmentationRepresentations.ts:47