Skip to content

Interface: ISliceView ​

Defined in: src/display/interfaces/ISliceView.ts:8

Interface for the slice view component that handles rendering and display

Accessors ​

width ​

Get Signature ​

ts
get width(): number;

Defined in: src/display/interfaces/ISliceView.ts:57

Get the width of the view

Returns ​

number


height ​

Get Signature ​

ts
get height(): number;

Defined in: src/display/interfaces/ISliceView.ts:62

Get the height of the view

Returns ​

number

Methods ​

updatePosition() ​

ts
updatePosition(coord): void;

Defined in: src/display/interfaces/ISliceView.ts:12

Update the position/coordinate being displayed

Parameters ​

coord ​

number[]

Returns ​

void


renderSlice() ​

ts
renderSlice(): void;

Defined in: src/display/interfaces/ISliceView.ts:17

Render the current slice

Returns ​

void


handleResize() ​

ts
handleResize(): void;

Defined in: src/display/interfaces/ISliceView.ts:22

Handle window/container resize events

Returns ​

void


getCoordinateTransformer() ​

ts
getCoordinateTransformer(): ICoordinateTransformer;

Defined in: src/display/interfaces/ISliceView.ts:27

Get the coordinate transformer for this view

Returns ​

ICoordinateTransformer


getCanvas() ​

ts
getCanvas(): HTMLCanvasElement;

Defined in: src/display/interfaces/ISliceView.ts:32

Get the canvas element

Returns ​

HTMLCanvasElement


addPointerMoveListener() ​

ts
addPointerMoveListener(handler): void;

Defined in: src/display/interfaces/ISliceView.ts:37

Add a pointer move event listener

Parameters ​

handler ​

PointerEventHandler

Returns ​

void


addPointerDownListener() ​

ts
addPointerDownListener(handler): void;

Defined in: src/display/interfaces/ISliceView.ts:42

Add a pointer down event listener

Parameters ​

handler ​

PointerEventHandler

Returns ​

void


removePointerMoveListener() ​

ts
removePointerMoveListener(handler): void;

Defined in: src/display/interfaces/ISliceView.ts:47

Remove a pointer move event listener

Parameters ​

handler ​

PointerEventHandler

Returns ​

void


removePointerDownListener() ​

ts
removePointerDownListener(handler): void;

Defined in: src/display/interfaces/ISliceView.ts:52

Remove a pointer down event listener

Parameters ​

handler ​

PointerEventHandler

Returns ​

void


getScale() ​

ts
getScale(): number;

Defined in: src/display/interfaces/ISliceView.ts:67

Get the current scale factor applied to the view content

Returns ​

number


dispose() ​

ts
dispose(): void;

Defined in: src/display/interfaces/ISliceView.ts:72

Dispose of the view and clean up resources

Returns ​

void


disposeLayers()? ​

ts
optional disposeLayers(): void;

Defined in: src/display/interfaces/ISliceView.ts:75

Release render layers before renderer teardown in multi-view owners.

Returns ​

void


addLayer()? ​

ts
optional addLayer(id, layer): void;

Defined in: src/display/interfaces/ISliceView.ts:80

Add a render layer (e.g., crosshair or custom annotation)

Parameters ​

id ​

string

layer ​

SliceLayer

Returns ​

void


removeLayer()? ​

ts
optional removeLayer(id): void;

Defined in: src/display/interfaces/ISliceView.ts:85

Remove a render layer by id

Parameters ​

id ​

string

Returns ​

void


getLayer()? ​

ts
optional getLayer(id): SliceLayer | undefined;

Defined in: src/display/interfaces/ISliceView.ts:88

Look up a render layer by id.

Parameters ​

id ​

string

Returns ​

SliceLayer | undefined


setBackground()? ​

ts
optional setBackground(color, alpha?): void;

Defined in: src/display/interfaces/ISliceView.ts:91

Change the canvas clear colour (and alpha) without rebuilding.

Parameters ​

color ​

number

alpha? ​

number

Returns ​

void


redraw()? ​

ts
optional redraw(): void;

Defined in: src/display/interfaces/ISliceView.ts:94

Re-lay out screen-space overlays and render, without rebuilding textures.

Returns ​

void

Released under the MIT License.