Class: VideoViewport

Extends

• Viewport

Constructors

new VideoViewport()

new VideoViewport(props): VideoViewport

Parameters

• props: VideoViewportInput

Returns

VideoViewport

Overrides

Viewport.constructor

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:127

Properties

_actors

_actors: Map<string, ActorEntry>

a Map containing the actor uid and actors

Inherited from

Viewport._actors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:139

---

_displaySets

protected _displaySets: object[] = []

Records the display sets currently mounted on the viewport. Populated by the type-specific setDisplaySets overrides (via mountDisplaySets) and cleared whenever raw data is set directly (e.g. setStack), so that getDisplaySets reflects only display-set-driven content.

Inherited from

Viewport._displaySets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:146

---

_suppressCameraModifiedEvents

_suppressCameraModifiedEvents: boolean = false

informs if a new actor was added before a resetCameraClippingRange phase

Inherited from

Viewport._suppressCameraModifiedEvents

Defined in

packages/core/src/RenderingEngine/Viewport.ts:153

---

calibration

protected calibration: IImageCalibration

Inherited from

Viewport.calibration

Defined in

packages/core/src/RenderingEngine/Viewport.ts:157

---

canvas

readonly canvas: HTMLCanvasElement

an internal canvas that is created on the provided HTML element

Inherited from

Viewport.canvas

Defined in

packages/core/src/RenderingEngine/Viewport.ts:101

---

canvasContext

readonly canvasContext: CanvasRenderingContext2D

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:65

---

defaultOptions

readonly defaultOptions: ViewportInputOptions

Default options for the viewport which includes orientation, viewPlaneNormal and backgroundColor

Inherited from

Viewport.defaultOptions

Defined in

packages/core/src/RenderingEngine/Viewport.ts:149

---

element

readonly element: HTMLDivElement

HTML element in DOM that is used for rendering the viewport

Inherited from

Viewport.element

Defined in

packages/core/src/RenderingEngine/Viewport.ts:99

---

fitToCanvasCamera

protected fitToCanvasCamera: ICamera<number>

The camera that is defined for resetting displayArea to ensure absolute displayArea settings

Inherited from

Viewport.fitToCanvasCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:165

---

flipHorizontal

protected flipHorizontal: boolean = false

Inherited from

Viewport.flipHorizontal

Defined in

packages/core/src/RenderingEngine/Viewport.ts:122

---

flipVertical

protected flipVertical: boolean = false

Inherited from

Viewport.flipVertical

Defined in

packages/core/src/RenderingEngine/Viewport.ts:123

---

hasPixelSpacing

protected hasPixelSpacing: boolean = true

Inherited from

Viewport.hasPixelSpacing

Defined in

packages/core/src/RenderingEngine/Viewport.ts:156

---

id

readonly id: string

unique identifier for the viewport

Inherited from

Viewport.id

Defined in

packages/core/src/RenderingEngine/Viewport.ts:97

---

imageId

protected imageId: string

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:62

---

initialCamera

protected initialCamera: ICamera<number>

The camera that is initially defined on the reset for the relative pan/zoom

Inherited from

Viewport.initialCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:161

---

insetImageMultiplier

protected insetImageMultiplier: number

The amount by which the images are inset in a viewport by default.

Inherited from

Viewport.insetImageMultiplier

Defined in

packages/core/src/RenderingEngine/Viewport.ts:117

---

isDisabled

isDisabled: boolean

Inherited from

Viewport.isDisabled

Defined in

packages/core/src/RenderingEngine/Viewport.ts:124

---

metadata

protected metadata: any

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:89

---

modality

modality: any

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:60

---

options

options: ViewportInputOptions

options for the viewport which includes orientation axis, backgroundColor and displayArea

Inherited from

Viewport.options

Defined in

packages/core/src/RenderingEngine/Viewport.ts:151

---

renderingEngineId

readonly renderingEngineId: string

RenderingEngine id that the viewport belongs to

Overrides

Viewport.renderingEngineId

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:64

---

requestedType?

optional requestedType: ViewportType

The viewport type originally requested by the caller, before any internal compatibility remap (e.g. STACK/ORTHOGRAPHIC requested as PLANAR_NEXT when rendering.useGenericViewport is enabled). Equals type when not remapped. Set by the rendering engine at creation. Use this when branching on the legacy viewport type so the branch is transparent across compat adapters.

Inherited from

Viewport.requestedType

Defined in

packages/core/src/RenderingEngine/Viewport.ts:113

---

sHeight

sHeight: number

sHeight of viewport on the offscreen canvas

Inherited from

Viewport.sHeight

Defined in

packages/core/src/RenderingEngine/Viewport.ts:137

---

suppressEvents

readonly suppressEvents: boolean

A flag representing if viewport methods should fire events or not

Inherited from

Viewport.suppressEvents

Defined in

packages/core/src/RenderingEngine/Viewport.ts:155

---

sWidth

sWidth: number

sWidth of viewport on the offscreen canvas

Inherited from

Viewport.sWidth

Defined in

packages/core/src/RenderingEngine/Viewport.ts:135

---

sx

sx: number

sx of viewport on the offscreen canvas

Inherited from

