Interface: SurfViewControlTarget

Defined in: controls/ControlTarget.ts:344

Stable control port implemented by viewer and report-scene adapters.

subscribe() synchronously delivers the current snapshot once, then delivers later canonical revisions. dispose() is idempotent, closes subscriptions, and causes every subsequent command to return a disposed failure. A disposed target may continue returning its last immutable snapshot from getSnapshot().

Extends

• SurfViewControlTargetCommands

Methods

setAnatomicalView()

setAnatomicalView(request): ControlCommandResult;

Defined in: controls/ControlTarget.ts:311

Parameters

request

SetAnatomicalViewRequest

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setAnatomicalView

---

fitView()

fitView(): ControlCommandResult;

Defined in: controls/ControlTarget.ts:312

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.fitView

---

resetView()

resetView(): ControlCommandResult;

Defined in: controls/ControlTarget.ts:313

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.resetView

---

setSurfaceVisibility()

setSurfaceVisibility(surfaceId, visible): ControlCommandResult;

Defined in: controls/ControlTarget.ts:314

Parameters

surfaceId

string

visible

boolean

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setSurfaceVisibility

---

setLayerVisibility()

setLayerVisibility(address, visible): ControlCommandResult;

Defined in: controls/ControlTarget.ts:315

Parameters

address

LayerControlAddress

visible

boolean

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setLayerVisibility

---

setLayerOpacity()

setLayerOpacity(address, opacity): ControlCommandResult;

Defined in: controls/ControlTarget.ts:316

Parameters

address

LayerControlAddress

opacity

number

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setLayerOpacity

---

setLayerBlendMode()

setLayerBlendMode(address, blendMode): ControlCommandResult;

Defined in: controls/ControlTarget.ts:317

Parameters

address

LayerControlAddress

blendMode

BlendMode

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setLayerBlendMode

---

setLayerOrder()

setLayerOrder(surfaceId, layerIds): ControlCommandResult;

Defined in: controls/ControlTarget.ts:318

Parameters

surfaceId

string

layerIds

readonly string[]

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setLayerOrder

---

updateScalarMapping()

updateScalarMapping(address, update): ControlCommandResult;

Defined in: controls/ControlTarget.ts:319

Parameters

address

LayerControlAddress

update

ScalarMappingUpdate

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.updateScalarMapping

---

setInspectionSelection()

setInspectionSelection(selection): ControlCommandResult;

Defined in: controls/ControlTarget.ts:320

Parameters

selection

InspectionSelection

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setInspectionSelection

---

applyFigurePreset()

applyFigurePreset(presetId): ControlCommandResult;

Defined in: controls/ControlTarget.ts:321

Parameters

presetId

string

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.applyFigurePreset

---

setFigureBackground()

setFigureBackground(background, transparent?): ControlCommandResult;

Defined in: controls/ControlTarget.ts:322

Parameters

background

number

transparent?

boolean

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setFigureBackground

---

exportFigure()

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

Defined in: controls/ControlTarget.ts:323

Parameters

request?

FigureExportRequest

Returns

Promise<ControlCommandResult<FigureExportResult>>

Inherited from

SurfViewControlTargetCommands.exportFigure

---

setDisplayedLayer()

setDisplayedLayer(layerId): ControlCommandResult;

Defined in: controls/ControlTarget.ts:325

Returns unsupported when ExclusiveMapCapability is absent.

Parameters

layerId

string

Returns

ControlCommandResult

Inherited from

SurfViewControlTargetCommands.setDisplayedLayer

---

getSnapshot()

getSnapshot(): SurfViewControlSnapshot;

Defined in: controls/ControlTarget.ts:345

Returns

SurfViewControlSnapshot

---

getLayerDataSummary()

getLayerDataSummary(address): ControlQueryResult<LayerDataSummaryControlDescriptor>;

Defined in: controls/ControlTarget.ts:347

Lazily obtain the configured histogram summary for one scalar layer.

Parameters

address

LayerControlAddress

Returns

ControlQueryResult<LayerDataSummaryControlDescriptor>

---

subscribe()

subscribe(listener): SurfViewControlSubscription;

Defined in: controls/ControlTarget.ts:350

Parameters

listener

SurfViewControlSnapshotListener

Returns

SurfViewControlSubscription

---

isDisposed()

isDisposed(): boolean;

Defined in: controls/ControlTarget.ts:351

Returns

boolean

---

dispose()

dispose(): void;

Defined in: controls/ControlTarget.ts:352

Returns

void