Skip to main content

Class: Viewport

An object representing a single viewport, which is a camera looking into a viewport, and an associated target output HTMLDivElement. Viewport is a base class that can be extended to create a specific viewport type. Both VolumeViewport and StackViewport are subclasses of Viewport. Common logic for all viewports is contained in Viewport class which is camera properties/methods, vtk.js actors, and other common logic.

Extended by

Constructors

new Viewport()

new Viewport(props): Viewport

Parameters

props: ViewportInput

Returns

Viewport

Defined in

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

Properties

_actors

_actors: Map<string, ActorEntry>

a Map containing the actor uid and actors

Defined in

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


_suppressCameraModifiedEvents

_suppressCameraModifiedEvents: boolean = false

informs if a new actor was added before a resetCameraClippingRange phase

Defined in

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


calibration

protected calibration: IImageCalibration

Defined in

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


canvas

readonly canvas: HTMLCanvasElement

an internal canvas that is created on the provided HTML element

Defined in

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


canvasToWorld()

canvasToWorld: (canvasPos) => Point3

Parameters

canvasPos: Point2

Returns

Point3

Defined in

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


customRenderViewportToCanvas()

customRenderViewportToCanvas: () => unknown

Returns

unknown

Defined in

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


defaultOptions

readonly defaultOptions: ViewportInputOptions

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

Defined in

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


element

readonly element: HTMLDivElement

HTML element in DOM that is used for rendering the viewport

Defined in

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


fitToCanvasCamera

protected fitToCanvasCamera: ICamera

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

Defined in

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


flipHorizontal

protected flipHorizontal: boolean = false

Defined in

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


flipVertical

protected flipVertical: boolean = false

Defined in

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


getFrameOfReferenceUID()

getFrameOfReferenceUID: () => string

Returns

string

Defined in

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


getNumberOfSlices()

getNumberOfSlices: () => number

Returns

number

Defined in

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


getProperties()

getProperties: () => ViewportProperties

Returns

ViewportProperties

Defined in

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


getRotation()

getRotation: () => number

Returns

number

Defined in

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


hasPixelSpacing

protected hasPixelSpacing: boolean = true

Defined in

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


id

readonly id: string

unique identifier for the viewport

Defined in

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


initialCamera

protected initialCamera: ICamera

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

Defined in

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


insetImageMultiplier

protected insetImageMultiplier: number

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

Defined in

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


isDisabled

isDisabled: boolean

Defined in

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


options

options: ViewportInputOptions

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

Defined in

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


renderingEngineId

readonly renderingEngineId: string

RenderingEngine id that the viewport belongs to

Defined in

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


resize()

resize: () => void

Returns

void

Defined in

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


sHeight

sHeight: number

sHeight of viewport on the offscreen canvas

Defined in

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


suppressEvents

readonly suppressEvents: boolean

A flag representing if viewport methods should fire events or not

Defined in

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


sWidth

sWidth: number

sWidth of viewport on the offscreen canvas

Defined in

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


sx

sx: number

sx of viewport on the offscreen canvas

Defined in

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


sy

sy: number

sy of viewport on the offscreen canvas

Defined in

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


type

readonly type: ViewportType

Type of viewport

Defined in

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


updateRenderingPipeline()

updateRenderingPipeline: () => void

Returns

void

Defined in

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


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

Defined in

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


worldToCanvas()

worldToCanvas: (worldPos) => Point2

Parameters

worldPos: Point3

Returns

Point2

Defined in

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


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.

Defined in

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


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.

Defined in

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

Accessors

useCustomRenderingPipeline

get static useCustomRenderingPipeline(): boolean

Returns

boolean

Defined in

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

Methods

_getCorners()

_getCorners(bounds): number[][]

Parameters

bounds: number[]

Returns

number[][]

Defined in

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


_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

Defined in

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


_getFocalPointForResetCamera()

_getFocalPointForResetCamera(centeredFocalPoint, previousCamera, __namedParameters): Point3

Parameters

centeredFocalPoint: Point3

previousCamera: ICamera

__namedParameters

__namedParameters.resetPan: boolean = true

__namedParameters.resetToCenter: boolean = true

Returns

Point3

Defined in

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