Viewport.sx

Defined in

packages/core/src/RenderingEngine/Viewport.ts:131

---

sy

sy: number

sy of viewport on the offscreen canvas

Inherited from

Viewport.sy

Defined in

packages/core/src/RenderingEngine/Viewport.ts:133

---

type

readonly type: ViewportType

Type of viewport

Inherited from

Viewport.type

Defined in

packages/core/src/RenderingEngine/Viewport.ts:105

---

uid

readonly uid: any

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:63

---

updateRenderingPipeline()

updateRenderingPipeline: () => void

Returns

void

Inherited from

Viewport.updateRenderingPipeline

Defined in

packages/core/src/RenderingEngine/Viewport.ts:200

---

useCustomRenderingPipeline

useCustomRenderingPipeline: boolean = true

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:681

---

viewportStatus

viewportStatus: ViewportStatus = ViewportStatus.NO_DATA

Record the rendering status, mostly for testing purposes, but can also be useful for knowing things like whether the viewport is initialized

Inherited from

Viewport.viewportStatus

Defined in

packages/core/src/RenderingEngine/Viewport.ts:128

---

CameraViewPresentation

readonly static CameraViewPresentation: ViewPresentationSelector

CameraViewPresentation is a view presentation selector that has all the camera related presentation selections, and would typically be used for choosing presentation information between two viewports showing the same type of orientation of a view, such as the CT, PT and fusion views in the same orientation view.

Inherited from

Viewport.CameraViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:77

---

frameRangeExtractor

static frameRangeExtractor: RegExp

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:58

---

TransferViewPresentation

readonly static TransferViewPresentation: ViewPresentationSelector

TransferViewPresentation is a view presentation selector that selects all the transfer function related attributes. It would typically be used for synchronizing different orientations of the same series, or for synchronizing two views of the same type of series such as a CT.

Inherited from

Viewport.TransferViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:91

Accessors

useCustomRenderingPipeline

get static useCustomRenderingPipeline(): boolean

Returns

boolean

Overrides

Viewport.useCustomRenderingPipeline

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:151

Methods

_getCorners()

_getCorners(bounds): number[][]

Parameters

• bounds: number[]

Returns

number[][]

Inherited from

Viewport._getCorners

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2315

---

_getEdges()

_getEdges(bounds): [number[], number[]][]

Returns a list of edges for the imageData bounds, which are the cube edges in the case of volumeViewport edges. p1: front, bottom, left p2: front, top, left p3: back, bottom, left p4: back, top, left p5: front, bottom, right p6: front, top, right p7: back, bottom, right p8: back, top, right

Parameters

• bounds: number[]

Bounds of the renderer

Returns

[number[], number[]][]

Edges of the containing bounds

Inherited from

Viewport._getEdges

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2411

---

_getFocalPointForResetCamera()

_getFocalPointForResetCamera(centeredFocalPoint, previousCamera, __namedParameters): Point3

Parameters

• centeredFocalPoint: Point3

• previousCamera: ICamera<number>

• __namedParameters

• __namedParameters.resetPan: boolean = true

• __namedParameters.resetToCenter: boolean = true

Returns

Point3

Inherited from

Viewport._getFocalPointForResetCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2328

---

_isInBounds()

_isInBounds(point, bounds): boolean

Determines whether or not the 3D point position is inside the boundaries of the 3D imageData.

Parameters

• point: Point3

3D coordinate

• bounds: number[]

Bounds of the image

Returns

boolean

boolean

Inherited from

Viewport._isInBounds

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2388

---

_removeActor()

_removeActor(actorUID): ActorEntry

Remove the actor from the viewport

Parameters

• actorUID: string

The unique identifier for the actor.

Returns

ActorEntry

The removed actor entry or undefined if it didn't exist

Inherited from

Viewport._removeActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:662

---

addActor()

addActor(actorEntry): void

Add an actor to the viewport including its id, its actor and slabThickness if defined

Parameters

• actorEntry: ActorEntry

ActorEntry

• actorEntry.uid - The unique identifier for the actor.
• actorEntry.actor - The volume actor.
• actorEntry.slabThickness - The slab thickness.

Returns

void

Inherited from

Viewport.addActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:755

---

addActors()

addActors(actors, options): void

Add a list of actors (actor entries) to the viewport

Parameters

• actors: ActorEntry[]

An array of ActorEntry objects.

• options = {}

• options.resetCamera?: boolean

Returns

void

Inherited from

Viewport.addActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:706

---

addImages()

addImages(stackInputs): void

Parameters

• stackInputs: IStackInput[]

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1144

---

addWidget()

addWidget(widgetId, widget): void

Parameters

• widgetId: any

• widget: any

Returns

void

Inherited from

Viewport.addWidget

Defined in

packages/core/src/RenderingEngine/Viewport.ts:246

---

canvasToIndex()

protected canvasToIndex(canvasPos): Point2

Uses the transform to convert canvas coordinates into index coordinates.

Parameters

• canvasPos: Point2

Returns

Point2

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1039

---

canvasToWorld()

canvasToWorld(canvasPos, destPos): Point3

Converts a VideoViewport canvas coordinate to a video coordinate.

