Interface: SurfViewControlTargetCommands

Defined in: controls/ControlTarget.ts:310

Commands shared by viewer and report-scene target adapters. An ok result means the next canonical snapshot reflects the command; a failed command must not mutate target state.

Extended by

• SurfViewControlTarget

Methods

setAnatomicalView()

setAnatomicalView(request): ControlCommandResult;

Defined in: controls/ControlTarget.ts:311

Parameters

request

SetAnatomicalViewRequest

Returns

ControlCommandResult

---

fitView()

fitView(): ControlCommandResult;

Defined in: controls/ControlTarget.ts:312

Returns

ControlCommandResult

---

resetView()

resetView(): ControlCommandResult;

Defined in: controls/ControlTarget.ts:313

Returns

ControlCommandResult

---

setSurfaceVisibility()

setSurfaceVisibility(surfaceId, visible): ControlCommandResult;

Defined in: controls/ControlTarget.ts:314

Parameters

surfaceId

string

visible

boolean

Returns

ControlCommandResult

---

setLayerVisibility()

setLayerVisibility(address, visible): ControlCommandResult;

Defined in: controls/ControlTarget.ts:315

Parameters

address

LayerControlAddress

visible

boolean

Returns

ControlCommandResult

---

setLayerOpacity()

setLayerOpacity(address, opacity): ControlCommandResult;

Defined in: controls/ControlTarget.ts:316

Parameters

address

LayerControlAddress

opacity

number

Returns

ControlCommandResult

---

setLayerBlendMode()

setLayerBlendMode(address, blendMode): ControlCommandResult;

Defined in: controls/ControlTarget.ts:317

Parameters

address

LayerControlAddress

blendMode

BlendMode

Returns

ControlCommandResult

---

setLayerOrder()

setLayerOrder(surfaceId, layerIds): ControlCommandResult;

Defined in: controls/ControlTarget.ts:318

Parameters

surfaceId

string

layerIds

readonly string[]

Returns

ControlCommandResult

---

updateScalarMapping()

updateScalarMapping(address, update): ControlCommandResult;

Defined in: controls/ControlTarget.ts:319

Parameters

address

LayerControlAddress

update

ScalarMappingUpdate

Returns

ControlCommandResult

---

setInspectionSelection()

setInspectionSelection(selection): ControlCommandResult;

Defined in: controls/ControlTarget.ts:320

Parameters

selection

InspectionSelection

Returns

ControlCommandResult

---

applyFigurePreset()

applyFigurePreset(presetId): ControlCommandResult;

Defined in: controls/ControlTarget.ts:321

Parameters

presetId

string

Returns

ControlCommandResult

---

setFigureBackground()

setFigureBackground(background, transparent?): ControlCommandResult;

Defined in: controls/ControlTarget.ts:322

Parameters

background

number

transparent?

boolean

Returns

ControlCommandResult

---

exportFigure()

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

Defined in: controls/ControlTarget.ts:323

Parameters

request?

FigureExportRequest

Returns

Promise<ControlCommandResult<FigureExportResult>>

---

setDisplayedLayer()

setDisplayedLayer(layerId): ControlCommandResult;

Defined in: controls/ControlTarget.ts:325

Returns unsupported when ExclusiveMapCapability is absent.

Parameters

layerId

string

Returns

ControlCommandResult