Interface: OrthogonalImageViewerOptions
Defined in: src/display/OrthogonalImageViewer.ts:26
Optional configuration for how each orthogonal viewer is displayed and operated.
Properties
width?
optional width?: number;Defined in: src/display/OrthogonalImageViewer.ts:30
Width in pixels for each of the sub-viewers (optional if auto-resizing).
height?
optional height?: number;Defined in: src/display/OrthogonalImageViewer.ts:35
Height in pixels for each of the sub-viewers (optional if auto-resizing).
showCrosshair?
optional showCrosshair?: boolean;Defined in: src/display/OrthogonalImageViewer.ts:40
Whether to display crosshair lines in the sub-viewers.
showOrientationLabels?
optional showOrientationLabels?: boolean;Defined in: src/display/OrthogonalImageViewer.ts:46
Whether to display anatomical orientation labels (L/R/A/P/S/I) at the edges of each sub-view. Labels are fixed-size and pinned to the viewport.
orientationLabelOptions?
optional orientationLabelOptions?: OrientationLabelOptions;Defined in: src/display/OrthogonalImageViewer.ts:52
Styling for the orientation labels. Only used when showOrientationLabels is true.
showSlider?
optional showSlider?: boolean;Defined in: src/display/OrthogonalImageViewer.ts:57
Whether to display a slider in each sub-viewer for changing slice indices.
layout?
optional layout?: "left-tall" | "top-bottom" | "ortho";Defined in: src/display/OrthogonalImageViewer.ts:68
Layout mode for arranging the three views.
- 'left-tall': axial occupies left column (both rows); coronal/sagittal on right (default, current)
- 'top-bottom': axial spans full width on top; sagittal and coronal split bottom row horizontally
- 'ortho': aligned 2x2 (coronal | sagittal / axial | legend). Tracks are sized from the volume extents so all three views share one scale and the crosshair lines continue across neighbouring views. The fourth cell is an empty host element, see OrthogonalImageViewer.getLegendElement.
crosshairOptions?
optional crosshairOptions?: CrossHairOptions;Defined in: src/display/OrthogonalImageViewer.ts:71
Crosshair styling (colour, alpha, width and gap in screen px).
backgroundColor?
optional backgroundColor?: number;Defined in: src/display/OrthogonalImageViewer.ts:74
Canvas clear colour for every view (PIXI numeric colour). Default 0x000000.
cellPaddingPx?
optional cellPaddingPx?: number;Defined in: src/display/OrthogonalImageViewer.ts:81
Space kept clear around each slice inside its cell, in screen px (room for orientation labels). In the 'ortho' layout the tracks absorb it, so all views keep one shared scale. Default 0.
stackBelowPx?
optional stackBelowPx?: number;Defined in: src/display/OrthogonalImageViewer.ts:88
'ortho' layout only: below this container width (px) the views stack in one column (coronal, sagittal, axial, legend) at a shared scale instead of shrinking the 2x2 grid. 0 disables stacking. Default 0.
stackedLegendHeightPx?
optional stackedLegendHeightPx?: number;Defined in: src/display/OrthogonalImageViewer.ts:91
'ortho' layout only: height of the legend row when stacked. Default 176.
stackMode?
optional stackMode?: "column" | "single";Defined in: src/display/OrthogonalImageViewer.ts:97
'ortho' layout only: when stacked, show every view in a column ('column') or one view at a time ('single', switch with setStackedView). Default 'column'.
focusOutline?
optional focusOutline?: string | null;Defined in: src/display/OrthogonalImageViewer.ts:103
CSS outline drawn on the hovered view, or null for none (hosts can style [data-nij-hover] instead). Default '2px solid rgba(100, 150, 255, 0.6)'.
gapPx?
optional gapPx?: number;Defined in: src/display/OrthogonalImageViewer.ts:108
CSS gap between grid cells, in pixels (default: '8px').