Interface: NiivueEventMap

Defined in: events.ts:19

Type-safe event map for all Niivue events. Maps event names to their detail types.

Example

// Type-safe event listening
niivue.addEventListener("locationChange", (event) => {
  // event.detail is typed based on the event name
  console.log("Location changed:", event.detail);
});

Properties

Property	Type	Description	Defined in
angleCompleted	CompletedAngle	Fired when an angle measurement is completed	events.ts:34
azimuthElevationChange	object	Fired when azimuth or elevation angles change in 3D view	events.ts:66
azimuthElevationChange.azimuth	number	-	events.ts:66
azimuthElevationChange.elevation	number	-	events.ts:66
clickToSegment	object	Fired when a click-to-segment operation completes	events.ts:30
clickToSegment.mL	number	-	events.ts:30
clickToSegment.mm3	number	-	events.ts:30
clipPlaneChange	object	Fired when clip plane changes	events.ts:68
clipPlaneChange.clipPlane	number[]	-	events.ts:68
customMeshShaderAdded	object	Fired when a custom mesh shader is added	events.ts:76
customMeshShaderAdded.fragmentShaderText	string	-	events.ts:76
customMeshShaderAdded.name	string	-	events.ts:76
debug	object	Fired on debug messages	events.ts:117
debug.message?	string	-	events.ts:117
dicomLoaderFinished	object	Fired when DICOM loader finishes processing images	events.ts:58
dicomLoaderFinished.files	( | NVMesh | NVImage)[]	-	events.ts:58
documentLoaded	NVDocument	Fired when a document is loaded	events.ts:56
dragRelease	DragReleaseParams	Fired when a drag operation is released	events.ts:22
drawingChanged	object	Fired when the drawing bitmap materially changes (commit, undo, load, close)	events.ts:96
drawingChanged.action	"draw" | "undo" | "load" | "close"	-	events.ts:96
drawingEnabled	object	Fired when drawing mode is toggled on or off	events.ts:98
drawingEnabled.enabled	boolean	-	events.ts:98
drawingToolChanged	object	Fired when the active drawing tool changes (high-level interpretation of pen value and drawing state)	events.ts:90
drawingToolChanged.isFilledPen	boolean	-	events.ts:93
drawingToolChanged.penValue	number	-	events.ts:92
drawingToolChanged.tool	| "clickToSegment" | "off" | "draw" | "erase" | "eraseCluster" | "growCluster" | "growClusterBright" | "growClusterDark"	-	events.ts:91
error	object	Fired on error messages	events.ts:111
error.message?	string	-	events.ts:111
frameChange	object	Fired when the frame changes in a 4D volume	events.ts:62
frameChange.index	number	-	events.ts:62
frameChange.volume	NVImage	-	events.ts:62
imageLoaded	NVImage	Fired when an image/volume is loaded	events.ts:38
info	object	Fired on info messages	events.ts:113
info.message?	string	-	events.ts:113
intensityChange	NVImage	Fired when intensity values change at the crosshair location	events.ts:28
locationChange	unknown	Fired when the crosshair location changes	events.ts:26
measurementCompleted	CompletedMeasurement	Fired when a distance measurement is completed	events.ts:32
meshAddedFromUrl	object	Fired when a mesh is added from a URL	events.ts:50
meshAddedFromUrl.mesh	NVMesh	-	events.ts:50
meshAddedFromUrl.meshOptions	LoadFromUrlParams	-	events.ts:50
meshLoaded	NVMesh	Fired when a mesh is loaded	events.ts:40
meshPropertyChanged	object	Fired when a mesh property is changed	events.ts:80
meshPropertyChanged.key	string	-	events.ts:80
meshPropertyChanged.meshIndex	number	-	events.ts:80
meshPropertyChanged.value	unknown	-	events.ts:80
meshRemoved	object	Fired when any mesh is removed from the scene	events.ts:54
meshRemoved.mesh	NVMesh	-	events.ts:54
meshShaderChanged	object	Fired when a mesh's shader is changed	events.ts:78
meshShaderChanged.meshIndex	number	-	events.ts:78
meshShaderChanged.shaderIndex	number	-	events.ts:78
meshWithUrlRemoved	object	Fired when a mesh loaded from a URL is removed	events.ts:52
meshWithUrlRemoved.url	string	-	events.ts:52
mouseUp	Partial<UIData>	Fired when mouse button is released	events.ts:24
optsChange	object	Fired when visualization options change	events.ts:102
optsChange.newValue	| string | number | boolean | number[] | Float32Array | number[] | MouseEventConfig | TouchEventConfig | [[number, number], [number, number]]	-	events.ts:104
optsChange.oldValue	| string | number | boolean | number[] | Float32Array | number[] | MouseEventConfig | TouchEventConfig | [[number, number], [number, number]]	-	events.ts:105
optsChange.propertyName	keyof NVConfigOptions	-	events.ts:103
penValueChanged	object	Fired when the drawing pen value changes	events.ts:88
penValueChanged.isFilledPen	boolean	-	events.ts:88
penValueChanged.penValue	number	-	events.ts:88
sliceTypeChange	object	Fired when the slice type (view layout) changes	events.ts:70
sliceTypeChange.sliceType	SLICE_TYPE	-	events.ts:70
volumeAddedFromUrl	object	Fired when a volume is added from a URL	events.ts:42
volumeAddedFromUrl.imageOptions	ImageFromUrlOptions	-	events.ts:42
volumeAddedFromUrl.volume	NVImage	-	events.ts:42
volumeOrderChanged	object	Fired when volume stacking order changes	events.ts:84
volumeOrderChanged.volumes	NVImage[]	-	events.ts:84
volumeRemoved	object	Fired when any volume is removed from the scene	events.ts:46
volumeRemoved.index	number	-	events.ts:46
volumeRemoved.volume	NVImage	-	events.ts:46
volumeUpdated	undefined	Fired when a volume is updated	events.ts:48
volumeWithUrlRemoved	object	Fired when a volume loaded from a URL is removed	events.ts:44
volumeWithUrlRemoved.url	string	-	events.ts:44
warn	object	Fired on warning messages	events.ts:115
warn.message?	string	-	events.ts:115
zoom3DChange	object	Fired when 3D zoom level changes	events.ts:72
zoom3DChange.zoom	number	-	events.ts:72