ImageLayer

A layer that renders a 2D slice of a chunked, multi-channel image source.

ImageLayer streams chunks from a ChunkSource (e.g. OmeZarrImageSource) according to the supplied ImageSourcePolicy, which decides which resolution levels and chunks to load for the current view. Per-channel appearance (contrast limits, color, visibility) is controlled via ChannelProps, and the visible slice is selected with SliceCoordinates.

Extends Layer and inherits all public properties and methods.

Implements

• ChannelsEnabled

Constructor

new ImageLayer(__namedParameters): ImageLayer;

Parameter

Type

__namedParameters

LayerProps & { source: ChunkSource; sliceCoords: SliceCoordinates; policy?: Readonly<{ profile: string; prefetch: { x: number; y: number; z: number; t: number; }; priorityOrder: readonly ( | "fallbackVisible" | "prefetchTime" | "visibleCurrent" | "fallbackBackground" | "prefetchSpace")[]; priorityMap: Readonly<Record<PriorityCategory, number>>; lod: { min: number; max: number; bias: number; }; }>; orientation?: SliceOrientation; channelProps?: ChannelProps[]; onPickValue?: (info) => void; }

Properties

type overrides

readonly type: "ImageLayer" = "ImageLayer";

Accessors

orientation SliceOrientation

get orientation(): SliceOrientation;

lastPresentationTimeCoord number | undefined

get lastPresentationTimeCoord(): number | undefined;

chunkStoreView ChunkStoreView | undefined

get chunkStoreView(): ChunkStoreView | undefined;

sliceCoords SliceCoordinates

get sliceCoords(): SliceCoordinates;

source ChunkSource

get source(): ChunkSource;

imageSourcePolicy Readonly<ImageSourcePolicy>

get imageSourcePolicy(): Readonly<ImageSourcePolicy>;

set imageSourcePolicy(newPolicy): void;

Parameter	Type
newPolicy	ImageSourcePolicy

debugMode boolean

get debugMode(): boolean;

set debugMode(debug): void;

Parameter	Type
debug	boolean

channelProps ChannelProps[] | undefined

get channelProps(): ChannelProps[] | undefined;

Methods

attach() void overrides

protected attach(context): void;

Parameter	Type
context	IdetikContext

detach() void overrides

protected detach(_context): void;

Parameter	Type
_context	IdetikContext

update() void overrides

update(viewport?): void;

Parameter	Type
viewport?	Viewport

setOrientation() void

Changes the slice orientation at runtime. Visible renderables are rebuilt for the new plane, chunks already resident in the shared cache are reused.

setOrientation(orientation): void;

Parameter	Type
orientation	SliceOrientation

onEvent() void overrides

onEvent(event): void;

Parameter	Type
event	EventContext

getValueAtWorld() Promise<number | null>

getValueAtWorld(world): Promise<number | null>;

Parameter	Type
world	vec3

setChannelProps() void

setChannelProps(channelProps): void;

Parameter	Type
channelProps	ChannelProps[]

resetChannelProps() void

resetChannelProps(): void;

addChannelChangeCallback() void

addChannelChangeCallback(callback): void;

Parameter	Type
callback	() => void

removeChannelChangeCallback() void

removeChannelChangeCallback(callback): void;

Parameter	Type
callback	() => void