From e77483683d2be886fc1fc59573aa48cb3bec0900 Mon Sep 17 00:00:00 2001
From: Piotr Gawron <piotr.gawron@uni.lu>
Date: Mon, 30 Apr 2018 10:34:14 +0200
Subject: [PATCH] JSDoc for Submap class
---
frontend-js/src/main/js/map/Submap.js | 26 ++++++++++++++++---
.../elements/id=345339&token=MOCK_TOKEN_ID& | 1 +
2 files changed, 24 insertions(+), 3 deletions(-)
create mode 100644 frontend-js/testFiles/apiCalls/projects/complex_model_with_submaps/models/all/bioEntities/elements/id=345339&token=MOCK_TOKEN_ID&
diff --git a/frontend-js/src/main/js/map/Submap.js b/frontend-js/src/main/js/map/Submap.js
index 912e7fc057..fec5c2b175 100644
--- a/frontend-js/src/main/js/map/Submap.js
+++ b/frontend-js/src/main/js/map/Submap.js
@@ -7,8 +7,6 @@ var logger = require('../logger');
var AbstractCustomMap = require('./AbstractCustomMap');
var CustomMapOptions = require('./CustomMapOptions');
-var GoogleMapsApiCanvas = require('./canvas/GoogleMaps/GoogleMapsApiCanvas');
-
/**
* Constructor of a submap. Submaps are created on application start. But dialog
* (popup window) is initialized on demand using init function.
@@ -17,6 +15,8 @@ var GoogleMapsApiCanvas = require('./canvas/GoogleMaps/GoogleMapsApiCanvas');
* parent CustomMap
* @param {MapModel} model
*
+ * @constructor
+ * @extends AbstractCustomMap
*/
function Submap(customMap, model) {
this.setCustomMap(customMap);
@@ -39,7 +39,7 @@ Submap.prototype.constructor = Submap;
* This method initializes submap with gui component. Before this point submap
* is created and contains data, but cannot be visualized in the browser.
*
- * @param htmlTag
+ * @param {HTMLElement} htmlTag
* html div tag where google map should be placed
*/
Submap.prototype.open = function (htmlTag) {
@@ -88,24 +88,44 @@ Submap.prototype.open = function (htmlTag) {
};
+/**
+ *
+ * @param {number} identifier
+ */
Submap.prototype.openDataOverlay = function (identifier) {
if (this.isInitialized()) {
this.getMapCanvas().setBackgroundId(identifier.toString());
}
};
+/**
+ *
+ * @returns {CustomMap}
+ */
Submap.prototype.getTopMap = function () {
return this.getCustomMap();
};
+/**
+ *
+ * @returns {CustomMap}
+ */
Submap.prototype.getCustomMap = function () {
return this._customMap;
};
+/**
+ *
+ * @param {CustomMap} customMap
+ */
Submap.prototype.setCustomMap = function (customMap) {
this._customMap = customMap;
};
+/**
+ *
+ * @returns {Project}
+ */
Submap.prototype.getProject = function () {
return this.getCustomMap().getProject();
};
diff --git a/frontend-js/testFiles/apiCalls/projects/complex_model_with_submaps/models/all/bioEntities/elements/id=345339&token=MOCK_TOKEN_ID& b/frontend-js/testFiles/apiCalls/projects/complex_model_with_submaps/models/all/bioEntities/elements/id=345339&token=MOCK_TOKEN_ID&
new file mode 100644
index 0000000000..7f45514930
--- /dev/null
+++ b/frontend-js/testFiles/apiCalls/projects/complex_model_with_submaps/models/all/bioEntities/elements/id=345339&token=MOCK_TOKEN_ID&
@@ -0,0 +1 @@
+[{"abbreviation":null,"boundaryCondition":false,"bounds":{"height":30.0,"width":80.0,"x":257.0,"y":254.0},"compartmentId":345332,"complexId":null,"constant":false,"elementId":"sa4","formerSymbols":[],"formula":null,"fullName":null,"hierarchyVisibilityLevel":"1","id":345339,"initialAmount":0.0,"initialConcentration":null,"linkedSubmodel":16731,"modelId":16728,"name":"s4","notes":"","other":{"modifications":[],"structuralState":null,"structures":{}},"references":[],"symbol":null,"synonyms":[],"transparencyLevel":"0","type":"Phenotype"}]
\ No newline at end of file
--
GitLab