Interface: SurfViewMountHandle

Defined in: report/SceneMount.ts:108

Properties

ready

readonly ready: Promise<void>;

Defined in: report/SceneMount.ts:110

Resolves after assets, surfaces, controls, and the first view are ready.

---

viewer

readonly viewer: NeuroSurfaceViewer | null;

Defined in: report/SceneMount.ts:112

The viewer after mounting, or null while lazy/unmounted/disposed.

---

controlTarget

readonly controlTarget: SurfViewControlTarget | null;

Defined in: report/SceneMount.ts:114

The report-aware target after mounting, or null while lazy/unmounted/disposed.

---

manifest

readonly manifest: SurfViewSceneManifest;

Defined in: report/SceneMount.ts:116

The validated manifest used by this mount.

Methods

selectLayer()

selectLayer(layerId): void;

Defined in: report/SceneMount.ts:117

Parameters

layerId

string

Returns

void

---

setView()

setView(view): void;

Defined in: report/SceneMount.ts:119

Parameters

view

SurfViewSceneView

Returns

void

Deprecated

Passing "reset" remains supported; prefer resetView().

---

resetView()

resetView(): void;

Defined in: report/SceneMount.ts:121

Restore the initial anatomical view and authored reference visibility/opacity.

Returns

void

---

setBrainView()

setBrainView(view): void;

Defined in: report/SceneMount.ts:123

Pose the pair as one brain (anatomical layout only).

Parameters

view

ReportBrainView

Returns

void

---

getBrainView()

getBrainView(): ReportBrainView | null;

Defined in: report/SceneMount.ts:125

Current whole-brain view, or null after free rotation.

Returns

ReportBrainView | null

---

setFitInsets()

setFitInsets(insets): void;

Defined in: report/SceneMount.ts:127

Update the canvas insets kept clear of the fitted brain, and refit.

Parameters

insets

ReportFitInsets

Returns

void

---

getAnatomicalViewCapabilities()

getAnatomicalViewCapabilities(): AnatomicalViewCapabilities;

Defined in: report/SceneMount.ts:128

Returns

AnatomicalViewCapabilities

---

getSurfaceVariants()

getSurfaceVariants(): readonly string[];

Defined in: report/SceneMount.ts:133

Names of the alternative surface embeddings the scene ships (for example inflated, pial, white), in manifest order; empty without variants.

Returns

readonly string[]

---

getSurfaceVariant()

getSurfaceVariant(): string | null;

Defined in: report/SceneMount.ts:135

The embedding currently shown, or null when the scene has no variants.

Returns

string | null

---

setSurfaceVariant()

setSurfaceVariant(name): void;

Defined in: report/SceneMount.ts:140

Show another embedding on every hemisphere. Data, threshold, curvature and the current view are kept; a named view is re-posed and refitted.

Parameters

name

string

Returns

void

---

resize()

resize(width?, height?): void;

Defined in: report/SceneMount.ts:141

Parameters

width?

number

height?

number

Returns

void

---

exportPNG()

exportPNG(options?): string;

Defined in: report/SceneMount.ts:142

Parameters

options?

FigureExportOptions

Returns

string

---

dispose()

dispose(): void;

Defined in: report/SceneMount.ts:143

Returns

void