Class: ECGGenericViewport
Generic GenericViewport controller.
The base class owns only shared viewport state and binding orchestration: loaded logical data, mounted renderings, view state, and per-dataset render-state forwarding. It does not know how CPU, VTK, DOM, image, volume, or media runtimes work internally.
Concrete viewport families are expected to stay thin and provide:
- a render context for their render paths
- a data provider
- a render path resolver when the default is not enough
- viewport-family-specific public APIs
Concrete render paths are expected to own:
- runtime add/remove lifecycle
- view-state interpretation for that render path
- per-dataset render-state application
- render-path-specific coordinate transforms
This split keeps migration from legacy viewports incremental without centralizing render-mode-specific behavior in the controller.
Extends
GenericViewport<ECGViewState,ECGDataPresentation,ECGCanvasRenderContext>
Constructors
new ECGGenericViewport()
new ECGGenericViewport(
args):ECGGenericViewport
Parameters
• args: ECGViewportInput
Returns
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:64
Properties
_debug
readonly_debug:object
renderModes
renderModes:
Record<string,string>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:108
bindings
protectedbindings:Map<string,ViewportDataBinding<ECGDataPresentation>>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:98
canvas
readonlycanvas:HTMLCanvasElement
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:51
canvasContext
readonlycanvasContext:CanvasRenderingContext2D
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:52
dataPresentation
protecteddataPresentation:Map<string,ECGDataPresentation>
Inherited from
GenericViewport.dataPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:102
dataProvider
protecteddataProvider:DataProvider<object,unknown>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:94
element
readonlyelement:HTMLDivElement
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:87
id
readonlyid:string
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:86
isDestroyed
protectedisDestroyed:boolean=false
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:104
renderContext
protectedrenderContext:ECGCanvasRenderContext
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:54
renderingEngineId
readonlyrenderingEngineId:string
Overrides
GenericViewport.renderingEngineId
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:50
renderPathResolver
protectedrenderPathResolver:RenderPathResolver
Inherited from
GenericViewport.renderPathResolver
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:95
type
readonlytype:ECG_NEXT=ViewportType.ECG_NEXT
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:49
viewportStatus
viewportStatus:
ViewportStatus=ViewportStatus.NO_DATA
Inherited from
GenericViewport.viewportStatus
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:90
viewState
protectedviewState:ECGViewState
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:103
Accessors
useCustomRenderingPipeline
getstaticuseCustomRenderingPipeline():boolean
Returns
boolean
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:56
Methods
addDisplaySet()
addDisplaySet(
displaySetId,options):Promise<void>
Loads a logical display set through the viewport data provider and adds it through the render-path resolver.
Parameters
• displaySetId: string
• options: DataAddOptions
Returns
Promise<void>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:155
addLoadedData()
protectedaddLoadedData(displaySetId,data,options,shouldIgnore?):Promise<boolean>
Converts loaded logical data into a mounted rendering binding.
The binding stores render-path callbacks so future per-dataset render state, camera, transform, resize, and render requests can be routed back to the correct render-path runtime.
Parameters
• displaySetId: string
• data: LoadedData
• options: DataAddOptions
• shouldIgnore?
Returns
Promise<boolean>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:677
canReportFidelity()
canReportFidelity():
boolean
Whether this viewport can report fidelity (GENVIEW-FIDELITY-8). The family decides: a family that can show degradable data returns true, also before it mounts data, because the indicator stays hidden with no lines. The base answer is false, for a family such as ECG, Video or WSI.
Returns
boolean
Inherited from
GenericViewport.canReportFidelity
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:262
canvasToWorld()
canvasToWorld(
canvasPos):Point3
Converts a canvas-space point to world-space coordinates using the computed camera.
Parameters
• canvasPos: Point2
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:454
collectFidelityLines()
protectedcollectFidelityLines(display?):FidelityLine[]
Builds fidelity lines from the typed fidelity fields that each render
path sets on its rendering (GENVIEW-FIDELITY-2): a record for volume
data, an image quality for a stack image (FIDELITY-STATE-8). It reads
every rendering of a binding (getRenderings); a hidden rendering sets
excludeFromFidelity.
Parameters
• display?: FidelityDisplay
Returns
FidelityLine[]
Inherited from
GenericViewport.collectFidelityLines
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:352
customRenderViewportToCanvas()
customRenderViewportToCanvas():
void
Called by the rendering engine render loop for custom pipeline viewports.
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:421
destroy()
destroy():
void
Releases mounted bindings and viewport-local resources.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:556
destroyBindings()
protecteddestroyBindings():void
Tears down all mounted dataset bindings by removing each one individually.
Returns
void
Inherited from
GenericViewport.destroyBindings
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:1090
dispose()
dispose():
void
Alias for destroy. Provided for compatibility with disposable resource conventions.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:579
forEachBinding()
protectedforEachBinding(visitor):void
Iterates mounted bindings without exposing the underlying map to subclasses.
Parameters
• visitor
Returns
void
Inherited from
GenericViewport.forEachBinding
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:1008
getAspectRatio()
getAspectRatio():
Point2
Returns the current axis-based stretch as [scaleX, scaleY]. The new
generic viewport pipeline does not apply axis-based stretching for now, so this
defaults to [1, 1]. Subclasses that support aspect-ratio stretching
should override.
Returns
Inherited from
GenericViewport.getAspectRatio
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:488
getBinding()
protectedgetBinding(displaySetId):ViewportDataBinding<ECGDataPresentation>
Looks up a binding by dataset identifier.
Parameters
• displaySetId: string
Returns
ViewportDataBinding<ECGDataPresentation>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:942
getCameraForEvent()
protectedgetCameraForEvent():ICamera<number>
Returns the camera representation used for event payloads. Delegates to the computed camera's ICamera projection when available, falling back to the raw view state.
Returns
ICamera<number>
Inherited from
GenericViewport.getCameraForEvent
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:901
getContentDimensions()
getContentDimensions():
object
Returns the rendered ECG content dimensions in device pixels.
Returns
object
The ECG content width and height in device pixels.
height
height:
number
width
width:
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:380
getCurrentBinding()
protectedgetCurrentBinding():ViewportDataBinding<ECGDataPresentation>
Returns the binding used for generic transform and frame-of-reference queries when a viewport family does not override the selection logic.
Returns
ViewportDataBinding<ECGDataPresentation>
Inherited from
GenericViewport.getCurrentBinding
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:998
getCurrentImageId()
getCurrentImageId():
string
Returns the image id of the mounted ECG instance, if one has been loaded. This is the source imageId registered for the display set, not the display set id.
Returns
string
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:544
getCurrentImageIdIndex()
getCurrentImageIdIndex():
number
ECG viewports always display index 0.
Returns
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:553
getCurrentMode()
getCurrentMode():
ViewportContentMode
Reports the content-true classification of the viewport's bound data. Returns 'ecg' when a waveform is mounted, 'empty' otherwise.
Returns
Overrides
GenericViewport.getCurrentMode
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:203
getDataPresentationState()
protectedgetDataPresentationState(displaySetId):ECGDataPresentation
Returns the last render state stored for a display set, even if that display set is not currently mounted.
Parameters
• displaySetId: string
Returns
ECGDataPresentation
Inherited from
GenericViewport.getDataPresentationState
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:794
getDisplaySetPresentation()
getDisplaySetPresentation(
displaySetId):ECGDataPresentation
Returns the stored presentation state for a specific dataset.
Parameters
• displaySetId: string
Returns
ECGDataPresentation
Inherited from
GenericViewport.getDisplaySetPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:234
getDisplaySetRenderMode()
protectedgetDisplaySetRenderMode(displaySetId):string
Internal helper: returns the mounted render mode for a specific dataset when present.
Parameters
• displaySetId: string
Returns
string
Inherited from
GenericViewport.getDisplaySetRenderMode
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:952
getDisplaySetRole()
protectedgetDisplaySetRole(displaySetId):BindingRole
Internal helper: returns the binding role for a mounted dataset when present.
Parameters
• displaySetId: string
Returns
BindingRole
Inherited from
GenericViewport.getDisplaySetRole
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:962
getDisplaySets()
getDisplaySets():
object[]
Returns the display sets currently mounted on the viewport, in mount order
(source binding first, then overlays). Derived from the live bindings, so
it always reflects what is actually rendered - including overlays and any
removeData calls. The per-entry options carry the binding role.
Returns
object[]
Inherited from
GenericViewport.getDisplaySets
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:173
getDurationMs()
getDurationMs():
number
Returns the total signal duration in milliseconds, or 0 if no waveform is loaded.
Returns
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:521
getFidelityLines()
getFidelityLines():
FidelityLine[]
Fidelity lines for the built-in indicator UI.
Returns
FidelityLine[]
Inherited from
GenericViewport.getFidelityLines
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:281
getFidelityState()
getFidelityState():
ViewportFidelityState
Absolute per-viewport fidelity record (FIDELITY-EVENT-5).
Returns
Inherited from
GenericViewport.getFidelityState
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:269
getFirstBinding()
protectedgetFirstBinding():ViewportDataBinding<ECGDataPresentation>
Returns the first mounted binding when a viewport family does not have a stronger notion of "current" selection.
Returns
ViewportDataBinding<ECGDataPresentation>
Inherited from
GenericViewport.getFirstBinding
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:972
getFrameOfReferenceUID()
getFrameOfReferenceUID():
string
Returns the frame of reference UID from the computed camera when available, falling back to the current binding or a viewport-local identifier.
Returns
string
Inherited from
GenericViewport.getFrameOfReferenceUID
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:420
getImageData()
getImageData():
CPUIImageData
Returns image data compatible with the Cornerstone tools annotation system. Amplitude is mapped to [0, ECG_AMPLITUDE_INDEX_SIZE) so annotation index bounds checks work correctly across channels.
Returns
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:590
getImageIds()
getImageIds():
string[]
Returns the image ids for the active ECG dataset.
Returns
string[]
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:560
getPan()
getPan():
Point2
Returns the current 2D pan offset of the viewport.
Returns
Array containing [x, y] pan coordinates.
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:334
getReferenceViewContexts()
protectedgetReferenceViewContexts():GenericViewportReferenceContext[]
Returns generic reference-compatibility contexts for mounted datasets. Subclasses can add image, volume, slice, plane, and dimension facts.
Returns
GenericViewportReferenceContext[]
Overrides
GenericViewport.getReferenceViewContexts
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:291
getRenderingEngine()
getRenderingEngine():
RenderingEngine
Returns the rendering engine that owns this viewport. Tools and utilities
rely on this method existing on every viewport (legacy Viewport provides
it); without it, calls like viewport.getRenderingEngine() threw on native
generic viewports.
Returns
Inherited from
GenericViewport.getRenderingEngine
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:433
getResolvedView()
getResolvedView():
ECGResolvedView
Builds the resolved view of the current frame from the mounted waveform, the canvas geometry, the view state and the data presentation. It does not read the mounted rendering, so a transform is correct before the first draw (GENVIEW-VIEW-2).
Returns
ECGResolvedView
Overrides
GenericViewport.getResolvedView
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:675
getRotation()
getRotation():
number
ECG viewports have no rotation.
Returns
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:464
getSensitivity()
getSensitivity():
number
Returns the current amplitude sensitivity in mm/mV (or undefined for auto-fit).
Returns
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:180
getSliceIndex()
getSliceIndex():
number
Returns the current slice index (always 0 for 2D ECG viewports).
Returns
number
Slice index 0.
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:273
getSourceBinding()
protectedgetSourceBinding():ViewportDataBinding<ECGDataPresentation>
Returns the active source binding (the dataset that defines the view),
falling back to the first mounted binding when no explicit source role is
present. Used for content-mode classification and source-scoped queries.
Returns
ViewportDataBinding<ECGDataPresentation>
Inherited from
GenericViewport.getSourceBinding
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:983
getSourceDataId()
getSourceDataId():
string
Returns the display set id bound to this viewport, if one has been loaded.
Use getCurrentImageId for the SOP image id of the waveform instance.
Returns
string
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:535
getSweepSpeed()
getSweepSpeed():
number
Returns the current sweep speed in mm/s (defaults to 25 mm/s).
Returns
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:166
getTraceLayoutNames()
getTraceLayoutNames():
string[]
Returns the names of the registered trace layouts that suit the mounted
waveform. See getECGTraceLayoutNames.
Returns
string[]
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:149
getUseCustomRenderingPipeline()
getUseCustomRenderingPipeline():
boolean
Returns
boolean
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:60
getViewReference()
getViewReference(
specifier):ViewReference
Returns a view reference describing the mounted ECG dataset state.
With specifier.points, sliceIndex is the lead index (world Z) of the
first point, so that an annotation records its lead. Without points, the
reference covers the whole record and has no sliceIndex.
Parameters
• specifier: ViewReferenceSpecifier = {}
Optional specifier flags.
Returns
View reference representation.
Overrides
GenericViewport.getViewReference
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:215
getViewReferenceId()
getViewReferenceId(
_specifier):string
Returns a unique string identifier for the view reference.
Parameters
• _specifier: ViewReferenceSpecifier = {}
Optional specifier flags.
Returns
string
String identifier.
Overrides
GenericViewport.getViewReferenceId
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:257
getViewState()
getViewState():
ECGViewState
Returns the controller's current shared view state.
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:518
getVisibleChannels()
getVisibleChannels():
object[]
Returns channel visibility state for the active ECG dataset.
Returns
object[]
Channel names paired with their current visibility state.
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:357
getWaveformData()
getWaveformData():
ECGWaveformPayload
Returns the active ECG waveform dataset payload mounted on this viewport.
Returns
ECGWaveformPayload
Active waveform payload or null.
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:195
getZoom()
getZoom():
number
Returns the current zoom level of the viewport.
Returns
number
Zoom level factor.
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:281
hasImageId()
hasImageId(
imageId):boolean
Returns whether the viewport is rendering the specified imageId.
Parameters
• imageId: string
Returns
boolean
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:569
hasImageURI()
hasImageURI(
imageURI):boolean
Returns whether the viewport is rendering the specified imageURI. Whole identifiers are compared, so a UID prefix does not match.
Parameters
• imageURI: string
Returns
boolean
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:577
isFidelityView3D()
protectedisFidelityView3D():boolean
Whether the view is 3D for the display spacing (FIDELITY-RECORD-2). The
Volume3D family overrides this; a slice family keeps false.
Returns
boolean
Inherited from
GenericViewport.isFidelityView3D
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:311
isReferenceViewable()
isReferenceViewable(
viewReference,options):boolean
Checks the record as the base class does, and then rejects a reference
whose lead (sliceIndex, see getViewReference) the current trace
layout does not show, so that a tool does not draw it.
Parameters
• viewReference: ViewReference
• options: ReferenceCompatibleOptions = {}
Returns
boolean
Overrides
GenericViewport.isReferenceViewable
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:232
mergeDataPresentation()
protectedmergeDataPresentation(displaySetId,props):ECGDataPresentation
Merges object-like updates into the stored per-display-set render state and forwards the result immediately when mounted.
Parameters
• displaySetId: string
• props: Partial<ECGDataPresentation>
Returns
ECGDataPresentation
Inherited from
GenericViewport.mergeDataPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:825
modified()
protectedmodified(previousCamera?):void
Pushes the current shared view state to every binding and schedules a render. Optionally fires a camera-modified event when a previous camera snapshot is provided.
Parameters
• previousCamera?: ICamera<number>
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:880
normalizeViewState()
protectednormalizeViewState(viewState):ECGViewState
Hook for subclasses to clamp or adjust view-state values before they are stored. The default implementation returns the view state unchanged.
Parameters
• viewState: ECGViewState
Returns
Overrides
GenericViewport.normalizeViewState
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:287
notifyDataPresentationModified()
protectednotifyDataPresentationModified(_displaySetId,_props):void
Hook invoked after a per-display-set presentation update is applied through
the public setDisplaySetPresentation path and the target display set is
mounted. Concrete viewport families override this to emit their
presentation-modified events (e.g. VOI_MODIFIED, COLORMAP_MODIFIED) so
application UI and synchronizers can react to programmatic and tool-driven
presentation changes. The base implementation is intentionally a no-op.
Parameters
• _displaySetId: string
• _props: Partial<ECGDataPresentation>
Returns
void
Inherited from
GenericViewport.notifyDataPresentationModified
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:856
notifyFidelityStateChanged()
notifyFidelityStateChanged():
void
Internal
Fires VIEWPORT_FIDELITY_CHANGED when the derived fidelity state changes
(FIDELITY-EVENT-2..4). Called after each draw (FIDELITY-EVENT-7). A
viewport that cannot report fidelity does nothing.
Returns
void
Inherited from
GenericViewport.notifyFidelityStateChanged
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:292
onDestroy()
protectedonDestroy():void
Hook for subclasses to release viewport-local resources during destroy. Called after bindings have been torn down but before the maps are cleared.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:1100
removeAllData()
protectedremoveAllData():void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:761
removeData()
removeData(
displaySetId):void
Removes a dataset binding and its stored presentation state, then triggers a re-render so the viewport reflects the removal.
Parameters
• displaySetId: string
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:186
removeWidgets()
removeWidgets():
void
Returns
void
Deprecated
Compatibility no-op retained during the V2 migration.
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:549
render()
render():
void
Renders all active ECG bindings.
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:414
renderBindings()
protectedrenderBindings():boolean
Invokes render on each binding and reports whether any binding handled the render request directly.
Returns
boolean
Inherited from
GenericViewport.renderBindings
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:1059
resetViewState()
resetViewState(
options?):boolean
Resets the pan and the zoom, and optionally the time window. The layout
options of the view state stay. Called by resetCamera() and the toolbar
"Reset View" button.
Parameters
• options?: ECGResetViewStateOptions
Flags controlling which view-state fields are reset.
Returns
boolean
Always true for compatibility with legacy viewport contracts.
Overrides
GenericViewport.resetViewState
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:433
resize()
resize():
void
Resizes the backing canvas to match the displayed viewport size.
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:396
resizeBindings()
protectedresizeBindings():void
Invokes resize on each mounted binding.
Returns
void
Inherited from
GenericViewport.resizeBindings
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:1077
resizeForRenderingEngine()
resizeForRenderingEngine(
__namedParameters):void
RenderingEngine-owned resize hook for custom-pipeline viewports.
Generic viewports own semantic view state, so the rendering engine delegates resize behavior here instead of preserving legacy getCamera/setCamera snapshots around a reset.
Parameters
• __namedParameters: RenderingEngineResizeOptions = {}
Returns
void
Inherited from
GenericViewport.resizeForRenderingEngine
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:652
scroll()
scroll(
delta):Promise<string>
Scrolls the time window by delta window widths. Matches the Planar
family scroll signature.
The scroll does nothing when the window shows the full record, which is always true for a multi-column layout.
Parameters
• delta: number = 1
Number of window widths to shift (default 1).
Returns
Promise<string>
Promise resolving to the current source imageId.
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:478
scrollToTime()
scrollToTime(
timeMs):void
Scrolls the time window so that timeMs is at the left edge. The window
keeps its width and stays inside the record.
Parameters
• timeMs: number
Target start time in milliseconds.
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:495
setDataPresentationState()
protectedsetDataPresentationState(displaySetId,props):void
Stores per-dataset render state and forwards it immediately when that dataset is already added.
Parameters
• displaySetId: string
• props: ECGDataPresentation
Returns
void
Inherited from
GenericViewport.setDataPresentationState
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:771
setDefaultDataPresentation()
protectedsetDefaultDataPresentation(displaySetId,defaults):ECGDataPresentation
Stores object-like defaults for a display set without clobbering any values already tracked for that display set.
Parameters
• displaySetId: string
• defaults: ECGDataPresentation
Returns
ECGDataPresentation
Inherited from
GenericViewport.setDefaultDataPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:804
setDisplaySetPresentation()
setDisplaySetPresentation(props)
setDisplaySetPresentation(
props):void
Updates the stored per-display-set presentation state. When called with
just props, the update is applied to the current (source) binding. When
called with an explicit displaySetId, the update targets that binding.
Parameters
• props: Partial<ECGDataPresentation>
Returns
void
Inherited from
GenericViewport.setDisplaySetPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:208
setDisplaySetPresentation(displaySetId, props)
setDisplaySetPresentation(
displaySetId,props):void
Parameters
• displaySetId: string
• props: Partial<ECGDataPresentation>
Returns
void
Inherited from
GenericViewport.setDisplaySetPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:209
setDisplaySets()
setDisplaySets(...
entries):Promise<void>
Replaces all mounted waveform display sets with the provided ones using the canvas ECG render path.
The view state resets to the full record with every channel visible. The trace layout, the sweep speed, the sensitivity and the amplitude scale stay.
Parameters
• ...entries: object[]
Waveform display sets to mount.
options.multiplexGroupIndex (0-based) names the multiplex group to
show; undefined shows the default group.
Returns
Promise<void>
Overrides
GenericViewport.setDisplaySets
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:108
setNeedsRender()
setNeedsRender():
void
Marks the viewport as waiting for a render pass without scheduling one.
Returns
void
Inherited from
GenericViewport.setNeedsRender
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:603
setPan()
setPan(
pan):void
Sets the 2D pan offset for the viewport.
Parameters
• pan: Point2
Target [x, y] pan offset.
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:342
setRendered()
setRendered():
void
Called by rendering engines after a frame is rendered.
Most GenericViewport families do not need to track this separately because their render paths own concrete runtime state.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:589
setSensitivity()
setSensitivity(
sensitivity):void
Sets the amplitude sensitivity in mm/mV (or undefined for auto-fit) and triggers a render.
Parameters
• sensitivity: number
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:187
setSweepSpeed()
setSweepSpeed(
speed):void
Sets the sweep speed in mm/s and triggers a render.
Parameters
• speed: number
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:173
setViewReference()
setViewReference(
_viewRef):void
Sets the view reference for the viewport.
Parameters
• _viewRef: ViewReference
Target view reference.
Returns
void
Overrides
GenericViewport.setViewReference
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:265
setViewState()
setViewState(
viewStatePatch):void
Merges partial view-state updates into the viewport source of truth and propagates the result to every active binding.
Parameters
• viewStatePatch: Partial<ECGViewState>
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:500
setZoom()
setZoom(
zoom,canvasPoint?):void
Sets the zoom level for the viewport relative to an optional canvas point.
Parameters
• zoom: number
Scale factor to apply.
• canvasPoint?: Point2
Optional point in canvas space to zoom relative to.
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/ECG/ECGViewport.ts:314
triggerCameraModifiedEvent()
protectedtriggerCameraModifiedEvent(previousCamera):void
Fires a Events.CAMERA_MODIFIED event on the viewport element.
Parameters
• previousCamera: ICamera<number>
Returns
void
Inherited from
GenericViewport.triggerCameraModifiedEvent
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:909
triggerCameraResetEvent()
protectedtriggerCameraResetEvent():void
Fires a Events.CAMERA_RESET event on the viewport element.
Returns
void
Inherited from
GenericViewport.triggerCameraResetEvent
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:924
updateRenderingPipeline()
updateRenderingPipeline():
void
Re-evaluates render paths after a global rendering-configuration change (setRenderBackend, or a deprecated CPU-rendering toggle). The default is a no-op; viewport families that support a live render-path swap override it. Present on every viewport so the global fan-out in init() can call it unconditionally.
Returns
void
Inherited from
GenericViewport.updateRenderingPipeline
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:620
updateViewState()
updateViewState(
updater):void
Computes a view-state patch from the current state, then applies it through
setViewState so normalization, events, and render invalidation stay in
the canonical mutation path.
Parameters
• updater: Partial<ECGViewState> | (viewState) => void | Partial<ECGViewState>
Returns
void
Inherited from
GenericViewport.updateViewState
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:527
worldToCanvas()
worldToCanvas(
worldPos):Point2
Converts a world-space point to canvas-space coordinates using the computed camera.
Parameters
• worldPos: Point3
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:470