Class: ReportSceneControlTarget

Defined in: report/ReportSceneControlTarget.ts:118

Control adapter for one coordinated report scene. It composes the ordinary viewer port for shared commands, while owning report view, exclusive-map, and manifest-presentation semantics explicitly.

Implements

• SurfViewControlTarget

Constructors

Constructor

new ReportSceneControlTarget(controller, options?): ReportSceneControlTarget;

Defined in: report/ReportSceneControlTarget.ts:130

Parameters

controller

ReportSceneController

options?

ViewerControlTargetOptions = {}

Returns

ReportSceneControlTarget

Methods

getSnapshot()

getSnapshot(): SurfViewControlSnapshot;

Defined in: report/ReportSceneControlTarget.ts:170

Returns

SurfViewControlSnapshot

Implementation of

SurfViewControlTarget.getSnapshot

---

getLayerDataSummary()

getLayerDataSummary(address): ControlQueryResult<LayerDataSummaryControlDescriptor>;

Defined in: report/ReportSceneControlTarget.ts:174

Lazily obtain the configured histogram summary for one scalar layer.

Parameters

address

LayerControlAddress

Returns

ControlQueryResult<LayerDataSummaryControlDescriptor>

Implementation of

SurfViewControlTarget.getLayerDataSummary

---

subscribe()

subscribe(listener): SurfViewControlSubscription;

Defined in: report/ReportSceneControlTarget.ts:181

Parameters

listener

SurfViewControlSnapshotListener

Returns

SurfViewControlSubscription

Implementation of

SurfViewControlTarget.subscribe

---

isDisposed()

isDisposed(): boolean;

Defined in: report/ReportSceneControlTarget.ts:197

Returns

boolean

Implementation of

SurfViewControlTarget.isDisposed

---

dispose()

dispose(): void;

Defined in: report/ReportSceneControlTarget.ts:204

Returns

void

Implementation of

SurfViewControlTarget.dispose

---

setAnatomicalView()

setAnatomicalView(request): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:215

Parameters

request

SetAnatomicalViewRequest

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setAnatomicalView

---

fitView()

fitView(): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:236

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.fitView

---

resetView()

resetView(): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:240

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.resetView

---

setSurfaceVisibility()

setSurfaceVisibility(surfaceId, visible): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:244

Parameters

surfaceId

string

visible

boolean

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setSurfaceVisibility

---

setLayerVisibility()

setLayerVisibility(address, visible): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:249

Parameters

address

LayerControlAddress

visible

boolean

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setLayerVisibility

---

setLayerOpacity()

setLayerOpacity(address, opacity): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:267

Parameters

address

LayerControlAddress

opacity

number

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setLayerOpacity

---

setLayerBlendMode()

setLayerBlendMode(address, blendMode): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:279

Parameters

address

LayerControlAddress

blendMode

BlendMode

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setLayerBlendMode

---

setLayerOrder()

setLayerOrder(_surfaceId, _layerIds): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:288

Parameters

_surfaceId

string

_layerIds

readonly string[]

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setLayerOrder

---

updateScalarMapping()

updateScalarMapping(address, update): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:298

Parameters

address

LayerControlAddress

update

ScalarMappingUpdate

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.updateScalarMapping

---

setInspectionSelection()

setInspectionSelection(selection): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:306

Parameters

selection

InspectionSelection

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setInspectionSelection

---

applyFigurePreset()

applyFigurePreset(presetId): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:311

Parameters

presetId

string

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.applyFigurePreset

---

setFigureBackground()

setFigureBackground(background, transparent?): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:315

Parameters

background

number

transparent?

boolean = false

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setFigureBackground

---

exportFigure()

exportFigure(request?): Promise<ControlCommandResult<FigureExportResult>>;

Defined in: report/ReportSceneControlTarget.ts:320

Parameters

request?

FigureExportRequest = {}

Returns

Promise<ControlCommandResult<FigureExportResult>>

Implementation of

SurfViewControlTarget.exportFigure

---

setDisplayedLayer()

setDisplayedLayer(layerId): ControlCommandResult;

Defined in: report/ReportSceneControlTarget.ts:327

Returns unsupported when ExclusiveMapCapability is absent.

Parameters

layerId

string

Returns

ControlCommandResult

Implementation of

SurfViewControlTarget.setDisplayedLayer