Interface: SimpleOrthogonalViewerOptions

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

Properties

layout?

optional layout?: LayoutMode;

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

---

showCrosshair?

optional showCrosshair?: boolean;

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

---

showSlider?

optional showSlider?: boolean;

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

---

gapPx?

optional gapPx?: number;

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

---

showIntensityReadout?

optional showIntensityReadout?: boolean;

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

Accepted for API compatibility but currently ignored: no intensity readout is drawn. Build one from onCoordChange and getValue instead (see the Viewers guide).

Default

false

---

showOrientationLabels?

optional showOrientationLabels?: boolean;

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

Show anatomical orientation labels (L/R/A/P/S/I) pinned to each view's edges.

---

orientationLabelOptions?

optional orientationLabelOptions?: OrientationLabelOptions;

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

Styling for the orientation labels. Only used when showOrientationLabels is true.

---

crosshairOptions?

optional crosshairOptions?: CrossHairOptions;

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

Crosshair styling (colour, alpha, width and gap in screen px).

---

backgroundColor?

optional backgroundColor?: number;

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

Canvas clear colour for every view (PIXI numeric colour). Default 0x000000.

---

focusOutline?

optional focusOutline?: string | null;

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

CSS outline on the hovered view, or null for none.

---

cellPaddingPx?

optional cellPaddingPx?: number;

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

Space kept clear around each slice inside its cell, in screen px.

---

stackBelowPx?

optional stackBelowPx?: number;

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

'ortho' layout: stack the views in one column below this width (px).

---

stackedLegendHeightPx?

optional stackedLegendHeightPx?: number;

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

'ortho' layout: legend row height when stacked (px).

---

stackMode?

optional stackMode?: "column" | "single";

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

'ortho' layout: stacked views as a column or one at a time.

---

alignmentStrategy?

optional alignmentStrategy?: AlignmentStrategyType;

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

How layers that are not on the first layer's voxel grid are placed. 'world' slices each one on its own grid and draws it at its true world position (e.g. a 2 mm statistical map over a 1 mm template); this is the default. 'auto' restores the earlier heuristic fit, which fits slice bounds and reuses the first layer's slice index. Can be changed later with SimpleOrthogonalViewer.setAlignmentStrategy.