Skip to content

Class: SliceView

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

SliceView manages a PIXI.js Application to display slices from one or more volumetric datasets. It:

  • Holds a mainContainer for each sprite/layer
  • Maintains a CoordinateTransformer for screen↔volume coords
  • Listens to a SliceModel for current slice index or 3D coord

Implements

Properties

app

ts
app: Application;

Defined in: src/display/SliceView.ts:33


mainContainer

ts
mainContainer: Container;

Defined in: src/display/SliceView.ts:34


overlayContainer

ts
overlayContainer: Container;

Defined in: src/display/SliceView.ts:38


slider

ts
slider: HTMLInputElement | null = null;

Defined in: src/display/SliceView.ts:40


coordinateTransformer

ts
coordinateTransformer: CoordinateTransformer;

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


domElement

ts
domElement: HTMLElement;

Defined in: src/display/SliceView.ts:42


layers

ts
layers: SliceLayer[] = [];

Defined in: src/display/SliceView.ts:44

Accessors

width

Get Signature

ts
get width(): number;

Defined in: src/display/SliceView.ts:589

Get the width of the view

Returns

number

Implementation of

ISliceView.width


height

Get Signature

ts
get height(): number;

Defined in: src/display/SliceView.ts:596

Get the height of the view

Returns

number

Implementation of

ISliceView.height

Methods

create()

ts
static create(
   domElement, 
   imageLayer, 
   neuroSpace, 
   viewAxes, 
   model, 
   options?): Promise<SliceView>;

Defined in: src/display/SliceView.ts:84

Factory function to build a SliceView instance (async).

Parameters

domElement

HTMLElement

imageLayer

ImageLayer

neuroSpace

NeuroSpace

viewAxes

AxisSet3D

model

SliceModel

options?

SliceViewOptions

Returns

Promise<SliceView>


updatePosition()

ts
updatePosition(coord): void;

Defined in: src/display/SliceView.ts:280

Updates the displayed position in 3D coordinate space in the imageLayer + overlay layers, then triggers re-render.

Parameters

coord

number[]

Returns

void

Implementation of

ISliceView.updatePosition


renderSlice()

ts
renderSlice(): void;

Defined in: src/display/SliceView.ts:295

Renders the current slice by:

  • Setting the pinned slice index in the transformer
  • Clearing previous container
  • Asking imageLayer + overlays to render
  • Fitting to screen

Returns

void

Implementation of

ISliceView.renderSlice


handleResize()

ts
handleResize(): void;

Defined in: src/display/SliceView.ts:481

Public method for programmatic resize triggering. Automatic window resize is handled by PIXI's resizeTo option. Uses requestAnimationFrame to ensure DOM layout is settled before calculating sizes.

Returns

void

Implementation of

ISliceView.handleResize


handlePointerMove()

ts
handlePointerMove(event): void;

Defined in: src/display/SliceView.ts:493

Dispatch pointer move events to layers

Parameters

event

SlicePointerEvent

Returns

void


addLayer()

ts
addLayer(id, layer): void;

Defined in: src/display/SliceView.ts:505

Adds a new overlay (e.g., crosshair).

Parameters

id

string

layer

SliceLayer

Returns

void

Implementation of

ISliceView.addLayer


removeLayer()

ts
removeLayer(id): void;

Defined in: src/display/SliceView.ts:522

Removes an overlay layer by id (e.g., 'crosshair').

Parameters

id

string

Returns

void

Implementation of

ISliceView.removeLayer


getCoordinateTransformer()

ts
getCoordinateTransformer(): ICoordinateTransformer;

Defined in: src/display/SliceView.ts:540

Get the coordinate transformer for this view

Returns

ICoordinateTransformer

Implementation of

ISliceView.getCoordinateTransformer


getCanvas()

ts
getCanvas(): HTMLCanvasElement;

Defined in: src/display/SliceView.ts:547

Get the canvas element

Returns

HTMLCanvasElement

Implementation of

ISliceView.getCanvas


addPointerMoveListener()

ts
addPointerMoveListener(handler): void;

Defined in: src/display/SliceView.ts:561

Add a pointer move event listener

Parameters

handler

PointerEventHandler

Returns

void

Implementation of

ISliceView.addPointerMoveListener


addPointerDownListener()

ts
addPointerDownListener(handler): void;

Defined in: src/display/SliceView.ts:568

Add a pointer down event listener

Parameters

handler

PointerEventHandler

Returns

void

Implementation of

ISliceView.addPointerDownListener


removePointerMoveListener()

ts
removePointerMoveListener(handler): void;

Defined in: src/display/SliceView.ts:575

Remove a pointer move event listener

Parameters

handler

PointerEventHandler

Returns

void

Implementation of

ISliceView.removePointerMoveListener


removePointerDownListener()

ts
removePointerDownListener(handler): void;

Defined in: src/display/SliceView.ts:582

Remove a pointer down event listener

Parameters

handler

PointerEventHandler

Returns

void

Implementation of

ISliceView.removePointerDownListener


setZoom()

ts
setZoom(level): void;

Defined in: src/display/SliceView.ts:603

Set the zoom level, clamped to [MIN_ZOOM, MAX_ZOOM].

Parameters

level

number

Returns

void


getZoom()

ts
getZoom(): number;

Defined in: src/display/SliceView.ts:614

Get the current zoom level.

Returns

number


setPan()

ts
setPan(offset): void;

Defined in: src/display/SliceView.ts:621

Set the pan offset.

Parameters

offset
x

number

y

number

Returns

void


getPan()

ts
getPan(): object;

Defined in: src/display/SliceView.ts:632

Get the current pan offset.

Returns

object

x
ts
x: number;
y
ts
y: number;

resetView()

ts
resetView(): void;

Defined in: src/display/SliceView.ts:639

Reset zoom to 1.0 and pan to (0, 0).

Returns

void


getScale()

ts
getScale(): number;

Defined in: src/display/SliceView.ts:651

Get the current scale applied to the slice content.

Returns

number

Implementation of

ISliceView.getScale


dispose()

ts
dispose(): void;

Defined in: src/display/SliceView.ts:658

Cleanup

Returns

void

Implementation of

ISliceView.dispose

Released under the MIT License.