@cornerstonejs/core 0.1.2 → 0.1.3

package/dist/core.d.ts

@@ -13,14 +13,14 @@ declare type ActorEntry = {
 
 declare type AdditionalDetails = {
     imageId?: string;
-    volumeUID?: string;
+    volumeId?: string;
 };
 
 declare function addProvider(provider: (type: string, imageId: string) => {
     any: any;
 }, priority?: number): void;
 
-export declare function addVolumesToViewports(renderingEngine: IRenderingEngine, volumeInputs: Array<IVolumeInput>, viewportUIDs: Array<string>, immediateRender?: boolean): Promise<void>;
+export declare function addVolumesToViewports(renderingEngine: IRenderingEngine, volumeInputs: Array<IVolumeInput>, viewportIds: Array<string>, immediateRender?: boolean): Promise<void>;
 
 declare enum BlendModes {
     COMPOSITE,
@@ -69,8 +69,8 @@ declare type CameraModifiedEventDetail = {
     previousCamera: ICamera;
     camera: ICamera;
     element: HTMLElement;
-    viewportUID: string;
-    renderingEngineUID: string;
+    viewportId: string;
+    renderingEngineId: string;
 };
 
 declare function cancelLoadAll(): void;
@@ -302,13 +302,13 @@ declare type CPUImageData = {
     getDimensions?: () => Point3;
 };
 
-declare function createAndCacheDerivedVolume(referencedVolumeUID: string, options: DerivedVolumeOptions): ImageVolume;
+declare function createAndCacheDerivedVolume(referenceVolumeId: string, options: DerivedVolumeOptions): ImageVolume;
 
 declare function createAndCacheVolume(volumeId: string, options: VolumeLoaderOptions): Promise<Record<string, any>>;
 
 declare function createFloat32SharedArray(length: number): Float32Array;
 
-declare function createLocalVolume(options: LocalVolumeOptions, uid: string, preventCache?: boolean): ImageVolume;
+declare function createLocalVolume(options: LocalVolumeOptions, volumeId: string, preventCache?: boolean): ImageVolume;
 
 declare function createNormalizedMouseEvent(imageData: vtkImageData, index: any, element: any, viewport: any): {
     pageX: any;
@@ -323,10 +323,10 @@ declare function createUint8SharedArray(length: number): Uint8Array;
 export declare function createVolumeActor(props: createVolumeActorInterface): Promise<VolumeActor>;
 
 declare interface createVolumeActorInterface {
-    volumeUID: string;
-    callback?: ({ volumeActor: any, volumeUID: string }: {
+    volumeId: string;
+    callback?: ({ volumeActor: any, volumeId: string }: {
         volumeActor: any;
-        volumeUID: any;
+        volumeId: any;
     }) => void;
     blendMode?: string;
 }
@@ -339,7 +339,7 @@ declare interface CustomEvent_2<T = any> extends Event {
 }
 
 declare interface DerivedVolumeOptions {
-    uid: string;
+    volumeId: string;
     targetBuffer?: {
         type: 'Float32Array' | 'Uint8Array';
     };
@@ -349,16 +349,16 @@ declare type ElementDisabledEvent = CustomEvent_2<ElementDisabledEventDetail>;
 
 declare type ElementDisabledEventDetail = {
     element: HTMLElement;
-    viewportUID: string;
-    renderingEngineUID: string;
+    viewportId: string;
+    renderingEngineId: string;
 };
 
 declare type ElementEnabledEvent = CustomEvent_2<ElementEnabledEventDetail>;
 
 declare type ElementEnabledEventDetail = {
     element: HTMLElement;
-    viewportUID: string;
-    renderingEngineUID: string;
+    viewportId: string;
+    renderingEngineId: string;
 };
 
 export declare const Enums: {
@@ -519,7 +519,7 @@ declare function getClosestImageId(imageVolume: IImageVolume, worldPos: Point3,
 
 export declare function getEnabledElement(element: HTMLElement | undefined): IEnabledElement | undefined;
 
-export declare function getEnabledElementByUIDs(viewportUID: string, renderingEngineUID: string): IEnabledElement;
+export declare function getEnabledElementByIds(viewportId: string, renderingEngineId: string): IEnabledElement;
 
 declare function getMetaData(type: string, imageId: string): any;
 
@@ -530,7 +530,7 @@ declare function getMinMax(storedPixelData: number[]): {
 
 export declare function getOrCreateCanvas(element: HTMLElement): HTMLCanvasElement;
 
-export declare function getRenderingEngine(uid: string): IRenderingEngine | undefined;
+export declare function getRenderingEngine(id: string): IRenderingEngine | undefined;
 
 export declare function getRenderingEngines(): IRenderingEngine[] | undefined;
 
@@ -540,16 +540,16 @@ export declare function getShouldUseCPURendering(): boolean;
 
 declare function getSpacingInNormalDirection(imageVolume: IImageVolume, viewPlaneNormal: Point3): number;
 
-declare function getTargetVolumeAndSpacingInNormalDir(viewport: IVolumeViewport, camera: ICamera, targetVolumeUID?: string): {
+declare function getTargetVolumeAndSpacingInNormalDir(viewport: IVolumeViewport, camera: ICamera, targetVolumeId?: string): {
     imageVolume: IImageVolume;
     spacingInNormalDirection: number;
 };
 
 declare function getVolumeActorCorners(volumeActor: any): Array<Point3>;
 
-declare function getVolumeViewportsContainingSameVolumes(targetViewport: IVolumeViewport, renderingEngineUID?: string): Array<IVolumeViewport>;
+declare function getVolumeViewportsContainingSameVolumes(targetViewport: IVolumeViewport, renderingEngineId?: string): Array<IVolumeViewport>;
 
-declare function getVolumeViewportsContainingVolumeUID(uid: string, renderingEngineUID?: string): Array<IVolumeViewport>;
+declare function getVolumeViewportsContainingVolumeId(volumeId: string, renderingEngineId?: string): Array<IVolumeViewport>;
 
 declare interface ICache {
     setMaxCacheSize: (maxCacheSize: number) => void;
@@ -622,8 +622,8 @@ declare interface ICameraInitialValues {
 declare interface IEnabledElement {
     viewport: IStackViewport | IVolumeViewport;
     renderingEngine: IRenderingEngine;
-    viewportUID: string;
-    renderingEngineUID: string;
+    viewportId: string;
+    renderingEngineId: string;
     FrameOfReferenceUID: string;
 }
 
@@ -700,7 +700,7 @@ declare interface IImageLoadObject {
 }
 
 declare interface IImageVolume {
-    readonly uid: string;
+    readonly volumeId: string;
     dimensions: Point3;
     direction: Float32Array;
     metadata: Metadata;
@@ -721,7 +721,7 @@ declare interface IImageVolume {
     vtkOpenGLTexture: any;
     loadStatus?: Record<string, any>;
     imageIds?: Array<string>;
-    referenceVolumeUID?: string;
+    referenceVolumeId?: string;
     convertToCornerstoneImage?: (imageId: string, imageIdIndex: number) => IImageLoadObject;
 }
 
@@ -798,8 +798,8 @@ declare type ImageRenderedEvent = CustomEvent_2<ElementEnabledEventDetail>;
 
 declare type ImageRenderedEventDetail = {
     element: HTMLElement;
-    viewportUID: string;
-    renderingEngineUID: string;
+    viewportId: string;
+    renderingEngineId: string;
     suppressEvents?: boolean;
 };
 
@@ -809,8 +809,8 @@ declare type ImageSpacingCalibratedEvent = CustomEvent_2<ImageSpacingCalibratedE
 
 declare type ImageSpacingCalibratedEventDetail = {
     element: HTMLElement;
-    viewportUID: string;
-    renderingEngineUID: string;
+    viewportId: string;
+    renderingEngineId: string;
     imageId: string;
     rowScale: number;
     columnScale: number;
@@ -819,7 +819,7 @@ declare type ImageSpacingCalibratedEventDetail = {
 };
 
 export declare class ImageVolume implements IImageVolume {
-    readonly uid: string;
+    readonly volumeId: string;
     dimensions: Point3;
     direction: Float32Array;
     metadata: Metadata;
@@ -840,7 +840,7 @@ export declare class ImageVolume implements IImageVolume {
     vtkOpenGLTexture: any;
     loadStatus?: Record<string, any>;
     imageIds?: Array<string>;
-    referenceVolumeUID?: string;
+    referenceVolumeId?: string;
     constructor(props: IVolume);
 }
 
@@ -868,21 +868,21 @@ declare interface IRegisterImageLoader {
 }
 
 declare interface IRenderingEngine {
-    uid: string;
+    id: string;
     hasBeenDestroyed: boolean;
     offscreenMultiRenderWindow: any;
     offScreenCanvasContainer: any;
     setViewports(viewports: Array<PublicViewportInput>): void;
     resize(): void;
-    getViewport(uid: string): IStackViewport | IVolumeViewport;
+    getViewport(id: string): IStackViewport | IVolumeViewport;
     getViewports(): Array<IStackViewport | IVolumeViewport>;
     render(): void;
-    renderViewports(viewportUIDs: Array<string>): void;
-    renderViewport(viewportUID: string): void;
+    renderViewports(viewportIds: Array<string>): void;
+    renderViewport(viewportId: string): void;
     renderFrameOfReference(FrameOfReferenceUID: string): void;
     fillCanvasWithBackgroundColor(canvas: HTMLCanvasElement, backgroundColor: [number, number, number]): void;
     enableElement(viewportInputEntry: PublicViewportInput): void;
-    disableElement(viewportUID: string): void;
+    disableElement(viewportId: string): void;
     getStackViewports(): Array<IStackViewport>;
     getVolumeViewports(): Array<IVolumeViewport>;
     destroy(): void;
@@ -910,8 +910,8 @@ declare interface IStackViewport extends IViewport {
     customRenderViewportToCanvas: () => {
         canvas: HTMLCanvasElement;
         element: HTMLElement;
-        viewportUID: string;
-        renderingEngineUID: string;
+        viewportId: string;
+        renderingEngineId: string;
     };
     getImageData(): IImageData | CPUIImageData;
     resetProperties(): void;
@@ -943,8 +943,8 @@ declare interface IStreamingVolumeProperties {
 }
 
 declare interface IViewport {
-    uid: string;
-    renderingEngineUID: string;
+    id: string;
+    renderingEngineId: string;
     type: ViewportType;
     canvas: HTMLCanvasElement;
     element: HTMLElement;
@@ -977,13 +977,13 @@ declare interface IViewport {
     _getCorners(bounds: Array<number>): Array<number>[];
 }
 
-declare interface IViewportUID {
-    renderingEngineUID: string;
-    viewportUID: string;
+declare interface IViewportId {
+    renderingEngineId: string;
+    viewportId: string;
 }
 
 declare interface IVolume {
-    uid: string;
+    volumeId: string;
     metadata: Metadata;
     dimensions: Point3;
     spacing: Point3;
@@ -992,7 +992,7 @@ declare interface IVolume {
     scalarData: Float32Array | Uint8Array;
     sizeInBytes?: number;
     imageData?: vtkImageData;
-    referenceVolumeUID?: string;
+    referenceVolumeId?: string;
     scaling?: {
         PET?: {
             SUVlbmFactor?: number;
@@ -1004,7 +1004,7 @@ declare interface IVolume {
 }
 
 declare interface IVolumeInput {
-    volumeUID: string;
+    volumeId: string;
     actorUID?: string;
     visibility?: boolean;
     callback?: VolumeInputCallback;
@@ -1123,7 +1123,7 @@ declare type PTScaling = {
 
 declare type PublicViewportInput = {
     element: HTMLElement;
-    viewportUID: string;
+    viewportId: string;
     type: ViewportType;
     defaultOptions: ViewportInputOptions;
 };
@@ -1143,7 +1143,7 @@ declare function removeProvider(provider: (type: string, imageId: string) => {
 }): void;
 
 export declare class RenderingEngine implements IRenderingEngine {
-    readonly uid: string;
+    readonly id: string;
     hasBeenDestroyed: boolean;
     offscreenMultiRenderWindow: any;
     readonly offScreenCanvasContainer: any;
@@ -1152,19 +1152,19 @@ export declare class RenderingEngine implements IRenderingEngine {
     private _animationFrameSet;
     private _animationFrameHandle;
     private useCPURendering;
-    constructor(uid?: string);
+    constructor(id?: string);
     enableElement(viewportInputEntry: PublicViewportInput): void;
-    disableElement(viewportUID: string): void;
+    disableElement(viewportId: string): void;
     setViewports(viewportInputEntries: Array<PublicViewportInput>): void;
     resize(immediate?: boolean, resetPanZoomForViewPlane?: boolean): void;
-    getViewport(uid: string): IStackViewport | IVolumeViewport;
+    getViewport(viewportId: string): IStackViewport | IVolumeViewport;
     getViewports(): Array<IStackViewport | IVolumeViewport>;
     getStackViewports(): Array<IStackViewport>;
     getVolumeViewports(): Array<IVolumeViewport>;
     render(): void;
     renderFrameOfReference: (FrameOfReferenceUID: string) => void;
-    renderViewports(viewportUIDs: Array<string>): void;
-    renderViewport(viewportUID: string): void;
+    renderViewports(viewportIds: Array<string>): void;
+    renderViewport(viewportId: string): void;
     destroy(): void;
     fillCanvasWithBackgroundColor(canvas: HTMLCanvasElement, backgroundColor: [number, number, number]): void;
     private _resizeUsingCustomResizeHandler;
@@ -1193,7 +1193,7 @@ export declare class RenderingEngine implements IRenderingEngine {
     _debugRender(): void;
 }
 
-export declare function renderToCanvas(imageId: string, canvas: HTMLCanvasElement, renderingEngineUID?: any, suppressEvents?: boolean): Promise<string>;
+export declare function renderToCanvas(imageId: string, canvas: HTMLCanvasElement, renderingEngineId?: any, suppressEvents?: boolean): Promise<string>;
 
 declare type RequestDetailsInterface = {
     requestFn: () => Promise<void>;
@@ -1274,15 +1274,15 @@ export declare class Settings {
 
 export declare function setUseCPURendering(status: boolean): void;
 
-export declare function setVolumesForViewports(renderingEngine: IRenderingEngine, volumeInputs: Array<IVolumeInput>, viewportUIDs: Array<string>, immediateRender?: boolean): Promise<void>;
+export declare function setVolumesForViewports(renderingEngine: IRenderingEngine, volumeInputs: Array<IVolumeInput>, viewportIds: Array<string>, immediateRender?: boolean): Promise<void>;
 
 declare type StackNewImageEvent = CustomEvent_2<StackNewImageEventDetail>;
 
 declare type StackNewImageEventDetail = {
     image: IImage;
     imageId: string;
-    viewportUID: string;
-    renderingEngineUID: string;
+    viewportId: string;
+    renderingEngineId: string;
 };
 
 export declare class StackViewport extends Viewport implements IStackViewport {
@@ -1384,8 +1384,8 @@ export declare class StackViewport extends Viewport implements IStackViewport {
     customRenderViewportToCanvas: () => {
         canvas: HTMLCanvasElement;
         element: HTMLElement;
-        viewportUID: string;
-        renderingEngineUID: string;
+        viewportId: string;
+        renderingEngineId: string;
     };
     setColormap(colormap: CPUFallbackColormapData): void;
     unsetColormap(): void;
@@ -1439,7 +1439,7 @@ declare namespace Types {
         IEnabledElement,
         ICache,
         IVolume,
-        IViewportUID,
+        IViewportId,
         IImageVolume,
         IRenderingEngine,
         ScalingParameters,
@@ -1517,7 +1517,7 @@ declare namespace utilities {
         getVolumeActorCorners,
         indexWithinDimensions,
         getVolumeViewportsContainingSameVolumes,
-        getVolumeViewportsContainingVolumeUID
+        getVolumeViewportsContainingVolumeId
     }
 }
 export { utilities }
@@ -1525,10 +1525,10 @@ export { utilities }
 declare function uuidv4(): string;
 
 export declare class Viewport implements IViewport {
-    readonly uid: string;
+    readonly id: string;
     readonly element: HTMLElement;
     readonly canvas: HTMLCanvasElement;
-    readonly renderingEngineUID: string;
+    readonly renderingEngineId: string;
     readonly type: ViewportType;
     protected flipHorizontal: boolean;
     protected flipVertical: boolean;
@@ -1582,10 +1582,10 @@ export declare class Viewport implements IViewport {
 }
 
 declare type ViewportInput = {
-    uid: string;
+    id: string;
     element: HTMLElement;
     canvas: HTMLCanvasElement;
-    renderingEngineUID: string;
+    renderingEngineId: string;
     type: ViewportType;
     sx: number;
     sy: number;
@@ -1614,8 +1614,8 @@ declare type VOI = {
 declare type VoiModifiedEvent = CustomEvent_2<VoiModifiedEventDetail>;
 
 declare type VoiModifiedEventDetail = {
-    viewportUID: string;
-    volumeUID: string;
+    viewportId: string;
+    volumeId: string;
     range: VOIRange;
 };
 
@@ -1640,7 +1640,7 @@ declare type VolumeCacheVolumeRemovedEventDetail = {
 
 declare type VolumeInputCallback = (params: {
     volumeActor: VolumeActor;
-    volumeUID: string;
+    volumeId: string;
 }) => unknown;
 
 declare type VolumeLoadedEvent = CustomEvent_2<VolumeLoadedEventDetail>;

package/dist/esm/RenderingEngine/RenderingEngine.d.ts

@@ -2,28 +2,28 @@ import type IStackViewport from '../types/IStackViewport';
 import type IVolumeViewport from '../types/IVolumeViewport';
 import type { PublicViewportInput } from '../types/IViewport';
 export interface IRenderingEngine {
-    uid: string;
+    id: string;
     hasBeenDestroyed: boolean;
     offscreenMultiRenderWindow: any;
     offScreenCanvasContainer: any;
     setViewports(viewports: Array<PublicViewportInput>): void;
     resize(): void;
-    getViewport(uid: string): IStackViewport | IVolumeViewport;
+    getViewport(id: string): IStackViewport | IVolumeViewport;
     getViewports(): Array<IStackViewport | IVolumeViewport>;
     render(): void;
-    renderViewports(viewportUIDs: Array<string>): void;
-    renderViewport(viewportUID: string): void;
+    renderViewports(viewportIds: Array<string>): void;
+    renderViewport(viewportId: string): void;
     renderFrameOfReference(FrameOfReferenceUID: string): void;
     fillCanvasWithBackgroundColor(canvas: HTMLCanvasElement, backgroundColor: [number, number, number]): void;
     enableElement(viewportInputEntry: PublicViewportInput): void;
-    disableElement(viewportUID: string): void;
+    disableElement(viewportId: string): void;
     getStackViewports(): Array<IStackViewport>;
     getVolumeViewports(): Array<IVolumeViewport>;
     destroy(): void;
     _debugRender(): void;
 }
 declare class RenderingEngine implements IRenderingEngine {
-    readonly uid: string;
+    readonly id: string;
     hasBeenDestroyed: boolean;
     offscreenMultiRenderWindow: any;
     readonly offScreenCanvasContainer: any;
@@ -32,19 +32,19 @@ declare class RenderingEngine implements IRenderingEngine {
     private _animationFrameSet;
     private _animationFrameHandle;
     private useCPURendering;
-    constructor(uid?: string);
+    constructor(id?: string);
     enableElement(viewportInputEntry: PublicViewportInput): void;
-    disableElement(viewportUID: string): void;
+    disableElement(viewportId: string): void;
     setViewports(viewportInputEntries: Array<PublicViewportInput>): void;
     resize(immediate?: boolean, resetPanZoomForViewPlane?: boolean): void;
-    getViewport(uid: string): IStackViewport | IVolumeViewport;
+    getViewport(viewportId: string): IStackViewport | IVolumeViewport;
     getViewports(): Array<IStackViewport | IVolumeViewport>;
     getStackViewports(): Array<IStackViewport>;
     getVolumeViewports(): Array<IVolumeViewport>;
     render(): void;
     renderFrameOfReference: (FrameOfReferenceUID: string) => void;
-    renderViewports(viewportUIDs: Array<string>): void;
-    renderViewport(viewportUID: string): void;
+    renderViewports(viewportIds: Array<string>): void;
+    renderViewport(viewportId: string): void;
     destroy(): void;
     fillCanvasWithBackgroundColor(canvas: HTMLCanvasElement, backgroundColor: [number, number, number]): void;
     private _resizeUsingCustomResizeHandler;