Interface: ViewportInputOptions
This type defines the shape of viewport input options, so we can throw when it is incorrect.
Properties
background?
optionalbackground:RGB
background color
Defined in
packages/core/src/types/ViewportInputOptions.ts:11
displayArea?
optionaldisplayArea:DisplayArea
displayArea of interest
Defined in
packages/core/src/types/ViewportInputOptions.ts:15
orientation?
optionalorientation:OrientationAxis|OrientationVectors
orientation of the viewport which can be either an Enum for axis Enums.OrientationAxis.[AXIAL|SAGITTAL|CORONAL|DEFAULT] or an object with viewPlaneNormal and viewUp
Defined in
packages/core/src/types/ViewportInputOptions.ts:13
parallelProjection?
optionalparallelProjection:boolean
parallel projection settings, Note that this will only be used for VOLUME_3D viewport. You can't modify the parallel projection of a stack viewport or volume viewport using viewport input options.
Defined in
packages/core/src/types/ViewportInputOptions.ts:22
suppressEvents?
optionalsuppressEvents:boolean
whether the events should be suppressed and not fired