@lunit/insight-viewer
Version:
Based on the cornerstone library, it provides several components for handling Dicom images
39 lines (38 loc) • 1.26 kB
TypeScript
import { ImageId, LoadingState, OnError, RequestInterceptor } from '../../types';
import { WadoImageLoaderOptions } from '../../utils/cornerstoneHelper';
import { Image } from '../../Viewer/types';
interface OnImageLoaded {
(): void;
}
interface UseImagePropsV1 {
timeout?: number;
requestInterceptor?: RequestInterceptor;
loader?: never;
}
interface UseImagePropsV2 {
timeout?: never;
requestInterceptor?: never;
loader?: (url: string) => Promise<ArrayBuffer>;
}
declare type Props = UseImagePropsV1 | UseImagePropsV2;
interface UseImage {
(props: ImageId & {
onError?: OnError;
onImageLoaded?: OnImageLoaded;
loaderOptions?: WadoImageLoaderOptions;
} & Props): {
loadingState: LoadingState;
image: Image;
};
}
/**
* @param rest wadouri | dicomfile | web
* @param requestInterceptor The callback is called before a request is sent.
* It use ky.js beforeRequest hook.
* @param onError The error handler.
* @param loader The loader can setup custom http client.
* @returns <{ image, loadingState }> image is a CornerstoneImage.
* loadingState is 'initial'|'loading'|'success'|'fail'
*/
export declare const useImage: UseImage;
export {};