Skip to main content

Interface: LoaderOptions

Properties​

beforeProcessing()?​

optional beforeProcessing: (xhr) => Promise<ArrayBuffer>

Parameters​

• xhr: XMLHttpRequest

Returns​

Promise<ArrayBuffer>

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:24

beforeSend()?​

optional beforeSend: (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?​

optional decodeConfig: LoaderDecodeOptions

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:33

errorInterceptor()?​

optional errorInterceptor: (error) => void

Parameters​

• error: LoaderXhrRequestError

Returns​

void

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:31

imageCreated()?​

optional imageCreated: (imageObject) => void

Parameters​

• imageObject: unknown

Returns​

void

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:26

maxWebWorkers?​

optional maxWebWorkers: number

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:8

onloadend()?​

optional onloadend: (event, params) => void

Parameters​

• event: ProgressEvent<EventTarget>

• params: unknown

Returns​

void

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:28

onloadstart()?​

optional onloadstart: (event, params) => void

Parameters​

• event: ProgressEvent<EventTarget>

• params: unknown

Returns​

void

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:27

onprogress()?​

optional onprogress: (event, params) => void

Parameters​

• event: ProgressEvent<EventTarget>

• params: unknown

Returns​

void

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:30

onreadystatechange()?​

optional onreadystatechange: (event, params) => void

Parameters​

• event: Event

• params: unknown

Returns​

void

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:29

open()?​

optional open: (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?​

optional strict: boolean

Defined in​

packages/dicomImageLoader/src/types/LoaderOptions.ts:32

useLegacyMetadataProvider?​

optional useLegacyMetadataProvider: 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:42