Function: setVolumesForViewports()

setVolumesForViewports(renderingEngine, volumeInputs, viewportIds, immediateRender, suppressEvents): Promise<void>

Similar to addVolumesToViewports it adds volumes to viewports; however, this method will Set the volumes on the viewports which means that the previous volumes will be removed.

Parameters

• renderingEngine: RenderingEngine

The rendering engine to use to get viewports from

• volumeInputs: IVolumeInput[]

Array of volume inputs including volumeId. Other properties such as visibility, callback, blendMode, slabThickness are optional

• viewportIds: string[]

Array of viewport IDs to add the volume to

• immediateRender: boolean = false

If true, the volumes will be rendered immediately

• suppressEvents: boolean = false

Returns

Promise<void>

A promise that resolves when all volumes have been added

Defined in

packages/core/src/RenderingEngine/helpers/setVolumesForViewports.ts:20