Skip to content

Interface: MountSurfViewOptions ​

Defined in: report/SceneMount.ts:60

Properties ​

lazy? ​

ts
optional lazy?: boolean;

Defined in: report/SceneMount.ts:62

Delay asset loading and WebGL creation until the container intersects the viewport.


rootMargin? ​

ts
optional rootMargin?: string;

Defined in: report/SceneMount.ts:64

IntersectionObserver root margin used by lazy mounting.


baseUrl? ​

ts
optional baseUrl?: string;

Defined in: report/SceneMount.ts:66

Asset URL base for adjacent-directory manifests.


fetcher? ​

ts
optional fetcher?: (input, init?) => Promise<Response>;

Defined in: report/SceneMount.ts:68

Fetch implementation used for adjacent assets.

MDN Reference

Parameters ​

input ​

RequestInfo | URL

init? ​

RequestInit

Returns ​

Promise<Response>


width? ​

ts
optional width?: number;

Defined in: report/SceneMount.ts:70

Initial CSS-pixel width. Defaults to the container width or 640.


height? ​

ts
optional height?: number;

Defined in: report/SceneMount.ts:72

Initial CSS-pixel height. Defaults to the container height or 480.


preset? ​

ts
optional preset?: SurfViewStylePresetName;

Defined in: report/SceneMount.ts:74

Viewer appearance preset. paper-light is the report default.


controls? ​

ts
optional controls?: boolean;

Defined in: report/SceneMount.ts:76

Show the small report toolbar. This never loads an external pane UI.


initialView? ​

ts
optional initialView?: AnatomicalView;

Defined in: report/SceneMount.ts:78

Initial anatomical view.


bilateralGroup? ​

ts
optional bilateralGroup?: BilateralSurfaceGroup;

Defined in: report/SceneMount.ts:83

Explicit pair controlled by coordinated report views. Required when a report contains more than one surface; pairs are never inferred.


hemisphereGap? ​

ts
optional hemisphereGap?: number;

Defined in: report/SceneMount.ts:85

Gap between recentered hemispheres in scene units.


layout? ​

ts
optional layout?: ReportLayout;

Defined in: report/SceneMount.ts:90

Pair pose: split (default) rotates each hemisphere into the view side by side; anatomical keeps one coherent brain and rotates it as a whole.


initialBrainView? ​

ts
optional initialBrainView?: ReportBrainView;

Defined in: report/SceneMount.ts:92

Initial whole-brain view for the anatomical layout. Defaults to oblique.


headlight? ​

ts
optional headlight?: boolean;

Defined in: report/SceneMount.ts:94

Attach the key light to the camera. Defaults to true for the anatomical layout.


fov? ​

ts
optional fov?: number;

Defined in: report/SceneMount.ts:96

Vertical camera field of view in degrees.


fitMargin? ​

ts
optional fitMargin?: number;

Defined in: report/SceneMount.ts:98

Camera fit margin as a fraction of the framed distance.


oblique? ​

ts
optional oblique?: "auto" | ReportObliqueAngle;

Defined in: report/SceneMount.ts:100

Camera angle of the oblique whole-brain view in degrees, or auto (data-driven).


fitInsets? ​

ts
optional fitInsets?: ReportFitInsets;

Defined in: report/SceneMount.ts:102

Canvas insets (CSS px) kept clear of the fitted brain for overlaid controls.


onError? ​

ts
optional onError?: (error) => void;

Defined in: report/SceneMount.ts:104

Called after a load or WebGL initialization failure is rendered inline.

Parameters ​

error ​

Error

Returns ​

void

Released under the MIT License.