_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

Defined in

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


_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

Defined in

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


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

Defined in

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


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

Defined in

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


addWidget()

addWidget(widgetId, widget): void

Parameters

widgetId: any

widget: any

Returns

void

Defined in

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


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

Defined in

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


getActor()

getActor(actorUID): ActorEntry

Get an actor by its UID

Parameters

actorUID: string

The unique ID of the actor.

Returns

ActorEntry

An ActorEntry object.

Defined in

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


getActorByIndex()

getActorByIndex(index): ActorEntry

Get an actor by its index

Parameters

index: number

array index.

Returns

ActorEntry

actorUID

Defined in

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


getActors()

getActors(): ActorEntry[]

Get all the actors in the viewport

Returns

ActorEntry[]

An array of ActorEntry objects.

Defined in

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


getActorUIDByIndex()

getActorUIDByIndex(index): string

Get an actor UID by its index

Parameters

index: number

array index.

Returns

string

actorUID

Defined in

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


getActorUIDs()

getActorUIDs(): string[]

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

Returns

string[]

An array of strings

Defined in

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


getCamera()

getCamera(): ICamera

Get the camera's current state

Returns

ICamera

The camera object.

Defined in

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


getCameraNoRotation()

protected getCameraNoRotation(): ICamera

Returns

ICamera

Defined in

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


getCanvas()

getCanvas(): HTMLCanvasElement

Gets the target output canvas for the Viewport.

Returns

HTMLCanvasElement

an HTMLCanvasElement.

Defined in

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


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

Defined in

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


getCurrentImageIdIndex()

getCurrentImageIdIndex(): number

Returns

number

Defined in

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


getDefaultActor()

getDefaultActor(): ActorEntry

Get the default actor

Returns

ActorEntry

An actor entry.

Defined in

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


getDisplayArea()

getDisplayArea(): DisplayArea

Returns

DisplayArea

Defined in

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


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.

Defined in

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


getImageData()

getImageData(): any

Returns

any

Defined in

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


getPan()

getPan(initialCamera): Point2

Helper function to return the current canvas pan value.

Parameters

initialCamera: ICamera = ...

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].

Defined in

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


getRenderer()

getRenderer(): vtkRenderer

Returns the vtkRenderer responsible for rendering the Viewport.

Returns

vtkRenderer

The vtkRenderer for the Viewport.

Defined in

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


getRenderingEngine()

getRenderingEngine(): RenderingEngine

Returns the rendering engine driving the Viewport.

Returns

RenderingEngine

The RenderingEngine instance.

Defined in

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


getSliceIndex()

getSliceIndex(): number

Returns

number

Defined in

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


getSliceViewInfo()

getSliceViewInfo(): object

Returns

object

height

height: number

indexToSliceMatrix

indexToSliceMatrix: mat4

sliceIndex

sliceIndex: number

slicePlane

slicePlane: number

sliceToIndexMatrix

sliceToIndexMatrix: mat4

width

width: number

Defined in

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


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

Defined in

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


getViewReference()

getViewReference(viewRefSpecifier?): ViewReference

Gets a view target specifying WHAT a view is displaying, allowing for checking if a given image is displayed or could be displayed in a given viewport. See getViewPresentation for HOW a view is displayed.

Parameters

viewRefSpecifier?: ViewReferenceSpecifier

choose an alternate view to be specified, typically a different slice index in the same set of images.

Returns

ViewReference

Defined in

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


getViewReferenceId()

getViewReferenceId(_specifier?): string

Gets a referenced image url of some sort - could be a real image id, or could be a URL with parameters. Regardless it refers to the currently displaying image as a string value.

Parameters

_specifier?: ViewReferenceSpecifier

Returns

string

Defined in

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


getVtkActiveCamera()

protected getVtkActiveCamera(): vtkCamera | vtkSlabCamera

Gets the active vtkCamera for the viewport.

Returns

vtkCamera | vtkSlabCamera

vtk driven camera

Defined in

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


getWidget()

getWidget(id): any

Parameters

id: any

Returns

any

Defined in

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


getWidgets()

getWidgets(): any[]

Returns

any[]

Defined in

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


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 = ...

Returns

number

Defined in

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


