Skip to main content

Function: getVolumeViewportScrollInfo()

getVolumeViewportScrollInfo(viewport, volumeId, useSlabThickness): object

Calculates the number os steps the volume can scroll based on its orientation

Parameters​

• viewport: VolumeViewport

Volume viewport

• volumeId: string

Id of one of the volumes loaded on the given viewport

• useSlabThickness: boolean = false

If true, the number of steps will be calculated based on the slab thickness instead of the spacing in the normal direction

Returns​

object

number of steps the volume can scroll and its current position

currentStepIndex​

currentStepIndex: number

numScrollSteps​

numScrollSteps: number

sliceRangeInfo​

sliceRangeInfo: object

sliceRangeInfo.camera​

camera: ICamera

sliceRangeInfo.sliceRange​

sliceRange: ActorSliceRange

sliceRangeInfo.spacingInNormalDirection​

spacingInNormalDirection: number

Defined in​

packages/core/src/utilities/getVolumeViewportScrollInfo.ts:12