Interface: ReferenceCompatibleOptions
It is often important to decide if a given view can display a specific view reference. For example, annotations need to know if they are shown on a view. Some operations need to know if the view COULD show the given object if certain changes were made to the view. This object allows specifying what changes are permitted in order to determine if the view could show the image.
Properties
asNearbyProjection?
optionalasNearbyProjection:boolean
As nearby projection
Defined in
packages/core/src/types/IViewport.ts:101
asOverlay?
optionalasOverlay:boolean
To see if the reference could be overlaid (labelmap, fusion) on the viewport, set this to true.
Defined in
packages/core/src/types/IViewport.ts:106
asVolume?
optionalasVolume:boolean
For a stack viewport, return true if this viewport could show the given view if it were converted into a volume viewport. Has no affect on volume viewports.
Defined in
packages/core/src/types/IViewport.ts:80
imageURI?
optionalimageURI:string
Use this imageURI for testing - may or may not be the current one. Should be a straight contains URI for the set of imageIds in any of the volumes or set of image ids. This is an optimization setting only that makes the test faster, and does not need to be provided.
Deprecated
Going away in the next release as this is no longer required
Defined in
packages/core/src/types/IViewport.ts:97
withNavigation?
optionalwithNavigation:boolean
Test whether the view could be shown if the viewport were navigated. That is, test is just changing the slice position and zoom/pan would allow showing the view. This will not return a match if the normal of the measurement and the viewport aren't the same (or opposite), but only if the slice index/focal point were changed.
Defined in
packages/core/src/types/IViewport.ts:73
withOrientation?
optionalwithOrientation:boolean
For volume viewports, return true if this viewport could show the given view if the camera was changed to a different viewNormal orientation.