isPlaneViewable()

isPlaneViewable(planeRestriction, options?): boolean

Parameters

planeRestriction: PlaneRestriction

options?: ReferenceCompatibleOptions

Returns

boolean

Defined in

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


isReferenceViewable()

isReferenceViewable(viewRef, options?): boolean

Find out if this viewport does or could show this view reference.

Parameters

viewRef: ViewReference

options?: ReferenceCompatibleOptions

allows specifying whether the view COULD display this with some modification - either navigation or displaying as volume.

Returns

boolean

true if the viewport could show this view reference

Defined in

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


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

Defined in

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


removeAllActors()

removeAllActors(): void

Remove all actors from the renderer

Returns

void

Defined in

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


removeWidgets()

removeWidgets(): void

Returns

void

Defined in

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


render()

render(): void

Renders the Viewport using the RenderingEngine.

Returns

void

Defined in

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


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

Defined in

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


resetCamera()

resetCamera(options?): 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.

Parameters

options?

The reset options

options.resetPan?: boolean

If true, the camera focal point is reset to the center of the volume (slice)

options.resetToCenter?: boolean

If true, the camera is reset to the center of the volume (slice)

options.resetZoom?: boolean

If true, the camera zoom is reset to the default zoom

options.storeAsInitialCamera?: boolean

If true, reset camera is stored as the initial camera (to allow differences to be detected for pan/zoom values)

Returns

boolean

boolean

Defined in

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


resetCameraNoEvent()

protected resetCameraNoEvent(): void

Reset the camera to the default viewport camera without firing events

Returns

void

Defined in

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


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

Defined in

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


setCamera()

setCamera(cameraInterface, storeAsInitialCamera): void

Set the camera parameters

Parameters

cameraInterface: ICamera

ICamera

storeAsInitialCamera: boolean = false

to set the provided camera as the initial one, used to compute differences for things like pan and zoom.

Returns

void

Defined in

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


setCameraNoEvent()

protected setCameraNoEvent(camera): void

Sets the camera to the default viewport camera without firing events

Parameters

camera: ICamera

The camera to use for the viewport.

Returns

void

Defined in

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


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

Defined in

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


setDataIds()

setDataIds(_imageIds, _options?): void

This is a wrapper for setStack/setVideo/etc

Parameters

_imageIds: string[]

_options?: ImageSetOptions

Returns

void

Defined in

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


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

Defined in

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


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

Defined in

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


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

Defined in

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


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

to store as the initial value.

Returns

void

Defined in

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


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

to store as the initial value.

Returns

void

Defined in

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


setInterpolationType()

protected setInterpolationType(_interpolationType, _arg?): void

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

Parameters

_interpolationType: InterpolationType

_arg?: any

Returns

void

Defined in

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


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

Defined in

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


setOrientationOfClippingPlanes()

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

Parameters

vtkPlanes: vtkPlane[]

slabThickness: number

viewPlaneNormal: Point3

focalPoint: Point3

Returns

void

Defined in

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


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

Defined in

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


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

Defined in

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


setRotation()

protected setRotation(_rotation): void

Parameters

_rotation: number

Returns

void

Defined in

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


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

Defined in

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


setViewReference()

setViewReference(viewRef): void

Navigates to the image specified by the viewRef.

Parameters

viewRef: ViewReference

Returns

void

Defined in

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


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

Defined in

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


triggerCameraModifiedEventIfNecessary()

triggerCameraModifiedEventIfNecessary(previousCamera, updatedCamera): void

Trigger camera modified event

Parameters

previousCamera: ICamera

updatedCamera: ICamera

Returns

void

Defined in

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


updateCameraClippingPlanesAndRange()

updateCameraClippingPlanesAndRange(): void

Updates the camera's clipping planes and range.

Returns

void

Defined in

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


updateClippingPlanesForActors()

protected updateClippingPlanesForActors(updatedCamera): Promise<void>

Updates the actors clipping planes orientation from the camera properties

Parameters

updatedCamera: ICamera

ICamera

Returns

Promise<void>

Defined in

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


boundsRadius()

static boundsRadius(bounds): number

Computes the bounds radius value

Parameters

bounds: number[]

Returns

number

Defined in

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