Tutorials more

.eslintrc.json

@@ -15,6 +15,7 @@
   // @typescript-eslint/eslint-plugin
   // - @typescript-eslint
   //
+  //
   // eslint-plugin-import
   // - import
   "plugins": [

common/reviews/api/core.api.md

@@ -26,6 +26,18 @@ function addProvider(provider: (type: string, imageId: string) => {
 // @public (undocumented)
 export function addVolumesToViewports(renderingEngine: IRenderingEngine, volumeInputs: Array<IVolumeInput>, viewportIds: Array<string>, immediateRender?: boolean): Promise<void>;
 
+// @public (undocumented)
+enum BlendModes {
+    // (undocumented)
+    AVERAGE_INTENSITY_BLEND,
+    // (undocumented)
+    COMPOSITE,
+    // (undocumented)
+    MAXIMUM_INTENSITY_BLEND,
+    // (undocumented)
+    MINIMUM_INTENSITY_BLEND
+}
+
 // @public (undocumented)
 export const cache: Cache_2;
 
@@ -51,10 +63,15 @@ function cancelLoadImage(imageId: string): void;
 function cancelLoadImages(imageIds: Array<string>): void;
 
 // @public (undocumented)
-export const CONSTANTS: {
-    ORIENTATION: Record<string, Types.Orientation>;
-    CPU_COLORMAPS: Types.CPUFallbackColormapsData;
-};
+const colormapsData: CPUFallbackColormapsData;
+
+declare namespace CONSTANTS {
+    export {
+        ORIENTATION,
+        colormapsData as CPU_COLORMAPS
+    }
+}
+export { CONSTANTS }
 
 // @public (undocumented)
 interface CPUFallbackColormap {
@@ -230,7 +247,7 @@ type CPUFallbackRenderingTools = {
         putImageData: (renderCanvasData: unknown, dx: number, dy: number) => unknown;
     };
     colormapId?: string;
-    colorLut?: CPUFallbackLookupTable;
+    colorLUT?: CPUFallbackLookupTable;
     renderCanvasData?: {
         data: Uint8ClampedArray;
     };
@@ -371,14 +388,16 @@ type ElementEnabledEventDetail = {
     renderingEngineId: string;
 };
 
-// @public (undocumented)
-export const Enums: {
-    Events: typeof EVENTS;
-    ViewportType: typeof ViewportType;
-    InterpolationType: typeof InterpolationType;
-    RequestType: typeof RequestType;
-    BlendModes: typeof BlendModes;
-};
+declare namespace Enums {
+    export {
+        EVENTS as Events,
+        BlendModes,
+        InterpolationType,
+        RequestType,
+        ViewportType
+    }
+}
+export { Enums }
 
 // @public (undocumented)
 export enum EVENTS {
@@ -941,6 +960,16 @@ function indexWithinDimensions(index: Point3, dimensions: Point3): boolean;
 // @public (undocumented)
 export function init(defaultConfiguration?: {}): Promise<boolean>;
 
+// @public (undocumented)
+enum InterpolationType {
+    // (undocumented)
+    FAST_LINEAR = 2,
+    // (undocumented)
+    LINEAR = 1,
+    // (undocumented)
+    NEAREST = 0
+}
+
 // @public (undocumented)
 function invertRgbTransferFunction(rgbTransferFunction: any): void;
 
@@ -1302,6 +1331,9 @@ const metadataProvider: {
     get: (type: string, imageId: string) => [number, number];
 };
 
+// @public (undocumented)
+const ORIENTATION: Record<string, Orientation>;
+
 // @public (undocumented)
 type Orientation = {
     sliceNormal: Point3;
@@ -1413,6 +1445,16 @@ export class RenderingEngine implements IRenderingEngine {
 // @public (undocumented)
 export function renderToCanvas(imageId: string, canvas: HTMLCanvasElement, renderingEngineId?: any, suppressEvents?: boolean): Promise<string>;
 
+// @public (undocumented)
+enum RequestType {
+    // (undocumented)
+    Interaction = "interaction",
+    // (undocumented)
+    Prefetch = "prefetch",
+    // (undocumented)
+    Thumbnail = "thumbnail"
+}
+
 // @public (undocumented)
 export function resetUseCPURendering(): void;
 
@@ -1792,6 +1834,16 @@ type ViewportInputOptions = {
     suppressEvents?: boolean;
 };
 
+// @public (undocumented)
+enum ViewportType {
+    // (undocumented)
+    ORTHOGRAPHIC = "orthographic",
+    // (undocumented)
+    PERSPECTIVE = "perspective",
+    // (undocumented)
+    STACK = "stack"
+}
+
 // @public (undocumented)
 type VOI = {
     windowWidth: number;

common/reviews/api/streaming-image-volume-loader.api.md

@@ -4,7 +4,6 @@
 
 ```ts
 
-import { default as default_2 } from 'packages/core/dist/esm/enums/RequestType';
 import type { mat4 } from 'gl-matrix';
 import type { vtkImageData } from '@kitware/vtk.js/Common/DataModel/ImageData';
 import type { vtkVolume } from '@kitware/vtk.js/Rendering/Core/Volume';
@@ -16,6 +15,14 @@ type ActorEntry = {
     slabThickness?: number;
 };
 
+// @public
+enum BlendModes {
+    AVERAGE_INTENSITY_BLEND = BlendMode.AVERAGE_INTENSITY_BLEND,
+    COMPOSITE = BlendMode.COMPOSITE,
+    MAXIMUM_INTENSITY_BLEND = BlendMode.MAXIMUM_INTENSITY_BLEND,
+    MINIMUM_INTENSITY_BLEND = BlendMode.MINIMUM_INTENSITY_BLEND,
+}
+
 // @public
 type CameraModifiedEvent = CustomEvent_2<CameraModifiedEventDetail>;
 
@@ -210,7 +217,7 @@ type CPUFallbackRenderingTools = {
         ) => unknown;
     };
     colormapId?: string;
-    colorLut?: CPUFallbackLookupTable;
+    colorLUT?: CPUFallbackLookupTable;
     renderCanvasData?: {
         data: Uint8ClampedArray;
     };
@@ -332,6 +339,33 @@ type ElementEnabledEventDetail = {
     renderingEngineId: string;
 };
 
+// @public
+enum Events {
+    CACHE_SIZE_EXCEEDED = 'CACHE_SIZE_EXCEEDED',
+    CAMERA_MODIFIED = 'CORNERSTONE_CAMERA_MODIFIED',
+
+    ELEMENT_DISABLED = 'CORNERSTONE_ELEMENT_DISABLED',
+    ELEMENT_ENABLED = 'CORNERSTONE_ELEMENT_ENABLED',
+    IMAGE_CACHE_IMAGE_ADDED = 'CORNERSTONE_IMAGE_CACHE_IMAGE_ADDED',
+    IMAGE_CACHE_IMAGE_REMOVED = 'CORNERSTONE_IMAGE_CACHE_IMAGE_REMOVED',
+    IMAGE_LOAD_ERROR = 'IMAGE_LOAD_ERROR',
+    IMAGE_LOAD_FAILED = 'CORNERSTONE_IMAGE_LOAD_FAILED',
+    IMAGE_LOAD_PROGRESS = 'CORNERSTONE_IMAGE_LOAD_PROGRESS',
+    IMAGE_LOADED = 'CORNERSTONE_IMAGE_LOADED',
+    IMAGE_RENDERED = 'CORNERSTONE_IMAGE_RENDERED',
+    IMAGE_SPACING_CALIBRATED = 'CORNERSTONE_IMAGE_SPACING_CALIBRATED',
+    IMAGE_VOLUME_MODIFIED = 'CORNERSTONE_IMAGE_VOLUME_MODIFIED',
+    STACK_NEW_IMAGE = 'CORNERSTONE_STACK_NEW_IMAGE',
+    VOI_MODIFIED = 'CORNERSTONE_VOI_MODIFIED',
+    VOLUME_CACHE_VOLUME_ADDED = 'CORNERSTONE_VOLUME_CACHE_VOLUME_ADDED',
+    VOLUME_CACHE_VOLUME_REMOVED = 'CORNERSTONE_VOLUME_CACHE_VOLUME_REMOVED',
+    VOLUME_LOADED = 'CORNERSTONE_VOLUME_LOADED',
+    VOLUME_LOADED_FAILED = 'CORNERSTONE_VOLUME_LOADED_FAILED',
+    // IMAGE_CACHE_FULL = 'CORNERSTONE_IMAGE_CACHE_FULL',
+    // PRE_RENDER = 'CORNERSTONE_PRE_RENDER',
+    // ELEMENT_RESIZED = 'CORNERSTONE_ELEMENT_RESIZED',
+}
+
 declare namespace EventTypes {
     export {
         CameraModifiedEventDetail,
@@ -655,6 +689,14 @@ type ImageVolumeModifiedEventDetail = {
     FrameOfReferenceUID: string;
 };
 
+// @public
+enum InterpolationType {
+    // (undocumented)
+    FAST_LINEAR,
+    LINEAR,
+    NEAREST,
+}
+
 // @public
 interface IRegisterImageLoader {
     // (undocumented)
@@ -944,6 +986,13 @@ type PublicViewportInput = {
     defaultOptions?: ViewportInputOptions;
 };
 
+// @public
+enum RequestType {
+    Interaction = 'interaction',
+    Prefetch = 'prefetch',
+    Thumbnail = 'thumbnail',
+}
+
 // @public (undocumented)
 type Scaling = {
     PET?: PTScaling;
@@ -1014,7 +1063,7 @@ export class StreamingImageVolume extends ImageVolume {
             };
         };
         priority: number;
-        requestType: default_2;
+        requestType: Enums.RequestType;
         additionalDetails: {
             volumeId: string;
         };
@@ -1040,6 +1089,13 @@ type ViewportInputOptions = {
     suppressEvents?: boolean;
 };
 
+// @public
+enum ViewportType {
+    ORTHOGRAPHIC = 'orthographic',
+    PERSPECTIVE = 'perspective',
+    STACK = 'stack',
+}
+
 // @public (undocumented)
 type VOI = {
     windowWidth: number;

common/reviews/api/tools.api.md

@@ -28,10 +28,10 @@ type ActorEntry = {
 function addAnnotation(element: HTMLDivElement, annotation: Annotation): void;
 
 // @public (undocumented)
-function addColorLUT(colorLut: ColorLut, index: number): void;
+function addColorLUT(colorLUT: ColorLUT, index: number): void;
 
 // @public (undocumented)
-function addColorLUT_2(colorLUT: ColorLut, colorLUTIndex: number): void;
+function addColorLUT_2(colorLUT: ColorLUT, colorLUTIndex: number): void;
 
 // @public (undocumented)
 function addSegmentation(segmentationInput: SegmentationPublicInput, suppressEvents?: boolean): void;
@@ -418,7 +418,7 @@ declare namespace color {
 }
 
 // @public (undocumented)
-type ColorLut = Array<Color>;
+type ColorLUT = Array<Color>;
 
 declare namespace config {
     export {
@@ -631,7 +631,7 @@ type CPUFallbackRenderingTools = {
         ) => unknown;
     };
     colormapId?: string;
-    colorLut?: CPUFallbackLookupTable;
+    colorLUT?: CPUFallbackLookupTable;
     renderCanvasData?: {
         data: Uint8ClampedArray;
     };
@@ -1094,14 +1094,17 @@ export class EllipticalROITool extends AnnotationTool {
     touchDragCallback: any;
 }
 
-// @public (undocumented)
-export const Enums: {
-    MouseBindings: typeof MouseBindings;
-    KeyboardBindings: typeof KeyboardBindings;
-    ToolModes: typeof ToolModes;
-    Events: typeof Events;
-    SegmentationRepresentations: typeof SegmentationRepresentations;
-};
+declare namespace Enums {
+    export {
+        MouseBindings,
+        KeyboardBindings,
+        ToolModes,
+        AnnotationStyleStates,
+        Events,
+        SegmentationRepresentations
+    }
+}
+export { Enums }
 
 // @public (undocumented)
 enum Events {
@@ -1318,7 +1321,7 @@ function getCanvasEllipseCorners(ellipseCanvasPoints: canvasCoordinates): Array<
 function getColorForSegmentIndex(toolGroupId: string, segmentationRepresentationUID: string, segmentIndex: number): Color;
 
 // @public (undocumented)
-function getColorLut(index: number): ColorLut | undefined;
+function getColorLUT(index: number): ColorLUT | undefined;
 
 // @public (undocumented)
 function getDefaultAnnotationManager(): FrameOfReferenceSpecificAnnotationManager;
@@ -2856,6 +2859,12 @@ type RepresentationConfig = {
     LABELMAP?: LabelmapConfig;
 };
 
+// @public (undocumented)
+type RepresentationPublicInput = {
+    segmentationId: string;
+    type: Enums.SegmentationRepresentations;
+};
+
 // @public (undocumented)
 function resetElementCursor(element: HTMLDivElement): void;
 
@@ -2880,7 +2889,7 @@ function scrollThroughStack(evt: MouseWheelEventType | MouseDragEventType, delta
 // @public (undocumented)
 type Segmentation = {
     segmentationId: string;
-    type: Enums_2.SegmentationRepresentations;
+    type: Enums.SegmentationRepresentations;
     label: string;
     activeSegmentIndex: number;
     segmentsLocked: Set<number>;
@@ -2995,7 +3004,7 @@ enum SegmentationRepresentations {
 
 // @public (undocumented)
 type SegmentationState = {
-    colorLut: ColorLut[];
+    colorLUT: ColorLUT[];
     segmentations: Segmentation[];
     globalConfig: SegmentationRepresentationConfig;
     toolGroups: {
@@ -3218,7 +3227,7 @@ declare namespace state_2 {
         getToolGroupsWithSegmentation,
         getSegmentationRepresentationByUID,
         addColorLUT,
-        getColorLut
+        getColorLUT
     }
 }
 
@@ -3338,7 +3347,7 @@ type ToolGroupSpecificRepresentation = ToolGroupSpecificLabelmapRepresentation;
 type ToolGroupSpecificRepresentationState = {
     segmentationRepresentationUID: string;
     segmentationId: string;
-    type: Enums_2.SegmentationRepresentations;
+    type: Enums.SegmentationRepresentations;
     active: boolean;
     segmentsHidden: Set<number>;
     visibility: boolean;
@@ -3455,8 +3464,9 @@ declare namespace Types {
         ToolGroupSpecificRepresentationState,
         ToolGroupSpecificLabelmapRepresentation,
         ToolGroupSpecificRepresentation,
+        RepresentationPublicInput,
         Color,
-        ColorLut,
+        ColorLUT,
         LabelmapTypes,
         SVGCursorDescriptor,
         SVGPoint_2 as SVGPoint