Class: ECGViewport
ECGViewport renders DICOM ECG waveform data on an HTML canvas. Based on the VideoViewport custom rendering pipeline pattern.
Extends
Constructors
new ECGViewport()
new ECGViewport(
props):ECGViewport
Parameters
• props: ECGViewportInput
Returns
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:65
Properties
_actors
_actors:
Map<string,ActorEntry>
a Map containing the actor uid and actors
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:135
_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:141
calibration
protectedcalibration:IImageCalibration
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:145
canvas
readonlycanvas:HTMLCanvasElement
an internal canvas that is created on the provided HTML element
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:97
canvasContext
readonlycanvasContext:CanvasRenderingContext2D
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:51
defaultOptions
readonlydefaultOptions:ViewportInputOptions
Default options for the viewport which includes orientation, viewPlaneNormal and backgroundColor
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:137
element
readonlyelement:HTMLDivElement
HTML element in DOM that is used for rendering the viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:95
fitToCanvasCamera
protectedfitToCanvasCamera:ICamera<number>
The camera that is defined for resetting displayArea to ensure absolute displayArea settings
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:153
flipHorizontal
protectedflipHorizontal:boolean=false
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:118
flipVertical
protectedflipVertical:boolean=false
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:119
hasPixelSpacing
protectedhasPixelSpacing:boolean=true
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:144
id
readonlyid:string
unique identifier for the viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:93
initialCamera
protectedinitialCamera:ICamera<number>
The camera that is initially defined on the reset for the relative pan/zoom
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:149
insetImageMultiplier
protectedinsetImageMultiplier:number
The amount by which the images are inset in a viewport by default.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:113
isDisabled
isDisabled:
boolean
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:120
options
options:
ViewportInputOptions
options for the viewport which includes orientation axis, backgroundColor and displayArea
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:139
renderingEngineId
readonlyrenderingEngineId:string
RenderingEngine id that the viewport belongs to
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:50
requestedType?
optionalrequestedType: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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:109
sHeight
sHeight:
number
sHeight of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:133
suppressEvents
readonlysuppressEvents:boolean
A flag representing if viewport methods should fire events or not
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:143
sWidth
sWidth:
number
sWidth of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:131
sx
sx:
number
sx of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:127
sy
sy:
number
sy of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:129
type
readonlytype:ViewportType
Type of viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:101
uid
readonlyuid:string
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:49
updateRenderingPipeline()
updateRenderingPipeline: () =>
void
Returns
void
Inherited from
Viewport.updateRenderingPipeline
Defined in
packages/core/src/RenderingEngine/Viewport.ts:188
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:124
CameraViewPresentation
readonlystaticCameraViewPresentation: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:73
TransferViewPresentation
readonlystaticTransferViewPresentation: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:87
Accessors
useCustomRenderingPipeline
getstaticuseCustomRenderingPipeline():boolean
Returns
boolean
Overrides
Viewport.useCustomRenderingPipeline
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:83
Methods
_getCorners()
_getCorners(
bounds):number[][]
Parameters
• bounds: number[]
Returns
number[][]
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2273
_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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2369
_getFocalPointForResetCamera()
_getFocalPointForResetCamera(
centeredFocalPoint,previousCamera,__namedParameters):Point3
Parameters
• centeredFocalPoint: Point3
• previousCamera: ICamera<number>
• __namedParameters
• __namedParameters.resetPan: boolean = true
• __namedParameters.resetToCenter: boolean = true
Returns
Inherited from
Viewport._getFocalPointForResetCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2286
_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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2346
_removeActor()
_removeActor(
actorUID):ActorEntry
Remove the actor from the viewport
Parameters
• actorUID: string
The unique identifier for the actor.
Returns
The removed actor entry or undefined if it didn't exist
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:650
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:745
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:696
addWidget()
addWidget(
widgetId,widget):void
Parameters
• widgetId: any
• widget: any
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:234
canvasToWorld()
canvasToWorld(
canvasPos,destPos):Point3
Parameters
• canvasPos: Point2
• destPos: Point3 = ...
Returns
Overrides
Viewport.canvasToWorld
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:337
customRenderViewportToCanvas()
customRenderViewportToCanvas():
void
Returns
void
Overrides
Viewport.customRenderViewportToCanvas
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:474
destroy()
destroy():
void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:276
dispose()
dispose():
void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:271
flip()
protectedflip(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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:419
getActor()
getActor(
actorUID):ActorEntry
Get an actor by its UID
Parameters
• actorUID: string
The unique ID of the actor.
Returns
An ActorEntry object.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:579
getActorByIndex()
getActorByIndex(
index):ActorEntry
Get an actor by its index
Parameters
• index: number
array index.
Returns
actorUID
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:622
getActors()
getActors():
ActorEntry[]
Get all the actors in the viewport
Returns
An array of ActorEntry objects.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:562
getActorUIDByIndex()
getActorUIDByIndex(
index):string
Get an actor UID by its index
Parameters
• index: number
array index.
Returns
string
actorUID
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:610
getActorUIDs()
getActorUIDs():
string[]
Returns an array of unique identifiers for all the actors in the viewport.
Returns
string[]
An array of strings
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:570
getAspectRatio()
getAspectRatio():
Point2
Returns the current aspect ratio of the viewport as a 2D point [widthRatio, heightRatio].
Returns
The current aspect ratio [widthRatio, heightRatio]
based on the active camera settings.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1451
getCamera()
getCamera():
ICamera<number>
Get the camera's current state
Returns
ICamera<number>
The camera object.
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:289
getCameraNoRotation()
protectedgetCameraNoRotation():ICamera<number>
Returns
ICamera<number>
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1560
getCanvas()
getCanvas():
HTMLCanvasElement
Gets the target output canvas for the Viewport.
Returns
HTMLCanvasElement
an HTMLCanvasElement.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1541
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:1958
getContentDimensions()
getContentDimensions():
object
Returns the computed ECG content dimensions in world pixels.
Returns
object
height
height:
number
width
width:
number
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:171
getCurrentImageId()
getCurrentImageId():
string
Returns
string
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:432
getCurrentImageIdIndex()
getCurrentImageIdIndex():
number
Returns
number
Overrides
Viewport.getCurrentImageIdIndex
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:428
getDefaultActor()
getDefaultActor():
ActorEntry
Get the default actor
Returns
An actor entry.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:554
getDisplayArea()
getDisplayArea():
DisplayArea
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1103
getFrameOfReferenceUID()
getFrameOfReferenceUID():
string
Returns
string
Overrides
Viewport.getFrameOfReferenceUID
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:316
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:589
getImageData()
getImageData():
object
Returns image data for tool compatibility (e.g. ZoomTool, ProbeTool). ECG world coordinates: x = sample index, y = amplitude (raw), z = channel number. Amplitude is mapped to index [0, ECG_AMPLITUDE_INDEX_SIZE) so indexWithinDimensions works; drawing across channels remains out of bounds and gets clipped.
Returns
object
calibration
calibration:
IImageCalibration
dimensions
dimensions:
number[]
direction
direction:
number[]
hasPixelSpacing
hasPixelSpacing:
boolean=false
imageData
imageData:
object
imageData.getDimensions()
getDimensions: () =>
number[]
Returns
number[]
imageData.getDirection()
getDirection: () =>
number[]
Returns
number[]
imageData.getRange()
getRange: () =>
Point2
Returns
imageData.getSpacing()
getSpacing: () =>
number[]
Returns
number[]
imageData.indexToWorld()
indexToWorld: (
point) =>Point3
Parameters
• point: Point3
Returns
imageData.worldToIndex()
worldToIndex: (
point) =>Point3
Parameters
• point: Point3
Returns
metadata
metadata:
object
metadata.Modality
Modality:
string='ECG'
origin
origin:
number[]
preScale
preScale:
object
preScale.scaled
scaled:
boolean=false
spacing
spacing:
number[]
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:620
getImageIds()
getImageIds():
string[]
Returns
string[]
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:466
getMiddleSliceData()
getMiddleSliceData():
never
Returns
never
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:670
getNumberOfSlices()
getNumberOfSlices():
number
Returns
number
Overrides
Viewport.getNumberOfSlices
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:424
getPan()
getPan():
Point2
Helper function to return the current canvas pan value.
Returns
a Point2 containing the current pan values on the canvas, computed from the current camera, where the initial pan value is [0,0].
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:417
getProperties()
getProperties():
ECGViewportProperties
Returns
Overrides
Viewport.getProperties
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:239
getRenderer()
getRenderer():
vtkRenderer
Returns the vtkRenderer responsible for rendering the Viewport.
Returns
vtkRenderer
The vtkRenderer for the Viewport.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:346
getRenderingEngine()
getRenderingEngine():
RenderingEngine
Returns the rendering engine driving the Viewport.
Returns
The RenderingEngine instance.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:337
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:251
getRotation()
getRotation():
number
Returns
number
Overrides
Viewport.getRotation
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:422
getSliceIndex()
getSliceIndex():
number
Returns
number
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:462
getSliceViewInfo()
getSliceViewInfo():
object
Returns
object
height
height:
number
indexToSliceMatrix
indexToSliceMatrix:
mat4
sliceIndex
sliceIndex:
number
slicePlane
slicePlane:
number
sliceToIndexMatrix
sliceToIndexMatrix:
mat4
width
width:
number
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:659
getTransform()
protectedgetTransform():Transform
Returns
Transform
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:509
getUseCustomRenderingPipeline()
getUseCustomRenderingPipeline():
boolean
Returns
boolean
Inherited from
Viewport.getUseCustomRenderingPipeline
Defined in
packages/core/src/RenderingEngine/Viewport.ts:198
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
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2168
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
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2041
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
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:436
getVisibleChannels()
getVisibleChannels():
object[]
Returns the current channel visibility state.
Returns
object[]
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:154
getVtkActiveCamera()
protectedgetVtkActiveCamera():vtkCamera|vtkSlabCamera
Gets the active vtkCamera for the viewport.
Returns
vtkCamera | vtkSlabCamera
vtk driven camera
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1549
getWaveformData()
getWaveformData():
ECGWaveformData
Returns the parsed waveform data.
Returns
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:164
getWidget()
getWidget(
id):any
Parameters
• id: any
Returns
any
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:238
getWidgets()
getWidgets():
any[]
Returns
any[]
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:242
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1412
hasImageURI()
hasImageURI(
imageURI):boolean
Parameters
• imageURI: string
Returns
boolean
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:440
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:227
isPlaneViewable()
isPlaneViewable(
planeRestriction,options?):boolean
Parameters
• planeRestriction: PlaneRestriction
• options?: ReferenceCompatibleOptions
Returns
boolean
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2074
isReferenceViewable()
isReferenceViewable(
viewRef):boolean
All annotations created on this ECG viewport are always viewable. The base implementation filters by plane distance, but ECG uses the z coordinate for channel index rather than spatial position, so the plane check incorrectly rejects annotations on non-zero channels.
Parameters
• viewRef
• viewRef.FrameOfReferenceUID?: string
Returns
boolean
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:450
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:671
removeAllActors()
removeAllActors():
void
Remove all actors from the renderer
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:785
removeWidgets()
removeWidgets():
void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:255
render()
render():
void
Renders the Viewport using the RenderingEngine.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:359
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:389
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
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:309
resetCameraNoEvent()
protectedresetCameraNoEvent():void
Reset the camera to the default viewport camera without firing events
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:804
resetProperties()
resetProperties():
void
Returns
void
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:247
resize()
resize():
void
Returns
void
Overrides
Viewport.resize
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:320
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:206
scroll()
scroll():
void
Returns
void
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:470
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:630
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1478
setCamera()
setCamera(
camera):void
Set the camera parameters
Parameters
• camera: ICamera<number>
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:257
setCameraNoEvent()
protectedsetCameraNoEvent(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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:815
setChannelVisibility()
setChannelVisibility(
index,visible):void
Toggle visibility of a specific channel.
Parameters
• index: number
• visible: boolean
Returns
void
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:141
setColorTransform()
protectedsetColorTransform(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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:307
setDataList()
setDataList(
_entries):void
Sets one or more datasets on the viewport. Legacy viewports should override this to delegate to their specific data setter.
Parameters
• _entries: object[]
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2407
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:885
setDisplayAreaFit()
protectedsetDisplayAreaFit(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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1022
setDisplayAreaScale()
protectedsetDisplayAreaScale(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
< 1mean smaller than physical, while values> 1mean more than one pixel. Default is 1 Suggest using whole numbers or integer fractions (eg1/3)
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:949
setEcg()
setEcg(
imageId):Promise<void>
Loads ECG data from a DICOM imageId by retrieving metadata via the ecgModule metadata provider.
Parameters
• imageId: string
A DICOM image ID whose metadata includes waveform data
Returns
Promise<void>
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:111
setFitToCanvasCamera()
protectedsetFitToCanvasCamera(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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1317
setInitialCamera()
protectedsetInitialCamera(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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1307
setInterpolationType()
protectedsetInterpolationType(_interpolationType,_arg?):void
Sets the interpolation type. No-op in the base.
Parameters
• _interpolationType: InterpolationType
• _arg?: any
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:873
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:300
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:371
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:1921
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1378
setProperties()
setProperties(
props):void
Parameters
• props: ECGViewportProperties
Returns
void
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:227
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:286
setRotation()
protectedsetRotation(_rotation):void
Parameters
• _rotation: number
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:190
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2232
setViewReference()
setViewReference(
_viewRef):void
Navigates to the image specified by the viewRef.
Parameters
• _viewRef: ViewReference
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2224
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1429
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:1843
updateCameraClippingPlanesAndRange()
updateCameraClippingPlanesAndRange():
void
Updates the camera's clipping planes and range.
Returns
void
Overrides
Viewport.updateCameraClippingPlanesAndRange
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:478
updateClippingPlanesForActors()
protectedupdateClippingPlanesForActors(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:1873
worldToCanvas()
worldToCanvas(
worldPos):Point2
Parameters
• worldPos: Point3
Returns
Overrides
Viewport.worldToCanvas
Defined in
packages/core/src/RenderingEngine/ECGViewport.ts:390
boundsRadius()
staticboundsRadius(bounds):number
Computes the bounds radius value
Parameters
• bounds: number[]
Returns
number