Skip to main content

Type Alias: NVConfigOptions

type NVConfigOptions = object;

Defined in: nvdocument.ts:106

NVConfigOptions

Properties​

atlasActiveIndex​

atlasActiveIndex: number;

Defined in: nvdocument.ts:138

atlasOutline​

atlasOutline: number;

Defined in: nvdocument.ts:137

backColor​

backColor: number[];

Defined in: nvdocument.ts:119

bounds​

bounds: [
  [number, number],
  [number, number],
] | null;

Defined in: nvdocument.ts:214

boundsBorderColor?​

optional boundsBorderColor: number[];

Defined in: nvdocument.ts:216

centerMosaic​

centerMosaic: boolean;

Defined in: nvdocument.ts:187

clickToSegment​

clickToSegment: boolean;

Defined in: nvdocument.ts:190

clickToSegmentAutoIntensity​

clickToSegmentAutoIntensity: boolean;

Defined in: nvdocument.ts:193

clickToSegmentBright​

clickToSegmentBright: boolean;

Defined in: nvdocument.ts:192

clickToSegmentIntensityMax​

clickToSegmentIntensityMax: number;

Defined in: nvdocument.ts:194

clickToSegmentIntensityMin​

clickToSegmentIntensityMin: number;

Defined in: nvdocument.ts:195

clickToSegmentIs2D​

clickToSegmentIs2D: boolean;

Defined in: nvdocument.ts:198

clickToSegmentMaxDistanceMM​

clickToSegmentMaxDistanceMM: number;

Defined in: nvdocument.ts:197

clickToSegmentPercent​

clickToSegmentPercent: number;

Defined in: nvdocument.ts:196

clickToSegmentRadius​

clickToSegmentRadius: number;

Defined in: nvdocument.ts:191

clipPlaneColor​

clipPlaneColor: number[];

Defined in: nvdocument.ts:123

clipPlaneHotKey​

clipPlaneHotKey: string;

Defined in: nvdocument.ts:130

colorbarHeight​

colorbarHeight: number;

Defined in: nvdocument.ts:111

colorbarMargin​

colorbarMargin: number;

Defined in: nvdocument.ts:128

colorbarWidth​

colorbarWidth: number;

Defined in: nvdocument.ts:112

crosshairColor​

crosshairColor: number[];

Defined in: nvdocument.ts:120

crosshairGap​

crosshairGap: number;

Defined in: nvdocument.ts:116

crosshairWidth​

crosshairWidth: number;

Defined in: nvdocument.ts:114

crosshairWidthUnit​

crosshairWidthUnit: "voxels" | "mm" | "percent";

Defined in: nvdocument.ts:115

cycleClipPlaneHotKey​

cycleClipPlaneHotKey: string;

Defined in: nvdocument.ts:131

doubleTouchTimeout​

doubleTouchTimeout: number;

Defined in: nvdocument.ts:133

dragAndDropEnabled​

dragAndDropEnabled: boolean;

Defined in: nvdocument.ts:167

dragMode​

dragMode: DRAG_MODE;

Defined in: nvdocument.ts:149

dragModePrimary​

dragModePrimary: DRAG_MODE;

Defined in: nvdocument.ts:150

drawingEnabled​

drawingEnabled: boolean;

Defined in: nvdocument.ts:168

floodFillNeighbors​

floodFillNeighbors: number;

Defined in: nvdocument.ts:171

fontColor​

fontColor: Float32List;

Defined in: nvdocument.ts:121

fontMinPx​

fontMinPx: number;

Defined in: nvdocument.ts:110

fontSizeScaling​

fontSizeScaling: number;

Defined in: nvdocument.ts:109

forceDevicePixelRatio​

forceDevicePixelRatio: number;

Defined in: nvdocument.ts:163

gradientAmount​

gradientAmount: number;

Defined in: nvdocument.ts:211

gradientOpacity​

gradientOpacity: number;

Defined in: nvdocument.ts:209

