Interface: LoaderOptions
Properties
beforeProcessing()?
optionalbeforeProcessing: (xhr) =>Promise<ArrayBuffer>
Parameters
• xhr: XMLHttpRequest
Returns
Promise<ArrayBuffer>
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:24
beforeSend()?
optionalbeforeSend: (xhr,imageId,defaultHeaders,params) =>void|Record<string,string> |Promise<void|Record<string,string>>
Parameters
• xhr: XMLHttpRequest
• imageId: string
• defaultHeaders: Record<string, string>
• params: LoaderXhrRequestParams
Returns
void | Record<string, string> | Promise<void | Record<string, string>>
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:17
decodeConfig?
optionaldecodeConfig:LoaderDecodeOptions
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:50
errorInterceptor()?
optionalerrorInterceptor: (error) =>void
Parameters
• error: LoaderXhrRequestError
Returns
void
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:31
imageCreated()?
optionalimageCreated: (imageObject) =>void
Parameters
• imageObject: unknown
Returns
void
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:26
maxWebWorkers?
optionalmaxWebWorkers:number
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:8
onloadend()?
optionalonloadend: (event,params) =>void
Parameters
• event: ProgressEvent<EventTarget>
• params: unknown
Returns
void
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:28
onloadstart()?
optionalonloadstart: (event,params) =>void
Parameters
• event: ProgressEvent<EventTarget>
• params: unknown
Returns
void
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:27
onprogress()?
optionalonprogress: (event,params) =>void
Parameters
• event: ProgressEvent<EventTarget>
• params: unknown
Returns
void
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:30
onreadystatechange()?
optionalonreadystatechange: (event,params) =>void
Parameters
• event: Event
• params: unknown
Returns
void
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:29
open()?
optionalopen: (xhr,url,defaultHeaders,params) =>void
Parameters
• xhr: XMLHttpRequest
• url: string
• defaultHeaders: Record<string, string>
• params: LoaderXhrRequestParams
Returns
void
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:10
strict?
optionalstrict:boolean
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:32
useLegacyMetadataProvider?
optionaluseLegacyMetadataProvider:boolean
When true, registers the legacy wadouri/wadors metadata providers. Default is false (use the new metadata design). Set to true only for backward compatibility. New design: use addDicomPart10Instance and addDicomWebInstance from @cornerstonejs/metadata to populate the NATURAL cache instead.
See
https://www.cornerstonejs.org/docs/concepts/cornerstone-core/metadataProvider
Defined in
packages/dicomImageLoader/src/types/LoaderOptions.ts:59
wasmBasePath?
optionalwasmBasePath:string
Base path all codec WASM binaries are loaded from, e.g. /assets/cs-wasm/,
./cs-wasm/ or https://cdn.example.com/cs-wasm/. The directory must
contain the codec binaries under their published file names:
charlswasm_decode.wasm, libjpegturbowasm_decode.wasm,
openjpegwasm_decode.wasm and openjphjs.wasm.
This is a single root for every codec - there is no per-codec path. A relative path resolves against the decode worker's location.
When unset, each decoder resolves its binary relative to its own module
with a bare @cornerstonejs/codec-... specifier. Bundlers do not rewrite
bare specifiers inside new URL(...), so bundled applications should set
this option and serve the binaries themselves (copying them at build time
out of the dist directory of each @cornerstonejs/codec-... package).