JSDoc types added to OverlayPanel

frontend-js/src/main/js/gui/leftPanel/OverlayPanel.js

@@ -13,10 +13,21 @@ var Functions = require('../../Functions');
 
 var Promise = require('bluebird');
 
+/**
+ *
+ * @param {Object} params
+ * @param {Configuration} [params.configuration]
+ * @param {HTMLElement} params.element
+ * @param {Project} params.project
+ * @param {CustomMap} params.customMap
+ * @param params.parent
+ * @constructor
+ * @extends Panel
+ */
 function OverlayPanel(params) {
-  params.panelName = "overlays";
-  params.scrollable = true;
-  params.helpTip = "<p>Overlays tab allows to display or generate custom coloring of elements and interactions in the map.</p>"
+  params["panelName"] = "overlays";
+  params["scrollable"] = true;
+  params["helpTip"] = "<p>Overlays tab allows to display or generate custom coloring of elements and interactions in the map.</p>"
     + "<p>General overlays are overlays accessible for every user viewing the content.</p>"
     + "<p>Custom overlays are user-provided overlays, this menu becomes available upon login (see below).</p>";
   Panel.call(this, params);
@@ -81,6 +92,10 @@ function OverlayPanel(params) {
 OverlayPanel.prototype = Object.create(Panel.prototype);
 OverlayPanel.prototype.constructor = OverlayPanel;
 
+/**
+ *
+ * @private
+ */
 OverlayPanel.prototype._createOverlayPanelGui = function () {
   var generalOverlaysDiv = Functions.createElement({
     type: "div",
@@ -156,6 +171,11 @@ OverlayPanel.prototype.clear = function () {
   table.clear().draw();
 };
 
+/**
+ *
+ * @param {boolean} edit
+ * @returns {HTMLElement}
+ */
 OverlayPanel.prototype.createTableHeader = function (edit) {
   var result = document.createElement("thead");
 
@@ -183,6 +203,12 @@ OverlayPanel.prototype.createTableHeader = function (edit) {
   return result;
 };
 
+/**
+ *
+ * @param {DataOverlay} overlay
+ * @param {boolean} checked
+ * @returns {HTMLElement}
+ */
 OverlayPanel.prototype.createOverlayRow = function (overlay, checked) {
   var self = this;
   var guiUtils = self.getGuiUtils();
@@ -243,6 +269,12 @@ OverlayPanel.prototype.createOverlayRow = function (overlay, checked) {
   return result;
 };
 
+/**
+ *
+ * @param {DataOverlay} overlay
+ * @param {boolean} checked
+ * @returns {Array}
+ */
 OverlayPanel.prototype.overlayToDataRow = function (overlay, checked) {
   // if (checked && !overlay.getInputDataAvailable()) {
   //   result.className = "active";
@@ -273,6 +305,10 @@ OverlayPanel.prototype.overlayToDataRow = function (overlay, checked) {
   return result;
 };
 
+/**
+ *
+ * @param {DataOverlay} overlay
+ */
 OverlayPanel.prototype.openEditOverlayDialog = function (overlay) {
   var self = this;
   var guiUtils = self.getGuiUtils();
@@ -325,6 +361,11 @@ OverlayPanel.prototype.openEditOverlayDialog = function (overlay) {
   });
 };
 
+/**
+ *
+ * @param {boolean} showDefault
+ * @returns {PromiseLike}
+ */
 OverlayPanel.prototype.refresh = function (showDefault) {
   var self = this;
   var user = null;
@@ -431,15 +472,27 @@ OverlayPanel.prototype.refresh = function (showDefault) {
   });
 };
 
+/**
+ *
+ * @param {string} customOverlaysMessage
+ */
 OverlayPanel.prototype.setCustomOverlaysMessage = function (customOverlaysMessage) {
   this._customOverlaysMessage = customOverlaysMessage;
 };
 
+/**
+ *
+ * @returns {string}
+ */
 OverlayPanel.prototype.getCustomOverlaysMessage = function () {
   return this._customOverlaysMessage;
 };
 
 
+/**
+ *
+ * @returns {PromiseLike}
+ */
 OverlayPanel.prototype.openAddOverlayDialog = function () {
   var self = this;
   if (self._addOverlayDialog !== undefined) {
@@ -459,6 +512,10 @@ OverlayPanel.prototype.openAddOverlayDialog = function () {
   });
 };
 
+/**
+ *
+ * @returns {PromiseLike}
+ */
 OverlayPanel.prototype.init = function () {
   var self = this;
   var backgroundOverlay = ServerConnector.getSessionData().getSelectedBackgroundOverlay();
@@ -501,6 +558,13 @@ OverlayPanel.prototype.init = function () {
 
   return this.refresh(showDefault);
 };
+
+/**
+ *
+ * @param {number} overlayId
+ * @param {number} order
+ * @returns {PromiseLike}
+ */
 OverlayPanel.prototype.updateOverlayOrder = function (overlayId, order) {
   var self = this;
   return self.getProject().getDataOverlayById(overlayId).then(function (overlay) {
@@ -508,6 +572,12 @@ OverlayPanel.prototype.updateOverlayOrder = function (overlayId, order) {
     return ServerConnector.updateOverlay(overlay);
   });
 };
+
+/**
+ *
+ * @param {DataOverlay} overlay
+ * @returns {PromiseLike<any>}
+ */
 OverlayPanel.prototype.removeOverlay = function (overlay) {
   self = this;
   return self.getMap().hideDataOverlay(overlay.getId()).then(function () {
@@ -517,6 +587,10 @@ OverlayPanel.prototype.removeOverlay = function (overlay) {
   })
 };
 
+/**
+ *
+ * @returns {PromiseLike}
+ */
 OverlayPanel.prototype.destroy = function () {
   var self = this;
   Panel.prototype.destroy.call(this);