Release v0.34.0

changelog.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [v0.34.0](https://github.com/ivmartel/dwv/releases/tag/v0.34.0) - 14/11/2024
+
+### Added
+
+- Add connector between shape and label [#1795](https://github.com/ivmartel/dwv/issues/1795)
+- Default draw auto shape color to false [#1768](https://github.com/ivmartel/dwv/issues/1768)
+- Export toolOptions to allow for custom tool options [#1718](https://github.com/ivmartel/dwv/issues/1718)
+- Allow to move roi label independently [#1690](https://github.com/ivmartel/dwv/issues/1690)
+- Add DICOM SR parsing [#1689](https://github.com/ivmartel/dwv/issues/1689)
+- Add missing position to draw display details [#1521](https://github.com/ivmartel/dwv/issues/1521)
+- Use DICOM to store annotations [#1020](https://github.com/ivmartel/dwv/issues/1020)
+
+### Fixed
+
+- Fixed label moves on drag out of bounds [#1770](https://github.com/ivmartel/dwv/issues/1770)
+- Wrong display if adding data after zoom [#1606](https://github.com/ivmartel/dwv/issues/1606)
+
+---
+
 ## [v0.33.1](https://github.com/ivmartel/dwv/releases/tag/v0.33.1) - 13/06/2024
 
 ### Fixed

dist/dwv.d.ts

@@ -337,6 +337,14 @@ export declare class App {
      * @returns {DicomData|undefined} The data.
      */
     getData(dataId: string): DicomData | undefined;
+    /**
+     * Get the image.
+     *
+     * @param {string} dataId The data id.
+     * @returns {Image|undefined} The associated image.
+     * @deprecated Since v0.34, please use the getData method.
+     */
+    getImage(dataId: string): Image_2 | undefined;
     /**
      * Set the image at the given id.
      *
@@ -377,15 +385,17 @@ export declare class App {
      * Can the data (of the active view of the active layer) be scrolled?
      *
      * @returns {boolean} True if the data has a third dimension greater than one.
-     * @deprecated Please use the ViewController equivalent directly instead.
+     * @deprecated Since v0.33, please use the ViewController
+     *   equivalent directly instead.
      */
     canScroll(): boolean;
     /**
      * Can window and level be applied to the data
      * (of the active view of the active layer)?
      *
      * @returns {boolean} True if the data is monochrome.
-     * @deprecated Please use the ViewController equivalent directly instead.
+     * @deprecated Since v0.33, please use the ViewController
+     *   equivalent directly instead.
      */
     canWindowLevel(): boolean;
     /**
@@ -626,7 +636,8 @@ export declare class App {
      * Init the Window/Level display
      * (of the active layer of the active layer group).
      *
-     * @deprecated Please set the opacity of the desired view layer directly.
+     * @deprecated Since v0.33, please set the opacity
+     *   of the desired view layer directly.
      */
     initWLDisplay(): void;
     /**
@@ -728,13 +739,14 @@ export declare class App {
      * Set the active view layer (of the active layer group) opacity.
      *
      * @param {number} alpha The opacity ([0:1] range).
-     * @deprecated Please set the opacity of the desired view layer directly.
+     * @deprecated Since v0.33, pplease set the opacity
+     *   of the desired view layer directly.
      */
     setOpacity(alpha: number): void;
     /**
      * Set the drawings of the active layer group.
      *
-     * @deprecated Please switch to DICOM SR annotations.
+     * @deprecated Since v0.34, please switch to DICOM SR annotations.
      * @param {Array} drawings An array of drawings.
      * @param {Array} drawingsDetails An array of drawings details.
      * @param {string} dataId The converted data id.
@@ -743,7 +755,8 @@ export declare class App {
     /**
      * Apply a JSON state to this app.
      *
-     * @deprecated
+     * @deprecated Since v0.34, please switch to DICOM SR
+     *   for annotations.
      * @param {string} jsonState The state of the app as a JSON string.
      * @param {string} dataId The state data id.
      */
@@ -793,14 +806,16 @@ export declare class App {
      * Set the colour map of the active view of the active layer group.
      *
      * @param {string} name The colour map name.
-     * @deprecated Please use the ViewController equivalent directly instead.
+     * @deprecated Since v0.33, please use the ViewController
+     *   equivalent directly instead.
      */
     setColourMap(name: string): void;
     /**
      * Set the window/level preset of the active view of the active layer group.
      *
      * @param {string} preset The window/level preset.
-     * @deprecated Please use the ViewController equivalent directly instead.
+     * @deprecated Since v0.33, please use the ViewController
+     *   equivalent directly instead.
      */
     setWindowLevelPreset(preset: string): void;
     /**
@@ -1872,7 +1887,7 @@ export declare class DrawLayer {
     /**
      * Delete a Draw from the stage.
      *
-     * @deprecated
+     * @deprecated Since v0.34, please switch to `annotationGroup.remove`.
      * @param {string} _id The id of the group to delete.
      * @param {Function} _exeCallback The callback to call once the
      *  DeleteCommand has been executed.
@@ -1881,7 +1896,7 @@ export declare class DrawLayer {
     /**
      * Delete all Draws from the stage.
      *
-     * @deprecated
+     * @deprecated Since v0.34, please switch to `annotationGroup.remove`.
      * @param {Function} _exeCallback The callback to call once the
      *  DeleteCommand has been executed.
      */
@@ -2546,7 +2561,7 @@ declare class Image_2 {
      * Can window and level be applied to the data?
      *
      * @returns {boolean} True if the data is monochrome.
-     * @deprecated Please use isMonochrome instead.
+     * @deprecated Since v0.33, please use isMonochrome instead.
      */
     canWindowLevel(): boolean;
     /**
@@ -5508,7 +5523,7 @@ export declare class ViewController {
      * Can window and level be applied to the data?
      *
      * @returns {boolean} True if possible.
-     * @deprecated Please use isMonochrome instead.
+     * @deprecated Since v0.33, please use isMonochrome instead.
      */
     canWindowLevel(): boolean;
     /**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dwv",
-  "version": "0.34.0-beta.23",
+  "version": "0.34.0",
   "description": "DICOM Web Viewer.",
   "keywords": [
     "DICOM",

resources/api/dwv.api.md

@@ -107,6 +107,8 @@ export class App {
     };
     getDrawLayers(callbackFn?: Function): DrawLayer[];
     getDrawLayersByDataId(dataId: string): DrawLayer[];
+    // @deprecated
+    getImage(dataId: string): Image_2 | undefined;
     getLayerGroupByDivId(divId: string): LayerGroup;
     getMetaData(dataId: string): {
         [x: string]: DataElement;

resources/doc/jsdoc.conf.json

@@ -25,7 +25,7 @@
       "package": "package.json",
       "theme_opts": {
         "title": "DWV",
-        "footer": "<i>Documentation generated for dwv v0.34.0-beta.23.</i>",
+        "footer": "<i>Documentation generated for dwv v0.34.0.</i>",
         "sections": [
           "Tutorials",
           "Namespaces",
@@ -50,7 +50,7 @@
         "codepen": {
           "enable_for": ["examples"],
           "options": {
-            "js_external": "https://github.com/ivmartel/dwv/releases/download/v0.34.0-beta.23/dwv-0.34.0-beta.23.min.js",
+            "js_external": "https://github.com/ivmartel/dwv/releases/download/v0.34.0/dwv-0.34.0.min.js",
             "html": "<div id='dwv'><div id='layerGroup0'></div></div>"
           }
         }

resources/doc/tutorials/test-results.md

@@ -2,25 +2,28 @@
 
 ## Context
 
-Date: Thu Jun 13 2024 11:56:35 GMT+0200 (Central European Summer Time)
+Date: Thu Nov 14 2024 18:36:05 GMT+0100 (Central European Standard Time)
 
-Commit: [5909e54](git://github.com/ivmartel/dwv.git/commit/5909e54fa860694e4867a83d0a3446704373db3c)
+Commit: [166d5ed](git://github.com/ivmartel/dwv.git/commit/166d5edd4ac03e0fcdee6eefe8974770eda6ea74)
 
-Browser: Chrome Headless 125.0.6422.141 (Linux x86_64)
+Browser: Chrome Headless 130.0.0.0 (Linux x86_64)
 
 ## Summary
-Success: 163 ✅
+Success: 166 ✅
 
 Failed: 0 ❌
 
-(total: 163, skipped: 0, total time: 1600ms)
+(total: 166, skipped: 0, total time: 1644ms)
 
 ## Tests details
 
-(37 / 163 tests with requirement(s), 126 tests with no requirement)
+(38 / 166 tests with requirement(s), 128 tests with no requirement)
 
 ### utils
 
+- Index stringId: ✅ 
+(⚠️ No requirement reference, [jsdoc](module-tests_utils.html#~index-stringid))
+
 - arrayContains: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_utils.html#~arraycontains))
 
@@ -90,6 +93,9 @@ Failed: 0 ❌
 - ThreadPool class: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_utils.html#~threadpool-class))
 
+- UndoStack: ✅ 
+(URS [#DWV-REQ-UI-08-002 (Draw action undo/redo)](tutorial-user-stories.html#dwv-req-ui-08-002-draw-action-undo%2Fredo), [jsdoc](module-tests_utils.html#~undostack))
+
 - getUrlFromUri: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_utils.html#~geturlfromuri))
 
@@ -124,15 +130,15 @@ Failed: 0 ❌
 - Index class: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_math.html#~index-class))
 
-- Index stringId: ✅ 
-(⚠️ No requirement reference, [jsdoc](module-tests_math.html#~index-stringid))
-
 - Line class: ✅ 
 (URS [#DWV-REQ-UI-07-007 (Draw ruler)](tutorial-user-stories.html#dwv-req-ui-07-007-draw-ruler), [jsdoc](module-tests_math.html#~line-class))
 
 - Angle between lines: ✅ 
 (URS [#DWV-REQ-UI-07-005 (Draw protractor)](tutorial-user-stories.html#dwv-req-ui-07-005-draw-protractor), [jsdoc](module-tests_math.html#~angle-between-lines))
 
+- areOrthogonal: ✅ 
+(⚠️ No requirement reference, [jsdoc](module-tests_math.html#~areorthogonal))
+
 - Perpendicular line: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_math.html#~perpendicular-line))
 
@@ -163,9 +169,15 @@ Failed: 0 ❌
 - orientation matrix factories: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_math.html#~orientation-matrix-factories))
 
+- getOrientationFromCosines: ✅ 
+(⚠️ No requirement reference, [jsdoc](module-tests_math.html#~getorientationfromcosines))
+
 - getOrientationStringLPS: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_math.html#~getorientationstringlps))
 
+- getOrientationName: ✅ 
+(⚠️ No requirement reference, [jsdoc](module-tests_math.html#~getorientationname))
+
 - Path class: ✅ 
 (URS [#DWV-REQ-UI-07-004 (Draw free hand)](tutorial-user-stories.html#dwv-req-ui-07-004-draw-free-hand), [jsdoc](module-tests_math.html#~path-class))
 
@@ -213,9 +225,6 @@ Failed: 0 ❌
 - DICOM code class: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_dicom.html#~dicom-code-class))
 
-- DICOM dump: ✅ 
-(⚠️ No requirement reference, [jsdoc](module-tests_dicom.html#~dicom-dump))
-
 - Get DICOM Date: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_dicom.html#~get-dicom-date))
 
@@ -225,6 +234,9 @@ Failed: 0 ❌
 - Get DICOM datetime: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_dicom.html#~get-dicom-datetime))
 
+- DICOM dump: ✅ 
+(⚠️ No requirement reference, [jsdoc](module-tests_dicom.html#~dicom-dump))
+
 - Simple DICOM parsing: ✅ 
 (URS [#DWV-REQ-IO-01-001 (Load DICOM file(s))](tutorial-user-stories.html#dwv-req-io-01-001-load-dicom-file(s)), [jsdoc](module-tests_dicom.html#~simple-dicom-parsing))
 
@@ -237,9 +249,6 @@ Failed: 0 ❌
 - DICOMDIR parsing: ✅ 
 (URS [#DWV-REQ-IO-02-004 (Load DICOMDIR URL)](tutorial-user-stories.html#dwv-req-io-02-004-load-dicomdir-url), [jsdoc](module-tests_dicom.html#~dicomdir-parsing))
 
-- getOrientationName: ✅ 
-(⚠️ No requirement reference, [jsdoc](module-tests_dicom.html#~getorientationname))
-
 - DICOM segment class: ✅ 
 (⚠️ No requirement reference, [jsdoc](module-tests_dicom.html#~dicom-segment-class))
 
@@ -519,7 +528,7 @@ Failed: 0 ❌
 
 ## Traceability
 
-(19 / 50 tested requirements)
+(20 / 50 tested requirements)
 
 ### io
 
@@ -685,7 +694,7 @@ URS [#DWV-REQ-UI-08-001 (Draw delete)](tutorial-user-stories.html#dwv-req-ui-08-
  ⚠️ No tests
 
 URS [#DWV-REQ-UI-08-002 (Draw action undo/redo)](tutorial-user-stories.html#dwv-req-ui-08-002-draw-action-undo%2Fredo):
- ⚠️ No tests
+ ✅ UndoStack 
 
 URS [#DWV-REQ-UI-09-001 (Livewire)](tutorial-user-stories.html#dwv-req-ui-09-001-livewire):
  ⚠️ No tests

src/dicom/dicomParser.js

@@ -29,7 +29,7 @@ import {logger} from '../utils/logger';
  * @returns {string} The version of the library.
  */
 export function getDwvVersion() {
-  return '0.34.0-beta.23';
+  return '0.34.0';
 }
 
 /**