Access rois by uid rather than index

This is more convenient but also saver since it avoids race conditions.

Author: hackermd

src/api.js

@@ -833,32 +833,21 @@ class VLWholeSlideMicroscopyImageViewer {
 
   getAllROIs() {
     let rois = [];
-    if (this.numberOfROIs > 0) {
-      for(let index = 0; index < this.numberOfROIs; index++){
-        rois.push(this.getROI(index));
-      }
-    }
+    this[_features].forEach((item) => {
+        rois.push(this.getROI(item.getId()));
+    });
     return rois;
   }
 
   get numberOfROIs() {
     return this[_features].getLength();
   }
 
-  getROI(index) {
-    const feature = this[_features].item(index);
+  getROI(uid) {
+    const feature = this[_drawingSource].getFeatureById(uid);
     return _getROIFromFeature(feature, this._pyramid);
   }
 
-  indexOfROI(item) {
-    for(let index = 0; index < this.numberOfROIs; index++){
-      if (item.uid === this[_features].item(index).getId()) {
-        return index;
-      }
-    }
-    return -1;
-  }
-
   popROI() {
     const feature = this[_features].pop();
     return _getROIFromFeature(feature, this._pyramid);
@@ -868,19 +857,17 @@ class VLWholeSlideMicroscopyImageViewer {
     const geometry = _scoord3d2Geometry(item.scoord3d, this._pyramid);
     const feature = new Feature(geometry);
     feature.setProperties(item.properties, true);
+    feature.setId(item.uid);
     this[_features].push(feature);
   }
 
-  updateROI(index, item) {
-    const geometry = _scoord3d2Geometry(item.scoord3d, this._pyramid);
-    const feature = new Feature(geometry);
-    feature.setProperties(item.properties, true);
-    feature.setId(item.uid);
-    this[_features].setAt(index, feature);
+  removeROI(uid) {
+    const feature = this[_drawingSource].getFeatureById(uid);
+    this[_features].remove(feature);
   }
 
-  removeROI(index) {
-    this[_features].removeAt(index);
+  removeAllROI() {
+    this[_features].clear();
   }
 
   hideROIs() {

test/api.spec.js

@@ -96,82 +96,66 @@ describe('dicomMicroscopyViewer.api.VLWholeSlideMicroscopyImageViewer', ()=> {
         });
     })
 
-    it('should return {} if there is no drawing', () => {
-        assert.deepEqual(viewer.getROI(0), {});
+    it('should return [] if there is no drawing', () => {
+        assert.deepEqual(viewer.getAllROIs(), []);
     })
 
     it('should create a Point ROI and return it back successfuly', () => {
         const roi = new dicomMicroscopyViewer.roi.ROI({scoord3d : point, properties});
         viewer.addROI(roi);
-        assert.deepEqual(viewer.getROI(0).scoord3d.graphicData, point.graphicData);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData, point.graphicData);
     })
 
     it('should create a Box ROI and return it back successfuly', () => {
         const roi = new dicomMicroscopyViewer.roi.ROI({scoord3d : box, properties});
         viewer.addROI(roi);
-        assert.deepEqual(viewer.getROI(1).scoord3d.graphicData, box.graphicData);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData, box.graphicData);
     })
 
     it('should create a Polygon ROI and return it back successfuly', () => {
         const roi = new dicomMicroscopyViewer.roi.ROI({scoord3d : polygon, properties});
         viewer.addROI(roi);
-        assert.deepEqual(viewer.getROI(2).scoord3d.graphicData, polygon.graphicData);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData, polygon.graphicData);
     })
 
     it('should create a Freehand Polygon ROI and return it back successfuly', () => {
         const roi = new dicomMicroscopyViewer.roi.ROI({scoord3d : freehandPolygon, properties});
         viewer.addROI(roi);
-        assert.deepEqual(viewer.getROI(3).scoord3d.graphicData, freehandPolygon.graphicData);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData, freehandPolygon.graphicData);
     })
 
     it('should create a Line ROI and return it back successfuly', () => {
         const roi = new dicomMicroscopyViewer.roi.ROI({scoord3d : line, properties});
         viewer.addROI(roi);
-        assert.deepEqual(viewer.getROI(4).scoord3d.graphicData, line.graphicData);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData, line.graphicData);
     })
 
     it('should create a FreehandLine ROI and return it back successfuly', () => {
         const roi = new dicomMicroscopyViewer.roi.ROI({scoord3d : freeHandLine, properties});
         viewer.addROI(roi);
-        assert.deepEqual(viewer.getROI(5).scoord3d.graphicData, freeHandLine.graphicData);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData, freeHandLine.graphicData);
     })
 
     it('should create an Ellipse ROI and return it back successfuly', () => {
         const roi = new dicomMicroscopyViewer.roi.ROI({scoord3d : ellipse, properties});
         viewer.addROI(roi);
-        assert.deepEqual(viewer.getROI(6).scoord3d.graphicData[0], ellipse.graphicData[0]);
-        assert.deepEqual(viewer.getROI(6).scoord3d.graphicData[1], ellipse.graphicData[1]);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData[0], ellipse.graphicData[0]);
+        assert.deepEqual(viewer.getROI(roi.uid).scoord3d.graphicData[1], ellipse.graphicData[1]);
     })
 
     it('should return all ROIs created up to now', () => {
         const rois = viewer.getAllROIs();
         assert.equal(rois.length, 7)
     })
 
-    it('should be able to modify the point ROI', () => {
-        let rois = viewer.getAllROIs();
-        assert.deepEqual(rois[0].scoord3d.coordinates, point.coordinates);
-        const newPoint = new dicomMicroscopyViewer.scoord3d.Point({
-          coordinates: [0, 10, 1],
-          frameOfReferenceUID: '1.2.3'
-        });
-        const newPointRoi = new dicomMicroscopyViewer.roi.ROI({scoord3d : newPoint, properties});
-        viewer.updateROI(0, newPointRoi);
-        rois = viewer.getAllROIs();
-        assert.deepEqual(rois[0].scoord3d.coordinates, newPoint.coordinates);
-        // Change back to not affect downstream tests
-        const oldPointRoi = new dicomMicroscopyViewer.roi.ROI({scoord3d : point, properties});
-        viewer.updateROI(0, oldPointRoi);
-    })
-
     it('should be able to remove the point ROI', () => {
         let rois = viewer.getAllROIs();
         assert.equal(rois.length, 7);
-        assert.deepEqual(viewer.getROI(0).scoord3d.graphicData, point.graphicData);
-        viewer.removeROI(0);
+        assert.deepEqual(viewer.getROI(rois[0].uid).scoord3d.graphicData, point.graphicData);
+        viewer.removeROI(rois[0].uid);
         rois = viewer.getAllROIs();
         assert.equal(rois.length, 6);
-        assert.deepEqual(viewer.getROI(0).scoord3d.graphicData, box.graphicData);
+        assert.deepEqual(viewer.getROI(rois[0].uid).scoord3d.graphicData, box.graphicData);
     })