Class: SurfViewControlSession
Defined in: controls/ControlSession.ts:231
Headless state machine for one control panel.
The target remains the canonical state owner and is never disposed by the session. Target updates are incorporated immediately into getSnapshot(), while listener delivery is coalesced to the latest canonical revision in a microtask. Local focus and disclosure remain independent across sessions.
Implements
Constructors
Constructor
new SurfViewControlSession(target, options?): SurfViewControlSession;Defined in: controls/ControlSession.ts:246
Parameters
target
options?
SurfViewControlSessionOptions = {}
Returns
SurfViewControlSession
Methods
getSnapshot()
getSnapshot(): SurfViewControlSessionSnapshot;Defined in: controls/ControlSession.ts:285
Returns
SurfViewControlSessionSnapshot
subscribe()
subscribe(listener): SurfViewControlSubscription;Defined in: controls/ControlSession.ts:289
Parameters
listener
SurfViewControlSessionSnapshotListener
Returns
isDisposed()
isDisposed(): boolean;Defined in: controls/ControlSession.ts:307
Returns
boolean
dispose()
dispose(): void;Defined in: controls/ControlSession.ts:311
Returns
void
setFocusedSurface()
setFocusedSurface(surfaceId): ControlCommandResult;Defined in: controls/ControlSession.ts:322
Parameters
surfaceId
string
Returns
setFocusedLayer()
setFocusedLayer(address): ControlCommandResult;Defined in: controls/ControlSession.ts:343
Parameters
address
Returns
setExpandedSections()
setExpandedSections(sections): ControlCommandResult;Defined in: controls/ControlSession.ts:380
Parameters
sections
readonly SurfViewControlSectionId[]
Returns
setSectionExpanded()
setSectionExpanded(section, expanded): ControlCommandResult;Defined in: controls/ControlSession.ts:395
Parameters
section
expanded
boolean
Returns
setAdvancedVisible()
setAdvancedVisible(visible): ControlCommandResult;Defined in: controls/ControlSession.ts:414
Parameters
visible
boolean
Returns
setSymmetricRangeLock()
setSymmetricRangeLock(enabled): ControlCommandResult;Defined in: controls/ControlSession.ts:424
Parameters
enabled
boolean
Returns
setAnatomicalView()
setAnatomicalView(request): ControlCommandResult;Defined in: controls/ControlSession.ts:434
Parameters
request
Returns
Implementation of
SurfViewControlTargetCommands.setAnatomicalView
fitView()
fitView(): ControlCommandResult;Defined in: controls/ControlSession.ts:438
Returns
Implementation of
SurfViewControlTargetCommands.fitView
resetView()
resetView(): ControlCommandResult;Defined in: controls/ControlSession.ts:442
Returns
Implementation of
SurfViewControlTargetCommands.resetView
setSurfaceVisibility()
setSurfaceVisibility(surfaceId, visible): ControlCommandResult;Defined in: controls/ControlSession.ts:446
Parameters
surfaceId
string
visible
boolean
Returns
Implementation of
SurfViewControlTargetCommands.setSurfaceVisibility
setLayerVisibility()
setLayerVisibility(address, visible): ControlCommandResult;Defined in: controls/ControlSession.ts:450
Parameters
address
visible
boolean
Returns
Implementation of
SurfViewControlTargetCommands.setLayerVisibility
setLayerOpacity()
setLayerOpacity(address, opacity): ControlCommandResult;Defined in: controls/ControlSession.ts:457
Parameters
address
opacity
number
Returns
Implementation of
SurfViewControlTargetCommands.setLayerOpacity
setLayerBlendMode()
setLayerBlendMode(address, blendMode): ControlCommandResult;Defined in: controls/ControlSession.ts:464
Parameters
address
blendMode
Returns
Implementation of
SurfViewControlTargetCommands.setLayerBlendMode
setLayerOrder()
setLayerOrder(surfaceId, layerIds): ControlCommandResult;Defined in: controls/ControlSession.ts:471
Parameters
surfaceId
string
layerIds
readonly string[]
Returns
Implementation of
SurfViewControlTargetCommands.setLayerOrder
updateScalarMapping()
updateScalarMapping(address, update): ControlCommandResult;Defined in: controls/ControlSession.ts:478
Parameters
address
update
Returns
Implementation of
SurfViewControlTargetCommands.updateScalarMapping
setInspectionSelection()
setInspectionSelection(selection): ControlCommandResult;Defined in: controls/ControlSession.ts:485
Parameters
selection
Returns
Implementation of
SurfViewControlTargetCommands.setInspectionSelection
applyFigurePreset()
applyFigurePreset(presetId): ControlCommandResult;Defined in: controls/ControlSession.ts:489
Parameters
presetId
string
Returns
Implementation of
SurfViewControlTargetCommands.applyFigurePreset
setFigureBackground()
setFigureBackground(background, transparent?): ControlCommandResult;Defined in: controls/ControlSession.ts:493
Parameters
background
number
transparent?
boolean
Returns
Implementation of
SurfViewControlTargetCommands.setFigureBackground
exportFigure()
exportFigure(request?): Promise<ControlCommandResult<FigureExportResult>>;Defined in: controls/ControlSession.ts:497
Parameters
request?
Returns
Promise<ControlCommandResult<FigureExportResult>>
Implementation of
SurfViewControlTargetCommands.exportFigure
setDisplayedLayer()
setDisplayedLayer(layerId): ControlCommandResult;Defined in: controls/ControlSession.ts:505
Returns unsupported when ExclusiveMapCapability is absent.
Parameters
layerId
string