Rename viewer class to DICOMMicroscopyViewer

Author: hackermd

README.md

@@ -41,7 +41,7 @@ const url = 'http://localhost:8080/dicomweb';
 const client = new DICOMwebClient.api.DICOMwebClient({url});
 const studyInstanceUID = '1.2.3.4';
 const seriesInstanceUID = '1.2.3.5';
-const viewer = new DICOMMicroscopyViewer.api.MicroscopyViewer({
+const viewer = new DICOMMicroscopyViewer.api.DICOMMicroscopyViewer({
   client,
   studyInstanceUID,
   seriesInstanceUID

build/dicom-microscopy-viewer.js

@@ -1,7 +1,7 @@
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
   typeof define === 'function' && define.amd ? define(['exports'], factory) :
-  (factory((global.MicroscopyViewer = {})));
+  (factory((global.DICOMMicroscopyViewer = {})));
 }(this, (function (exports) { 'use strict';
 
   /**
@@ -49441,15 +49441,25 @@
     });
   }
 
-  class MicroscopyViewer {
+  class DICOMMicroscopyViewer {
 
+    /*
+     * options:
+     * client - an instance of DICOMwebClient
+     * studyInstanceUID - DICOM Study Instance UID
+     * seriesInstanceUID - DICOM Study Instance UID
+     */
     constructor(options) {
       this.client = options.client;
       this.studyInstanceUID = options.studyInstanceUID;
       this.seriesInstanceUID = options.seriesInstanceUID;
       this.map = null;
     }
 
+    /*
+     * options:
+     * container - name of an HTML document element
+     */
     render(options) {
       console.log('render images using microscopy viewer');
       const studyInstanceUID = this.studyInstanceUID;
@@ -49813,7 +49823,7 @@
   }
 
   let api = {
-    MicroscopyViewer,
+    DICOMMicroscopyViewer,
   };
 
   exports.api = api;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dicom-microscopy-viewer",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Web-based viewer for DICOM Visible Light Whole Slide Microscopy Images",
   "main": "build/dicom-microscopy-viewer.js",
   "scripts": {

rollup.config.js

@@ -9,7 +9,7 @@ export default {
     {
       file: 'build/dicom-microscopy-viewer.js',
       format: 'umd',
-      name: 'MicroscopyViewer',
+      name: 'DICOMMicroscopyViewer',
       sourceMap: true
     },
   ],

src/api.js

@@ -15,7 +15,7 @@ import { getCenter } from 'ol/extent.js';
 import { formatImageMetadata } from './metadata.js';
 
 
-class MicroscopyViewer {
+class DICOMMicroscopyViewer {
 
   /*
    * options:
@@ -406,4 +406,4 @@ class MicroscopyViewer {
 
 }
 
-export { MicroscopyViewer };
+export { DICOMMicroscopyViewer };

src/dicom-microscopy-viewer.js

@@ -1,7 +1,7 @@
-import { MicroscopyViewer } from './api.js';
+import { DICOMMicroscopyViewer } from './api.js';
 
 let api = {
-  MicroscopyViewer,
+  DICOMMicroscopyViewer,
 };
 
 export { api };

test/test.js

@@ -2,7 +2,7 @@ const chai = require('chai');
 chai.should();
 
 const dicomMicroscopyViewer = require('../build/dicom-microscopy-viewer.js');
-const viewer = new dicomMicroscopyViewer.api.MicroscopyViewer({
+const viewer = new dicomMicroscopyViewer.api.DICOMMicroscopyViewer({
   client: 'foo',
   studyInstanceUID: '1.2.3.4',
   seriesInstanceUID: '1.2.3.5'