Skip to content

Interface: SurfViewMountHandle ​

Defined in: report/SceneMount.ts:107

Properties ​

ready ​

ts
readonly ready: Promise<void>;

Defined in: report/SceneMount.ts:109

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


viewer ​

ts
readonly viewer: NeuroSurfaceViewer | null;

Defined in: report/SceneMount.ts:111

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


controlTarget ​

ts
readonly controlTarget: SurfViewControlTarget | null;

Defined in: report/SceneMount.ts:113

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


manifest ​

ts
readonly manifest: SurfViewSceneManifest;

Defined in: report/SceneMount.ts:115

The validated manifest used by this mount.

Methods ​

selectLayer() ​

ts
selectLayer(layerId): void;

Defined in: report/SceneMount.ts:116

Parameters ​

layerId ​

string

Returns ​

void


setView() ​

ts
setView(view): void;

Defined in: report/SceneMount.ts:118

Parameters ​

view ​

SurfViewSceneView

Returns ​

void

Deprecated ​

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


resetView() ​

ts
resetView(): void;

Defined in: report/SceneMount.ts:120

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

Returns ​

void


setBrainView() ​

ts
setBrainView(view): void;

Defined in: report/SceneMount.ts:122

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

Parameters ​

view ​

ReportBrainView

Returns ​

void


getBrainView() ​

ts
getBrainView(): ReportBrainView | null;

Defined in: report/SceneMount.ts:124

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

Returns ​

ReportBrainView | null


setFitInsets() ​

ts
setFitInsets(insets): void;

Defined in: report/SceneMount.ts:126

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

Parameters ​

insets ​

ReportFitInsets

Returns ​

void


getAnatomicalViewCapabilities() ​

ts
getAnatomicalViewCapabilities(): AnatomicalViewCapabilities;

Defined in: report/SceneMount.ts:127

Returns ​

AnatomicalViewCapabilities


resize() ​

ts
resize(width?, height?): void;

Defined in: report/SceneMount.ts:128

Parameters ​

width? ​

number

height? ​

number

Returns ​

void


exportPNG() ​

ts
exportPNG(options?): string;

Defined in: report/SceneMount.ts:129

Parameters ​

options? ​

FigureExportOptions

Returns ​

string


dispose() ​

ts
dispose(): void;

Defined in: report/SceneMount.ts:130

Returns ​

void

Released under the MIT License.