gradientOrder​

gradientOrder: number;

Defined in: nvdocument.ts:208

heroImageFraction​

heroImageFraction: number;

Defined in: nvdocument.ts:158

heroSliceType​

heroSliceType: SLICE_TYPE;

Defined in: nvdocument.ts:159

interactive​

interactive: boolean;

Defined in: nvdocument.ts:188

invertScrollDirection​

invertScrollDirection: boolean;

Defined in: nvdocument.ts:212

is2DSliceShader​

is2DSliceShader: boolean;

Defined in: nvdocument.ts:213

isAdditiveBlend​

isAdditiveBlend: boolean;

Defined in: nvdocument.ts:177

isAlphaClipDark​

isAlphaClipDark: boolean;

Defined in: nvdocument.ts:207

isAntiAlias​

isAntiAlias: boolean | null;

Defined in: nvdocument.ts:176

isClipAllVolumes​

isClipAllVolumes: boolean;

Defined in: nvdocument.ts:125

isClipPlanesCutaway​

isClipPlanesCutaway: boolean;

Defined in: nvdocument.ts:124

isColorbar​

isColorbar: boolean;

Defined in: nvdocument.ts:140

isCornerOrientationText​

isCornerOrientationText: boolean;

Defined in: nvdocument.ts:155

isDepthPickMesh​

isDepthPickMesh: boolean;

Defined in: nvdocument.ts:154

isFilledPen​

isFilledPen: boolean;

Defined in: nvdocument.ts:172

isForceMouseClickToVoxelCenters​

isForceMouseClickToVoxelCenters: boolean;

Defined in: nvdocument.ts:166

isNearestInterpolation​

isNearestInterpolation: boolean;

Defined in: nvdocument.ts:136

isOrientationTextVisible​

isOrientationTextVisible: boolean;

Defined in: nvdocument.ts:156

isOrientCube​

isOrientCube: boolean;

Defined in: nvdocument.ts:141

isRadiologicalConvention​

isRadiologicalConvention: boolean;

Defined in: nvdocument.ts:147

isResizeCanvas​

isResizeCanvas: boolean;

Defined in: nvdocument.ts:178

isRuler​

isRuler: boolean;

Defined in: nvdocument.ts:139

isSliceMM​

isSliceMM: boolean;

Defined in: nvdocument.ts:161

isV1SliceShader​

isV1SliceShader: boolean;

Defined in: nvdocument.ts:162

keyDebounceTime​

keyDebounceTime: number;

Defined in: nvdocument.ts:135

legendBackgroundColor​

legendBackgroundColor: number[];

Defined in: nvdocument.ts:182

legendTextColor​

legendTextColor: number[];

Defined in: nvdocument.ts:183

limitFrames4D​

limitFrames4D: number;

Defined in: nvdocument.ts:180

loadingText​

loadingText: string;

Defined in: nvdocument.ts:165

logLevel​

logLevel: "debug" | "info" | "warn" | "error" | "fatal" | "silent";

Defined in: nvdocument.ts:164

longTouchTimeout​

longTouchTimeout: number;

Defined in: nvdocument.ts:134

maxDrawUndoBitmaps​

maxDrawUndoBitmaps: number;

Defined in: nvdocument.ts:174

measureLineColor​

measureLineColor: number[];

Defined in: nvdocument.ts:205

measureTextColor​

measureTextColor: number[];

Defined in: nvdocument.ts:204

measureTextHeight​

measureTextHeight: number;

Defined in: nvdocument.ts:206

measureTextJustify​

measureTextJustify: "start" | "center" | "end";

Defined in: nvdocument.ts:203

meshThicknessOn2D​

meshThicknessOn2D: number | string;

Defined in: nvdocument.ts:148

meshXRay​

meshXRay: number;

Defined in: nvdocument.ts:179

mouseEventConfig?​

optional mouseEventConfig: MouseEventConfig;

Defined in: nvdocument.ts:151

