Skip to main content

Function: createVolumeActor()

createVolumeActor(props, element, viewportId, suppressEvents): Promise<VolumeActor>

Creates a volume actor based on the provided properties.

Parameters​

• props: createVolumeActorInterface

The properties for creating the volume actor.

• element: HTMLDivElement

The HTMLDivElement where the volume actor will be rendered.

• viewportId: string

The ID of the viewport where the volume actor will be displayed.

• suppressEvents: boolean = false

Optional. Specifies whether to suppress triggering events. Default is false.

Returns​

Promise<VolumeActor>

A promise that resolves to the created volume actor.

Throws​

An error if the imageVolume with the specified ID does not exist.

Defined in​

packages/core/src/RenderingEngine/helpers/createVolumeActor.ts:37