Parameters

• canvasPos: Point2

to convert to world

• destPos: Point3 = ...

Returns

Point3

World position

Overrides

Viewport.canvasToWorld

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:983

---

clearDisplaySets()

protected clearDisplaySets(): void

Clears the recorded display sets. Native data setters call this so that setting raw data without setDisplaySets resets the stored list. mountDisplaySets relies on this ordering: it runs the native data setter first (which clears) and then records the mounted entries.

Returns

void

Inherited from

Viewport.clearDisplaySets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2543

---

createActorMapper()

protected createActorMapper(image): CanvasActor

Parameters

• image: any

Returns

CanvasActor

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1165

---

customRenderViewportToCanvas()

customRenderViewportToCanvas(): void

Returns

void

Overrides

Viewport.customRenderViewportToCanvas

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1094

---

destroy()

destroy(): void

Returns

void

Inherited from

Viewport.destroy

Defined in

packages/core/src/RenderingEngine/Viewport.ts:288

---

dispose()

dispose(): void

Returns

void

Inherited from

Viewport.dispose

Defined in

packages/core/src/RenderingEngine/Viewport.ts:283

---

end()

end(): Promise<void>

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:400

---

flip()

protected flip(flipOptions): void

Flip the viewport on horizontal or vertical axis, this method works with vtk-js backed rendering pipeline.

Parameters

• flipOptions: FlipDirection

Flip options specifying the axis of flip

• flipOptions.flipHorizontal - Flip the viewport on horizontal axis
• flipOptions.flipVertical - Flip the viewport on vertical axis

Returns

void

Inherited from

Viewport.flip

Defined in

packages/core/src/RenderingEngine/Viewport.ts:431

---

getActor()

getActor(actorUID): ActorEntry

Get an actor by its UID

Parameters

• actorUID: string

The unique ID of the actor.

Returns

ActorEntry

An ActorEntry object.

Inherited from

Viewport.getActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:591

---

getActorByIndex()

getActorByIndex(index): ActorEntry

Get an actor by its index

Parameters

• index: number

array index.

Returns

ActorEntry

actorUID

Inherited from

Viewport.getActorByIndex

Defined in

packages/core/src/RenderingEngine/Viewport.ts:634

---

getActors()

getActors(): ActorEntry[]

Get all the actors in the viewport

Returns

ActorEntry[]

An array of ActorEntry objects.

Inherited from

Viewport.getActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:574

---

getActorUIDByIndex()

getActorUIDByIndex(index): string

Get an actor UID by its index

Parameters

• index: number

array index.

Returns

string

actorUID

Inherited from

Viewport.getActorUIDByIndex

Defined in

packages/core/src/RenderingEngine/Viewport.ts:622

---

getActorUIDs()

getActorUIDs(): string[]

Returns an array of unique identifiers for all the actors in the viewport.

Returns

string[]

An array of strings

Inherited from

Viewport.getActorUIDs

Defined in

packages/core/src/RenderingEngine/Viewport.ts:582

---

getAspectRatio()

getAspectRatio(): Point2

Returns the current aspect ratio of the viewport as a 2D point [widthRatio, heightRatio].

Returns

Point2

The current aspect ratio [widthRatio, heightRatio] based on the active camera settings.

Inherited from

Viewport.getAspectRatio

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1461

---

getCamera()

getCamera(): ICamera<number>

Get the camera's current state

Returns

ICamera<number>

The camera object.

Overrides

Viewport.getCamera

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:908

---

getCameraNoRotation()

protected getCameraNoRotation(): ICamera<number>

Returns

ICamera<number>

Inherited from

Viewport.getCameraNoRotation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1570

---

getCanvas()

getCanvas(): HTMLCanvasElement

Gets the target output canvas for the Viewport.

Returns

HTMLCanvasElement

an HTMLCanvasElement.

Inherited from

Viewport.getCanvas

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1551

---

getClippingPlanesForActor()

getClippingPlanesForActor(actorEntry?): vtkPlane[]

Method to get the clipping planes of a given actor

Parameters

• actorEntry?: ActorEntry

