Skip to content
Snippets Groups Projects
Commit 4a14e94a authored by Piotr Gawron's avatar Piotr Gawron
Browse files

JSDoc for CustomMap added

parent c2688d37
No related branches found
No related tags found
1 merge request!295Resolve "alternative to google maps api way of visualizing maps"
Showing with 224 additions and 101 deletions
...@@ -304,7 +304,6 @@ AbstractCustomMap.prototype.getTopMap = function () { ...@@ -304,7 +304,6 @@ AbstractCustomMap.prototype.getTopMap = function () {
* number of overlays that are currently visualized * number of overlays that are currently visualized
* *
* @returns {PromiseLike} * @returns {PromiseLike}
* @private
*/ */
AbstractCustomMap.prototype._resizeSelectedDataOverlay = function (overlayId, index, length) { AbstractCustomMap.prototype._resizeSelectedDataOverlay = function (overlayId, index, length) {
var self = this; var self = this;
...@@ -340,7 +339,6 @@ AbstractCustomMap.prototype._resizeSelectedDataOverlay = function (overlayId, in ...@@ -340,7 +339,6 @@ AbstractCustomMap.prototype._resizeSelectedDataOverlay = function (overlayId, in
* @param {number} length * @param {number} length
* number of overlays that are currently visualized * number of overlays that are currently visualized
* @returns {PromiseLike} * @returns {PromiseLike}
* @private
*/ */
AbstractCustomMap.prototype._showSelectedDataOverlay = function (overlayId, index, length) { AbstractCustomMap.prototype._showSelectedDataOverlay = function (overlayId, index, length) {
var self = this; var self = this;
...@@ -449,7 +447,6 @@ AbstractCustomMap.prototype._hideSelectedLayout = function (overlayId) { ...@@ -449,7 +447,6 @@ AbstractCustomMap.prototype._hideSelectedLayout = function (overlayId) {
* marker for which we are opening window * marker for which we are opening window
* *
* @returns {PromiseLike} * @returns {PromiseLike}
* @private
*/ */
AbstractCustomMap.prototype._openInfoWindowForIdentifiedElement = function (element, marker) { AbstractCustomMap.prototype._openInfoWindowForIdentifiedElement = function (element, marker) {
var self = this; var self = this;
...@@ -476,7 +473,6 @@ AbstractCustomMap.prototype._openInfoWindowForIdentifiedElement = function (elem ...@@ -476,7 +473,6 @@ AbstractCustomMap.prototype._openInfoWindowForIdentifiedElement = function (elem
* @param {Marker} marker * @param {Marker} marker
* *
* @returns {PromiseLike} * @returns {PromiseLike}
* @private
*/ */
AbstractCustomMap.prototype._openInfoWindowForAlias = function (alias, marker) { AbstractCustomMap.prototype._openInfoWindowForAlias = function (alias, marker) {
var self = this; var self = this;
...@@ -508,7 +504,7 @@ AbstractCustomMap.prototype._openInfoWindowForAlias = function (alias, marker) { ...@@ -508,7 +504,7 @@ AbstractCustomMap.prototype._openInfoWindowForAlias = function (alias, marker) {
* *
* @param {number} aliasId * @param {number} aliasId
* identifier of the {@link Alias} * identifier of the {@link Alias}
* @returns {PromiseLike<LayoutAlias[]>} promise of an {Array} with list of {@link LayoutAlias} information * @returns {PromiseLike<LayoutAlias[]>| Promise<LayoutAlias[]>} promise of an {Array} with list of {@link LayoutAlias} information
* for a given {@link Alias} in all currently visualized overlays * for a given {@link Alias} in all currently visualized overlays
*/ */
AbstractCustomMap.prototype.getAliasVisibleLayoutsData = function (aliasId) { AbstractCustomMap.prototype.getAliasVisibleLayoutsData = function (aliasId) {
...@@ -527,7 +523,6 @@ AbstractCustomMap.prototype.getAliasVisibleLayoutsData = function (aliasId) { ...@@ -527,7 +523,6 @@ AbstractCustomMap.prototype.getAliasVisibleLayoutsData = function (aliasId) {
* Refresh content of all {@link AliasInfoWindow} in this map. * Refresh content of all {@link AliasInfoWindow} in this map.
* *
* @returns {PromiseLike} * @returns {PromiseLike}
* @private
*/ */
AbstractCustomMap.prototype._refreshInfoWindows = function () { AbstractCustomMap.prototype._refreshInfoWindows = function () {
var promises = []; var promises = [];
......
This diff is collapsed.
...@@ -37,6 +37,13 @@ function AbstractDbOverlay(params) { ...@@ -37,6 +37,13 @@ function AbstractDbOverlay(params) {
this.registerListenerType('onTargetVisibilityChange'); this.registerListenerType('onTargetVisibilityChange');
this.setQueries([]); this.setQueries([]);
this.mapOverlays = {
ALIAS: [],
REACTION: [],
POINT: []
};
} }
AbstractDbOverlay.prototype = Object.create(ObjectWithListeners.prototype); AbstractDbOverlay.prototype = Object.create(ObjectWithListeners.prototype);
...@@ -171,6 +178,9 @@ AbstractDbOverlay.prototype.createIdentifiedElementsForTargetingClass = function ...@@ -171,6 +178,9 @@ AbstractDbOverlay.prototype.createIdentifiedElementsForTargetingClass = function
return result; return result;
}; };
/**
* @returns {PromiseLike}
*/
AbstractDbOverlay.prototype.refresh = function () { AbstractDbOverlay.prototype.refresh = function () {
throw new Error("Refreshing shouldn't be called"); throw new Error("Refreshing shouldn't be called");
}; };
...@@ -212,10 +222,6 @@ AbstractDbOverlay.prototype.allowGeneralSearch = function () { ...@@ -212,10 +222,6 @@ AbstractDbOverlay.prototype.allowGeneralSearch = function () {
return this._allowGeneralSearch; return this._allowGeneralSearch;
}; };
AbstractDbOverlay.prototype.getName = function () {
return this.name;
};
/** /**
* Returns true if overlay allows to get data for element by search id. * Returns true if overlay allows to get data for element by search id.
*/ */
......
source diff could not be displayed: it is too large. Options to address this: view the blob.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment