Type Alias: ViewReferenceSpecifier

ViewReferenceSpecifier: object

Specifies what view to get a reference for. This set of options allows a Viewport to return a reference for an image not currently in view, such as for a different slice, or containing a given set of points.

Type declaration

forFrameOfReference?

optional forFrameOfReference: boolean

Specifies to get a view reference that refers to the generic frame of reference rather than to a specific volume or stack. Thus, the view reference would be compatible with any view showing the same frame of reference UID.

frameNumber?

optional frameNumber: number

The frame number for a multiframe

points?

optional points: Point3[]

Set of points to get a reference for, in world space

rangeEndSliceIndex?

optional rangeEndSliceIndex: number

The end index - this requires sliceIndex to be specified. This will result in a view reference containing a range, specified by the starting and ending images or by a thickness for a volume.

Note that in the view reference, this gets created as a multiSliceReference containing a ReferencedImageRange object referencing the final image in the range. The specifier is done this way because it is a logical way for users of the specifier to choose an end range, while the use of the range internally is handled as a multi slice specifier.

sliceIndex?

optional sliceIndex: number

The slice index within the current viewport camera to get a reference for. Note that slice indexes are dependent on the data in a viewport, and will be used to generate a view reference or referenced image, but are not the reference itself.

volumeId?

optional volumeId: string

The volumeId to reference

Defined in

packages/core/src/types/IViewport.ts:14