The actor entry (a specific type you'll define dependent on your code)

Returns

vtkPlane[]

vtkPlanes - An array of vtkPlane objects associated with the given actor

Inherited from

Viewport.getClippingPlanesForActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1968

---

getCurrentImageId()

getCurrentImageId(index): string

This function returns the imageID associated with either the current frame being displayed, or the range of frames being played. This may not correspond to any particular imageId that has imageId metadata, as the format is one of: <DICOMweb URI>/frames/<Start Frame>(-<End Frame>)? or <Other URI>[?&]frameNumber=<Start Frame>(-<EndFrame>)? for a URL parameter.

Parameters

• index: number = ...

Returns

string

an imageID for video

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:777

---

getCurrentImageIdIndex()

getCurrentImageIdIndex(): number

Returns

number

Overrides

Viewport.getCurrentImageIdIndex

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:900

---

getDefaultActor()

getDefaultActor(): ActorEntry

Get the default actor

Returns

ActorEntry

An actor entry.

Inherited from

Viewport.getDefaultActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:566

---

getDisplayArea()

getDisplayArea(): DisplayArea

Returns

DisplayArea

Inherited from

Viewport.getDisplayArea

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1113

---

getDisplaySets()

getDisplaySets(): object[]

Returns the display sets currently recorded as mounted on the viewport. Empty when the viewport was driven by a raw data setter instead of setDisplaySets.

Returns

object[]

Inherited from

Viewport.getDisplaySets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2533

---

getFrameNumber()

getFrameNumber(): number

Gets the 1 based frame number (ala DICOM value), eg 1+ currentImageIdIndex

Returns

number

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:895

---

getFrameOfReferenceUID()

getFrameOfReferenceUID(): string

Returns

string

Overrides

Viewport.getFrameOfReferenceUID

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:954

---

getFrameRange()

getFrameRange(): [number, number]

Returns

[number, number]

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:483

---

getFrameRate()

getFrameRate(): number

Returns

number

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:950

---

getImageActor()

getImageActor(volumeId?): vtkImageSlice

Retrieves an image actor from the viewport actors.

Parameters

• volumeId?: string

Optional. The ID of the volume to find the corresponding image actor.

Returns

vtkImageSlice

The image actor if found, otherwise null.

Inherited from

Viewport.getImageActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:601

---

getImageData()

getImageData(): IImageData | CPUIImageData

Returns

IImageData | CPUIImageData

Overrides

Viewport.getImageData

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:585

---

getImageDataMetadata()

getImageDataMetadata(image): VideoImageMetadata

Parameters

• image: string | IImage

Returns

VideoImageMetadata

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:174

---

getImageIds()

getImageIds(): string[]

Gets all the image ids associated with this video element. This will have # of frames elements.

Returns

string[]

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:319

---

getMiddleSliceData()

getMiddleSliceData(): never

Returns

never

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:677

---

getNumberOfSlices()

getNumberOfSlices(): number

Returns

number

Overrides

Viewport.getNumberOfSlices

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:943

---

getPan()

getPan(): Point2

Helper function to return the current canvas pan value.

Returns

Point2

a Point2 containing the current pan values on the canvas, computed from the current camera, where the initial pan value is [0,0].

Overrides

Viewport.getPan

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1029

---

getProperties()

getProperties(): VideoViewportProperties

Returns

VideoViewportProperties

Overrides

Viewport.getProperties

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:533

---

getReferencePlaneThickness()

protected getReferencePlaneThickness(): number

Get the geometric thickness in mm that an annotation applies to.

Two thicknesses exist, and they are not the same quantity. The slab thickness belongs to the viewport, and getSlabThickness returns it. The reference plane thickness belongs to the data, and this method returns it. Rule D adds the two.

See docs/docs/concepts/cornerstone-tools/annotation/voxel-statistics.md.

Returns

number

Inherited from

Viewport.getReferencePlaneThickness

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2095

---

getRenderer()

getRenderer(): vtkRenderer

Returns the vtkRenderer responsible for rendering the Viewport.

Returns

vtkRenderer

The vtkRenderer for the Viewport.

Inherited from

Viewport.getRenderer

Defined in

packages/core/src/RenderingEngine/Viewport.ts:358

---

getRenderingEngine()

getRenderingEngine(): RenderingEngine

Returns the rendering engine driving the Viewport.

Returns

RenderingEngine

The RenderingEngine instance.

Inherited from

Viewport.getRenderingEngine

Defined in

packages/core/src/RenderingEngine/Viewport.ts:349

---

getRenderPasses()

getRenderPasses(): any

Get render passes for this viewport. Viewports can override this to provide custom render passes (e.g., for sharpening).

Returns

any

Array of VTK render passes or null if no custom passes are needed

Inherited from

Viewport.getRenderPasses

Defined in

packages/core/src/RenderingEngine/Viewport.ts:263

---

getRotation()

getRotation(): number

Returns

number

Overrides

Viewport.getRotation

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1034

---

getScalarData()

protected getScalarData(): CanvasScalarData

Returns

CanvasScalarData

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:554

---

getSliceIndex()

getSliceIndex(): number

Returns

number

Overrides

Viewport.getSliceIndex

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:904

---

getSliceIndexForImage()

getSliceIndexForImage(reference): number

Parameters

• reference: string | ViewReference

Returns

number

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:470

---

getSliceViewInfo()

getSliceViewInfo(): object

Returns

object

height

height: number

indexToSliceMatrix

indexToSliceMatrix: mat4

sliceIndex

sliceIndex: number

slicePlane

slicePlane: number

sliceToIndexMatrix

sliceToIndexMatrix: mat4

width

width: number

Overrides

Viewport.getSliceViewInfo

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:436

---

getTransform()

protected getTransform(): Transform

Creates a transform from video index coordinates to canvas coordinates.

Returns

Transform

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1101

---

getUseCustomRenderingPipeline()

getUseCustomRenderingPipeline(): boolean

Returns

boolean

Inherited from

Viewport.getUseCustomRenderingPipeline

Defined in

packages/core/src/RenderingEngine/Viewport.ts:210

---

getViewPresentation()

getViewPresentation(viewPresSel): ViewPresentation

Gets a view presentation information specifying HOW a viewport displays something, but not what is being displayed. See getViewReference to get information on WHAT is being displayed.

This is intended to have information on how an image is presented to the user, without specifying what image s displayed. All of this information is available externally, but this method combines the parts of this that are appropriate for remember or applying to other views, without necessarily needing to know what all the attributes are. That differs from methods like getCamera which fetch exact view details that are not likely to be identical between viewports as they change sizes or apply to different images.

Note that the results of this can be used on different viewports, for example, the pan values can be applied to a volume viewport showing a CT, and a stack viewport showing an ultrasound.

The selector allows choosing which view presentation attributes to return. Some default values are available from Viewport.CameraViewPresentation and Viewport.TransferViewPresentation

Parameters

• viewPresSel: ViewPresentationSelector = ...

select which attributes to display.

Returns

ViewPresentation

Inherited from

Viewport.getViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2210

---

getViewReference()

getViewReference(viewRefSpecifier?): ViewReference

Gets a view target that species what type of view is required to show the current view, or the one specified in the forTarget modifiers.

Parameters

• viewRefSpecifier?: ViewReferenceSpecifier

Returns

ViewReference

Overrides

Viewport.getViewReference

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:867

---

getViewReferenceId()

getViewReferenceId(specifier): string

Gets a target id that can be used to specify how to show this

Parameters

• specifier: ViewReferenceSpecifier = {}

Returns

string

Overrides

Viewport.getViewReferenceId

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:785

---

getVtkActiveCamera()

protected getVtkActiveCamera(): vtkCamera | vtkSlabCamera

Gets the active vtkCamera for the viewport.

Returns

vtkCamera | vtkSlabCamera

vtk driven camera

Inherited from

Viewport.getVtkActiveCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1559

---

getWidget()

getWidget(id): any

Parameters

• id: any

Returns

any

Inherited from

Viewport.getWidget

Defined in

packages/core/src/RenderingEngine/Viewport.ts:250

---

getWidgets()

getWidgets(): any[]

Returns

any[]

Inherited from

Viewport.getWidgets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:254

---

getZoom()

getZoom(compareCamera): number

Returns a current zoom level relative to the initial parallel scale originally applied to the image. That is, on initial display, the zoom level is 1. Computed as a function of the camera.

Parameters

• compareCamera: ICamera<number> = ...

Returns

number

Inherited from

Viewport.getZoom

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1422

---

hasImageURI()

hasImageURI(imageURI): boolean

Checks to see if the imageURI is currently being displayed. The imageURI may contain frame numbers according to the DICOM standard format, which will be stripped to compare the base image URI, and then the values used to check if that frame is currently being displayed.

The DICOM standard allows for comma separated values as well, however, this is not supported here, with only a single range or single value being tested.

For a single value, the time range +/- 5 frames is permitted to allow the detection to actually succeed when nearby without requiring an exact time frame to be matched.

Parameters

• imageURI: string

containing frame number or range.

Returns

boolean

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:700

---

indexToCanvas()

protected indexToCanvas(indexPos): Point2

Parameters

• indexPos: Point2

Returns

Point2

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1048

---

isOrientationChangeable()

isOrientationChangeable(): boolean

Returns whether the viewport supports changing orientation (e.g. via setCamera with viewPlaneNormal/viewUp). Used by tools like OrientationControllerTool to decide where to show interactive orientation markers.

Returns

boolean

Inherited from

Viewport.isOrientationChangeable

Defined in

packages/core/src/RenderingEngine/Viewport.ts:239

---

isPlaneViewable()

isPlaneViewable(planeRestriction, options?): boolean

Parameters

• planeRestriction: PlaneRestriction

• options?: ReferenceCompatibleOptions

Returns

boolean

Inherited from

Viewport.isPlaneViewable

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2099

---

isReferenceViewable()

isReferenceViewable(viewRef, options): boolean

Figure out if a given view can be shown in the current viewport.

Parameters

• viewRef: ViewReference

• options: ReferenceCompatibleOptions = {}

Returns

boolean

Overrides

Viewport.isReferenceViewable

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:806

---

mountDisplaySets()

protected mountDisplaySets<TEntry>(entries, load): Promise<void>

Shared template for the type-specific setDisplaySets overrides. It keeps the clear-then-record ordering invariant in exactly one place instead of being copy-pasted per viewport:

1. Validate that a source display set (the first entry) was provided.
2. Run load, which resolves the entry to renderable data and hands it to the viewport's native data setter (setStack / setVolumes / setVideo / setWSI / setEcg). That native setter calls clearDisplaySets, wiping any previously recorded entries.
3. Record the mounted entries - only after load resolves - so getDisplaySets reflects exactly what was mounted.

Because recording always happens last, a new viewport cannot accidentally record before loading (which the native setter would then wipe) or forget to record at all; both failure modes the previous copy-pasted sequence was prone to are handled here once.

Overlays: the variadic signature already accepts overlay entries (index 1+), matching the generic viewport setDisplaySets. Legacy viewports do not yet render overlays, so only the source (first) entry is loaded and recorded - getDisplaySets stays honest about what is actually shown. Adding overlay support later is purely additive: load the extra entries here and record them, with no change to the public signature.

Type Parameters

• TEntry extends object

Parameters

• entries: TEntry[]

the display set entries passed to setDisplaySets; the first is the source and any subsequent entries are overlays.

• load

resolves the source entry to renderable data and loads it via the viewport's native data setter. Receives the validated source entry.

Returns

Promise<void>

Inherited from

Viewport.mountDisplaySets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2507

---

pause()

pause(): void

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:352

---

play()

play(): Promise<void>

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:338

---

removeActors()

removeActors(actorUIDs): void

Remove the actors with the given UIDs from the viewport

Parameters

• actorUIDs: string[]

An array of actor UIDs to remove.

Returns

void

Inherited from

Viewport.removeActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:681

---

removeAllActors()

removeAllActors(): void

Remove all actors from the renderer

Returns

void

Inherited from

Viewport.removeAllActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:795

---

removeWidgets()

removeWidgets(): void

Returns

void

Inherited from

Viewport.removeWidgets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:267

---

render()

render(): void

Renders the Viewport using the RenderingEngine.

Returns

void

Inherited from

Viewport.render

Defined in

packages/core/src/RenderingEngine/Viewport.ts:371

---

reset()

reset(immediate): void

Resets the options the Viewport's defaultOptions

Parameters

• immediate: boolean = false

If true, renders the viewport after the options are reset.

Returns

void

Inherited from

Viewport.reset

Defined in

packages/core/src/RenderingEngine/Viewport.ts:401

---

resetCamera()

resetCamera(): boolean

Resets the camera based on the rendering volume(s) bounds. If resetPan and resetZoom are true it places the focal point at the center of the volume (or slice); otherwise, only the camera zoom and camera Pan or Zoom is reset for the current view.

Returns

boolean

boolean

Overrides

Viewport.resetCamera

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:931

---

resetCameraNoEvent()

protected resetCameraNoEvent(): void

Reset the camera to the default viewport camera without firing events

Returns

void

Inherited from

Viewport.resetCameraNoEvent

Defined in

packages/core/src/RenderingEngine/Viewport.ts:814

---

resetProperties()

resetProperties(): void

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:543

---

resize()

resize(): void

Returns

void

Overrides

Viewport.resize

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:959

---

resizeForRenderingEngine()

resizeForRenderingEngine(__namedParameters): void

RenderingEngine-owned resize hook for custom-pipeline viewports. Legacy viewports keep the previous camera-preserving behavior by default.

Parameters

• __namedParameters: RenderingEngineResizeOptions = {}

Returns

void

Inherited from

Viewport.resizeForRenderingEngine

Defined in

packages/core/src/RenderingEngine/Viewport.ts:218

---

scroll()

scroll(delta): Promise<void>

Parameters

• delta: number = 1

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:361

---

setActors()

setActors(actors): void

It removes all actors from the viewport and then adds the actors from the array.

Parameters

• actors: ActorEntry[]

An array of ActorEntry objects.

Returns

void

Inherited from

Viewport.setActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:642

---

setAspectRatio()

setAspectRatio(value, isFitViewportAfterStretch, storeAsInitialCamera): void

Sets the aspect ratio of the viewport (canvas) using the provided 2D point [widthRatio, heightRatio].

This updates the VTK camera's projection matrix to apply axis-based stretching during rendering.

As a result:

• World-to-canvas mapping is updated via the camera projection.
• Canvas-to-world mapping is also updated and remains consistent, as VTK utilizes the inverse of the same projection matrix for picking and coordinate transformations.

Note:

• The camera pose and orientation (position, focal point, and viewPlaneNormal) remain unchanged.
• Image data, spacing, and world coordinates are not modified.

Parameters

• value: Point2

The aspect ratio to set as [widthRatio, heightRatio].

• isFitViewportAfterStretch: boolean = true

• storeAsInitialCamera: boolean = false

Whether to store the updated camera state as the initial camera. Defaults to false.

Returns

void

Inherited from

Viewport.setAspectRatio

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1488

---

setAverageWhite()

setAverageWhite(averageWhite): void

Parameters

• averageWhite: [number, number, number]

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:722

---

setCamera()

setCamera(camera): void

Set the camera parameters

Parameters

• camera: ICamera<number>

Returns

void

Overrides

Viewport.setCamera

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:727

---

setCameraNoEvent()

protected setCameraNoEvent(camera): void

Sets the camera to the default viewport camera without firing events

Parameters

• camera: ICamera<number>

The camera to use for the viewport.

Returns

void

Inherited from

Viewport.setCameraNoEvent

Defined in

packages/core/src/RenderingEngine/Viewport.ts:825

---

setColorTransform()

protected setColorTransform(voiRange, averageWhite): any

This applies a color transform as an svg filter to the output image.

Parameters

• voiRange: any

• averageWhite: any

Returns

any

Inherited from

Viewport.setColorTransform

Defined in

packages/core/src/RenderingEngine/Viewport.ts:319

---

setDataIds()

setDataIds(imageIds, options?): void

This is a wrapper for setVideo to allow generic behaviour

Parameters

• imageIds: string[]

a singleton list containing the imageId of a video.

• options?: ImageSetOptions

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:188

---

setDataList()

setDataList(entries): Promise<unknown>

GenericViewport compat shim – delegates to setVideo.

Parameters

• entries: object[]

Returns

Promise<unknown>

Overrides

Viewport.setDataList

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:196

---

setDisplayArea()

setDisplayArea(displayArea, suppressEvents): void

Sets the camera to an initial bounds. If resetPan and resetZoom are true it places the focal point at the center of the volume (or slice); otherwise, only the camera zoom and camera Pan or Zoom is reset for the current view.

Parameters

• displayArea: DisplayArea

The display area of interest.

• suppressEvents: boolean = false

If true, don't fire displayArea event.

Returns

void

Inherited from

Viewport.setDisplayArea

Defined in

packages/core/src/RenderingEngine/Viewport.ts:895

---

setDisplayAreaFit()

protected setDisplayAreaFit(displayArea): void

This applies a display area with a fit of the provided area to the available area. The zoom level is controlled by the imageArea parameter, which is a pair of percentage width in the horizontal and vertical dimension is scaled to fit the displayable area. Both values are taken into account, and the scaling is set so that both fractions of the image area are visible.

The panning is controlled by the imageCanvasPoint, which has two values, teh imagePoint and the canvasPoint. They are fractional values of the image and canvas respectively, with the panning set to display the image pixel at the given fraction on top of the canvas at the given percentage. The default points are 0.5.

For example, if the zoom level is [2,1], then the image is displayed such that at least twice the width is visible, and the height is visible. That will result in the image width being black, divided up on the left and right according to the imageCanvasPoint

Then, if the imagePoint is [1,0] and the canvas point is [1,0], then the right most edge of the image, at the top of the image, will be displayed at the right most edge of the canvas, at the top.

Parameters

• displayArea: DisplayArea

Returns

void

Inherited from

Viewport.setDisplayAreaFit

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1032

---

setDisplayAreaScale()

protected setDisplayAreaScale(displayArea): void

Sets the viewport to pixel scaling mode. Pixel scaling displays 1 image pixel as 1 (or scale) physical screen pixels. That is, a 1024x512 image will be displayed with scale=2, as 2048x1024 physical image pixels.

Parameters

• displayArea: DisplayArea

display area to set

• displayArea.scale - the number of physical pixels to display each image pixel in. Values < 1 mean smaller than physical, while values > 1 mean more than one pixel. Default is 1 Suggest using whole numbers or integer fractions (eg 1/3)

Returns

void

Inherited from

Viewport.setDisplayAreaScale

Defined in

packages/core/src/RenderingEngine/Viewport.ts:959

---

setDisplaySets()

setDisplaySets(...entries): Promise<void>

Mounts display sets on the viewport, mirroring the GenericViewport setDisplaySets API. The displaySetId is the video imageId (callers typically pass displaySet.instances[0].imageId); the first entry is loaded as the video source. Resolution and loading run inside mountDisplaySets, which records the mounted entries after setVideo so getDisplaySets reports them.

An optional initial frame can be passed per entry via options: an explicit 1-based frameNumber, or a 0-based viewReference.sliceIndex (matching setDataIds). When neither is provided the video opens on frame 1.

Parameters

• ...entries: object[]

display set entries to mount; the first is used as the source.

Returns

Promise<void>

Overrides

Viewport.setDisplaySets

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:219

---

setFitToCanvasCamera()

protected setFitToCanvasCamera(camera): void

Sets the provided camera as the displayArea camera. This allows computing differences applied later as compared to the initial position, for things like zoom and pan.

Parameters

• camera: ICamera<number>

to store as the initial value.

Returns

void

Inherited from

Viewport.setFitToCanvasCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1327

---

setFrameNumber()

setFrameNumber(frame): Promise<void>

Parameters

• frame: number

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:448

---

setFrameRange()

setFrameRange(frameRange): void

Sets the playback frame range. The video will play over the given set of frames (assuming it is playing).

Parameters

• frameRange: number[]

the minimum to maximum (inclusive) frames to play over

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:459

---

setInitialCamera()

protected setInitialCamera(camera): void

Sets the provided camera as the initial camera. This allows computing differences applied later as compared to the initial position, for things like zoom and pan.

Parameters

• camera: ICamera<number>

to store as the initial value.

Returns

void

Inherited from

Viewport.setInitialCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1317

---

setInterpolationType()

protected setInterpolationType(_interpolationType, _arg?): void

Sets the interpolation type. No-op in the base.

Parameters

• _interpolationType: InterpolationType

• _arg?: any

Returns

void

Inherited from

Viewport.setInterpolationType

Defined in

packages/core/src/RenderingEngine/Viewport.ts:883

---

setNeedsRender()

setNeedsRender(): void

Mark the viewport as needing a render pass (e.g. after external display-set / segmentation updates). Does not queue a render; the rendering engine’s normal RAF cycle will pick this up.

Returns

void

Inherited from

Viewport.setNeedsRender

Defined in

packages/core/src/RenderingEngine/Viewport.ts:312

---

setOptions()

setOptions(options, immediate): void

Sets new options and (TODO) applies them.

Parameters

• options: ViewportInputOptions

The viewport options to set.

• immediate: boolean = false

If true, renders the viewport after the options are set.

Returns

void

Inherited from

Viewport.setOptions

Defined in

packages/core/src/RenderingEngine/Viewport.ts:383

---

setOrientationOfClippingPlanes()

setOrientationOfClippingPlanes(vtkPlanes, slabThickness, viewPlaneNormal, focalPoint): void

Parameters

• vtkPlanes: vtkPlane[]

• slabThickness: number

• viewPlaneNormal: Point3

• focalPoint: Point3

Returns

void

Inherited from

Viewport.setOrientationOfClippingPlanes

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1931

---

setPan()

setPan(pan, storeAsInitialCamera): void

Sets the canvas pan value relative to the initial view position of 0,0 Modifies the camera to perform the pan.

Parameters

• pan: Point2

• storeAsInitialCamera: boolean = false

Returns

void

Inherited from

Viewport.setPan

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1388

---

setPlaybackRate()

setPlaybackRate(rate): void

Parameters

• rate: number = 1

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:509

---

setProperties()

setProperties(props): void

Parameters

• props: VideoViewportProperties

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:487

---

setRendered()

setRendered(): void

Indicate that the image has been rendered. This will set the viewportStatus to RENDERED if there is image data available to actually be rendered - otherwise, the rendering simply showed the background image.

Returns

void

Inherited from

Viewport.setRendered

Defined in

packages/core/src/RenderingEngine/Viewport.ts:298

---

setRotation()

protected setRotation(_rotation): void

Parameters

• _rotation: number

Returns

void

Inherited from

Viewport.setRotation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:202

---

setScrollSpeed()

setScrollSpeed(scrollSpeed, unit): void

Parameters

• scrollSpeed: number = 1

• unit: SpeedUnit = VideoViewportEnum.SpeedUnit.FRAME

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:523

---

setTime()

setTime(timeInSeconds): Promise<void>

Parameters

• timeInSeconds: number

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:418

---

setVideo()

setVideo(imageId, frameNumber?): Promise<unknown>

Sets the video image id to show and hte frame number. Requirements are to have the imageUrlModule in the metadata with the rendered endpoint being the raw video in video/mp4 format.

Parameters

• imageId: string

• frameNumber?: number

Returns

Promise<unknown>

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:248

---

setViewPresentation()

setViewPresentation(viewPres): void

Applies the display area, zoom, pan and rotation from the view presentation. No-op is viewPres isn't defined.

Parameters

• viewPres: ViewPresentation

Returns

void

Inherited from

Viewport.setViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2274

---

setViewReference()

setViewReference(viewRef): void

Navigates the video to the specific view reference

Parameters

• viewRef: ViewReference

Returns

void

Overrides

Viewport.setViewReference

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:855

---

setVOI()

setVOI(voiRange): void

Parameters

• voiRange: VOIRange

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:709

---

setWindowLevel()

setWindowLevel(windowWidth, windowCenter): void

Parameters

• windowWidth: number = 256

• windowCenter: number = 128

Returns

void

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:715

---

setZoom()

setZoom(value, storeAsInitialCamera): void

Zooms the image using parallel scale by updating the camera value.

Parameters

• value: number

The relative parallel scale to apply. It is relative to the initial offsets value.

• storeAsInitialCamera: boolean = false

can be set to true to reset the camera after applying this zoom as the initial camera. A subsequent getZoom call will return "1", but the zoom will have been applied.

Returns

void

Inherited from

Viewport.setZoom

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1439

---

start()

start(): Promise<void>

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:382

---

togglePlayPause()

togglePlayPause(): boolean

Returns

boolean

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:328

---

triggerCameraModifiedEventIfNecessary()

triggerCameraModifiedEventIfNecessary(previousCamera, updatedCamera): void

Trigger camera modified event

Parameters

• previousCamera: ICamera<number>

• updatedCamera: ICamera<number>

Returns

void

Inherited from

Viewport.triggerCameraModifiedEventIfNecessary

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1853

---

updateCameraClippingPlanesAndRange()

updateCameraClippingPlanesAndRange(): void

Nothing to do for the clipping planes for video as they don't exist.

Returns

void

Overrides

Viewport.updateCameraClippingPlanesAndRange

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1140

---

updateClippingPlanesForActors()

protected updateClippingPlanesForActors(updatedCamera): Promise<void>

Updates the actors clipping planes orientation from the camera properties

Parameters

• updatedCamera: ICamera<number>

ICamera

Returns

Promise<void>

Inherited from

Viewport.updateClippingPlanesForActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1883

---

worldToCanvas()

worldToCanvas(worldPos): Point2

Converts [x, y, 0] world video coordinate to canvas CSS coordinates.

Parameters

• worldPos: Point3

world coord to convert to canvas

Returns

Point2

Canvas position

Overrides

Viewport.worldToCanvas

Defined in

packages/core/src/RenderingEngine/VideoViewport.ts:1017

---

boundsRadius()

static boundsRadius(bounds): number

Computes the bounds radius value

Parameters

• bounds: number[]

Returns

number

Inherited from

Viewport.boundsRadius

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2432