Class: SimpleOrthogonalViewer

Defined in: src/display/SimpleOrthogonalViewer.ts:37

Simple wrapper around OrthogonalImageViewer that exposes a minimal, programmatic API suitable for embedding in external applications without shipping UI widgets.

This is the recommended (canonical) high-level 3-up orthogonal viewer. For custom layouts or finer control, compose SingleSliceViewer instances with ViewSynchronizer instead. See the architecture note on SliceViewer.

Methods

create()

static create(
   container, 
   volStack, 
   options?): Promise<SimpleOrthogonalViewer>;

Defined in: src/display/SimpleOrthogonalViewer.ts:58

Parameters

container

HTMLElement

volStack

VolStack

options?

SimpleOrthogonalViewerOptions

Returns

Promise<SimpleOrthogonalViewer>

---

setWorldCoord()

setWorldCoord(coord): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:102

Parameters

coord

number[]

Returns

void

---

getWorldCoord()

getWorldCoord(): number[];

Defined in: src/display/SimpleOrthogonalViewer.ts:106

Returns

number[]

---

setLPICoord()

setLPICoord(lpiCoord): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:116

Set position using LPI anatomical world coordinates (mm) regardless of the underlying volume orientation. Converts LPI→volume space and updates slices.

LPI means: X=Left(+)/Right(-), Y=Posterior(+)/Anterior(-), Z=Inferior(+)/Superior(-).

Parameters

lpiCoord

[number, number, number]

Returns

void

---

getLPICoord()

getLPICoord(): [number, number, number];

Defined in: src/display/SimpleOrthogonalViewer.ts:130

Read current position as LPI anatomical world coordinates (mm).

Returns

[number, number, number]

---

setSliceIndex()

setSliceIndex(view, index): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:144

Set the discrete slice index for a specific orthogonal view. This is often more convenient than computing a world coordinate.

Parameters

view

"axial" | "coronal" | "sagittal"

index

number

Returns

void

---

getSliceIndex()

getSliceIndex(view): number;

Defined in: src/display/SimpleOrthogonalViewer.ts:152

Get the current slice index for a specific view.

Parameters

view

"axial" | "coronal" | "sagittal"

Returns

number

---

addLayer()

addLayer(layer): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:157

Parameters

layer

VolLayer

Returns

void

---

removeLayer()

removeLayer(layerId): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:163

Parameters

layerId

string

Returns

void

---

updateLayer()

updateLayer(layerId, params): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:172

Parameters

layerId

string

params

colormap?

string | ColorMap

range?

[number, number]

threshold?

[number, number]

alpha?

number

visible?

boolean

Returns

void

---

updateLayerVolume()

updateLayerVolume(
   layerId, 
   volume, 
   opts?): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:200

Replace the underlying volume for an existing layer (keeps z-order and id). Handy for fast overlay updates (e.g., sigma changes) without add/remove.

Parameters

layerId

string

volume

NeuroVol

opts?

range?

[number, number] | null

threshold?

[number, number]

alpha?

number

colormap?

string | ColorMap

Returns

void

---

getCanvas()

getCanvas(view): HTMLCanvasElement;

Defined in: src/display/SimpleOrthogonalViewer.ts:223

Parameters

view

"axial" | "coronal" | "sagittal"

Returns

HTMLCanvasElement

---

setBackground()

setBackground(color): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:228

Parameters

color

number

Returns

void

---

setCrosshairVisible()

setCrosshairVisible(visible): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:237

Parameters

visible

boolean

Returns

void

---

onReady()

onReady(handler): () => void;

Defined in: src/display/SimpleOrthogonalViewer.ts:242

Parameters

handler

() => void

Returns

() => void

---

onCoordChange()

onCoordChange(handler): () => void;

Defined in: src/display/SimpleOrthogonalViewer.ts:245

Parameters

handler

(coord) => void

Returns

() => void

---

onSliceChange()

onSliceChange(handler): () => void;

Defined in: src/display/SimpleOrthogonalViewer.ts:248

Parameters

handler

(p) => void

Returns

() => void

---

setAlignmentOptions()

setAlignmentOptions(options): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:253

Parameters

options

Partial<AlignmentManagerOptions>

Returns

void

---

setAlignmentStrategy()

setAlignmentStrategy(strategy): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:258

Parameters

strategy

AlignmentStrategyType

Returns

void

---

moveLayer()

moveLayer(layerId, toIndex): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:266

Change z-order of a layer (0 = back/reference). Emits layerOrderChanged.

Parameters

layerId

string

toIndex

number

Returns

void

---

setFocusedView()

setFocusedView(view): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:274

Parameters

view

"axial" | "coronal" | "sagittal" | null

Returns

void

---

setOrientationLabelsVisible()

setOrientationLabelsVisible(visible, options?): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:284

Toggle anatomical orientation labels (L/R/A/P/S/I) across all three views.

Parameters

visible

boolean

Whether the labels should be shown.

options?

OrientationLabelOptions

Optional styling applied to every sub-view.

Returns

void

---

listLayers()

listLayers(): object[];

Defined in: src/display/SimpleOrthogonalViewer.ts:301

Enumerate layers with display state for external systems.

Returns

object[]

---

getState()

getState(): object;

Defined in: src/display/SimpleOrthogonalViewer.ts:326

Snapshot minimal viewer state for persistence.

Returns

object

worldCoord

worldCoord: number[];

lpiCoord

lpiCoord: [number, number, number];

slices

slices: object;

slices.axial

axial: number;

slices.coronal

coronal: number;

slices.sagittal

sagittal: number;

layers

layers: object[];

---

applyState()

applyState(state): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:347

Restore viewer state (best-effort). Does not alter layout.

Parameters

state

Partial<ReturnType<SimpleOrthogonalViewer["getState"]>>

Returns

void

---

toDataURL()

toDataURL(
   view, 
   type?, 
   quality?): string;

Defined in: src/display/SimpleOrthogonalViewer.ts:376

Export a PNG/JPEG of a specific view's canvas.

Parameters

view

"axial" | "coronal" | "sagittal"

type?

string = 'image/png'

quality?

number

Returns

string

---

setZoom()

setZoom(view, level): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:391

Set the zoom level for a specific view.

Parameters

view

"axial" | "coronal" | "sagittal"

level

number

Returns

void

---

getZoom()

getZoom(view): number;

Defined in: src/display/SimpleOrthogonalViewer.ts:402

Get the current zoom level for a specific view.

Parameters

view

"axial" | "coronal" | "sagittal"

Returns

number

---

resetAllViews()

resetAllViews(): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:411

Reset zoom and pan for all views.

Returns

void

---

dispose()

dispose(): void;

Defined in: src/display/SimpleOrthogonalViewer.ts:421

Returns

void