multiplanarEqualSize​

multiplanarEqualSize: boolean;

Defined in: nvdocument.ts:145

multiplanarForceRender​

multiplanarForceRender: boolean;

Defined in: nvdocument.ts:144

multiplanarLayout​

multiplanarLayout: MULTIPLANAR_TYPE;

Defined in: nvdocument.ts:184

multiplanarPadPixels​

multiplanarPadPixels: number;

Defined in: nvdocument.ts:143

multiplanarShowRender​

multiplanarShowRender: SHOW_RENDER;

Defined in: nvdocument.ts:146

paqdUniforms​

paqdUniforms: number[];

Defined in: nvdocument.ts:126

penSize​

penSize: number;

Defined in: nvdocument.ts:189

penType​

penType: PEN_TYPE;

Defined in: nvdocument.ts:170

penValue​

penValue: number;

Defined in: nvdocument.ts:169

renderOverlayBlend​

renderOverlayBlend: number;

Defined in: nvdocument.ts:185

renderSilhouette​

renderSilhouette: number;

Defined in: nvdocument.ts:210

rulerColor​

rulerColor: number[];

Defined in: nvdocument.ts:127

rulerWidth​

rulerWidth: number;

Defined in: nvdocument.ts:117

sagittalNoseLeft​

sagittalNoseLeft: boolean;

Defined in: nvdocument.ts:160

scrollRequiresFocus​

scrollRequiresFocus: boolean;

Defined in: nvdocument.ts:201

selectionBoxColor​

selectionBoxColor: number[];

Defined in: nvdocument.ts:122

selectionBoxIsOutline​

selectionBoxIsOutline: boolean;

Defined in: nvdocument.ts:200

selectionBoxLineThickness​

selectionBoxLineThickness: number;

Defined in: nvdocument.ts:199

show3Dcrosshair​

show3Dcrosshair: boolean;

Defined in: nvdocument.ts:118

showAllOrientationMarkers​

showAllOrientationMarkers: boolean;

Defined in: nvdocument.ts:157

showBoundsBorder?​

optional showBoundsBorder: boolean;

Defined in: nvdocument.ts:215

showColorbarBorder​

showColorbarBorder: boolean;

Defined in: nvdocument.ts:113

showLegend​

showLegend: boolean;

Defined in: nvdocument.ts:181

showMeasureUnits​

showMeasureUnits: boolean;

Defined in: nvdocument.ts:202

sliceMosaicString​

sliceMosaicString: string;

Defined in: nvdocument.ts:186

sliceType​

sliceType: SLICE_TYPE;

Defined in: nvdocument.ts:175

smoothDrawing​

smoothDrawing: number;

Defined in: nvdocument.ts:224

Smooth drawing surfaces in 3D rendering. 0 = off, > 0 = Box blur radius in voxels (default 0)

textHeight​

textHeight: number;

Defined in: nvdocument.ts:108

thumbnail​

thumbnail: string;

Defined in: nvdocument.ts:173

tileMargin​

tileMargin: number;

Defined in: nvdocument.ts:142

touchEventConfig?​

optional touchEventConfig: TouchEventConfig;

Defined in: nvdocument.ts:152

trustCalMinMax​

trustCalMinMax: boolean;

Defined in: nvdocument.ts:129

viewModeHotKey​

viewModeHotKey: string;

Defined in: nvdocument.ts:132

windowingGainFactor​

windowingGainFactor: number;

Defined in: nvdocument.ts:217

yoke3Dto2DZoom​

yoke3Dto2DZoom: boolean;

Defined in: nvdocument.ts:153

zarrCacheSize​

zarrCacheSize: number;

Defined in: nvdocument.ts:220

Chunk cache size for zarr viewing (default 500)

zarrPrefetchRings​

zarrPrefetchRings: number;

Defined in: nvdocument.ts:222

Number of chunk rings to prefetch around the visible region for zarr viewing (0 disables, default 1)