Beta v0.34.0-beta.5

ivmartel · Jul 17, 2024 · 67770f4 · 67770f4
1 parent 022f3dd
commit 67770f4
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 27 deletions.
diff --git a/dist/dwv.d.ts b/dist/dwv.d.ts
@@ -109,6 +109,12 @@ export declare class Annotation {
      * @returns {object} The factory.
      */
     getFactory(): object;
+    /**
+     * Get the string type of this annotation.
+     *
+     * @returns {string} The type.
+     */
+    getType(): string;
     #private;
 }
 
@@ -208,6 +214,14 @@ export declare class AnnotationGroup {
      * @returns {Annotation|undefined} The found annotation.
      */
     find(id: string): Annotation | undefined;
+    /**
+     * Get the meta data.
+     *
+     * @returns {Object<string, any>} The meta data.
+     */
+    getMeta(): {
+        [x: string]: any;
+    };
     /**
      * Check if this list contains a meta data value.
      *
@@ -221,14 +235,14 @@ export declare class AnnotationGroup {
      * @param {string} key The meta data key.
      * @returns {object} The meta data value.
      */
-    getMeta(key: string): object;
+    getMetaValue(key: string): object;
     /**
      * Set a meta data.
      *
      * @param {string} key The meta data key.
      * @param {object} value The value of the meta data.
      */
-    setMeta(key: string, value: object): void;
+    setMetaValue(key: string, value: object): void;
     /**
      * Add an event listener to this class.
      *
@@ -1737,8 +1751,9 @@ export declare class DrawShapeHandler {
      */
     /**
      * @param {App} app The associated application.
+     * @param {Function} eventCallback Event callback.
      */
-    constructor(app: App);
+    constructor(app: App, eventCallback: Function);
     /**
      * Set the draw editor shape.
      *
@@ -1777,7 +1792,7 @@ export declare class DrawShapeHandler {
      *
      * @param {DrawLayer} drawLayer The origin draw layer.
      * @param {Konva.Group} shapeGroup The shape group to set on.
-     * @param {Annotation} annotation The associated annnotation.
+     * @param {Annotation} annotation The associated annotation.
      */
     addShapeListeners(drawLayer: DrawLayer, shapeGroup: Konva.Group, annotation: Annotation): void;
     /**
@@ -4764,18 +4779,6 @@ export declare class ViewController {
      * @returns {string} The unit.
      */
     getPixelUnit(): string;
-    /**
-     * Get the image study instance UID.
-     *
-     * @returns {string} The UID.
-     */
-    getStudyInstanceUID(): string;
-    /**
-     * Get the image series instance UID.
-     *
-     * @returns {string} The UID.
-     */
-    getSeriesInstanceUID(): string;
     /**
      * Get some values from the associated image in a region.
      *

diff --git a/dist/dwv.min.js b/dist/dwv.min.js
diff --git a/dist/dwv.min.js.map b/dist/dwv.min.js.map
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dwv",
-  "version": "0.34.0-beta.4",
+  "version": "0.34.0-beta.5",
   "description": "DICOM Web Viewer.",
   "keywords": [
     "DICOM",

diff --git a/resources/api/dwv.api.md b/resources/api/dwv.api.md
@@ -17,6 +17,7 @@ export class Annotation {
     getFactory(): object;
     getOriginIndex(): Index | undefined;
     getText(): string;
+    getType(): string;
     id: string;
     labelPosition: Point2D;
     mathShape: object;
@@ -55,11 +56,14 @@ export class AnnotationGroup {
     find(id: string): Annotation | undefined;
     getLength(): number;
     getList(): Annotation[];
-    getMeta(key: string): object;
+    getMeta(): {
+        [x: string]: any;
+    };
+    getMetaValue(key: string): object;
     hasMeta(key: string): boolean;
     remove(id: string): void;
     removeEventListener(type: string, callback: Function): void;
-    setMeta(key: string, value: object): void;
+    setMetaValue(key: string, value: object): void;
     setViewController(viewController: ViewController): void;
     update(annotation: Annotation): void;
 }
@@ -386,7 +390,7 @@ export class DrawLayer {
 
 // @public
 export class DrawShapeHandler {
-    constructor(app: App);
+    constructor(app: App, eventCallback: Function);
     addShapeListeners(drawLayer: DrawLayer, shapeGroup: Konva.Group, annotation: Annotation): void;
     disableAndResetEditor(): void;
     getEditorAnnotation(): Annotation | undefined;
@@ -1032,8 +1036,6 @@ export class ViewController {
     getPositionFromPlanePoint(point2D: Point2D): Point;
     getRescaledImageValue(position: Point): number | undefined;
     getScrollIndex(): number;
-    getSeriesInstanceUID(): string;
-    getStudyInstanceUID(): string;
     getWindowLevel(): WindowLevel;
     getWindowLevelPresetsNames(): string[];
     incrementIndex(dim: number, silent?: boolean): boolean;

diff --git a/resources/doc/jsdoc.conf.json b/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.4.</i>",
+        "footer": "<i>Documentation generated for dwv v0.34.0-beta.5.</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.4/dwv-0.34.0-beta.4.min.js",
+            "js_external": "https://github.com/ivmartel/dwv/releases/download/v0.34.0-beta.5/dwv-0.34.0-beta.5.min.js",
             "html": "<div id='dwv'><div id='layerGroup0'></div></div>"
           }
         }

diff --git a/src/dicom/dicomParser.js b/src/dicom/dicomParser.js
@@ -34,7 +34,7 @@ import {
  * @returns {string} The version of the library.
  */
 export function getDwvVersion() {
-  return '0.34.0-beta.4';
+  return '0.34.0-beta.5';
 }
 
 /**