Skip to content

Commit

Permalink
Fix types in layertree
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrunner committed Jan 28, 2019
1 parent 9a27381 commit eea63d8
Show file tree
Hide file tree
Showing 9 changed files with 53 additions and 51 deletions.
8 changes: 4 additions & 4 deletions contribs/gmf/src/datasource/Manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ export class DatasourceManager {
* are added or removed, pushing it to the cache or removing it from the
* cache.
*
* @param {Array.<import("ngeo/layertree/Controller.js").default>|undefined} value List of tree
* @param {Array.<import("ngeo/layertree/Controller.js").LayertreeController>|undefined} value List of tree
* controllers.
* @private
*/
Expand Down Expand Up @@ -593,7 +593,7 @@ export class DatasourceManager {
* Also, set its according data source. Finally, add the data source to
* the ngeo collection.
*
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl Layertree controller to add
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl Layertree controller to add
* @private
*/
addTreeCtrlToCache_(treeCtrl) {
Expand Down Expand Up @@ -702,7 +702,7 @@ export class DatasourceManager {
* Note: The possible states can only be 'on' or 'off', because the
* layertree controller being a 'leaf'.
*
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl The layer tree controller
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl The layer tree controller
* @param {string|undefined} newVal New state value
* @private
*/
Expand All @@ -725,7 +725,7 @@ export class DatasourceManager {
/**
* Returns a layertree controller cache item, if it exists.
*
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl The layer tree controller
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl The layer tree controller
* @return {ManagerTreeCtrlCacheItem} Cache item
* @private
*/
Expand Down
8 changes: 4 additions & 4 deletions contribs/gmf/src/editing/Snapping.js
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ EditingSnappingService.prototype.handleThemesChange_ = function() {
* create and add a cache item with every configuration required to do the
* snapping. It becomes active when its state is set to 'on'.
*
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl Layertree controller to register
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl Layertree controller to register
* @private
*/
EditingSnappingService.prototype.registerTreeCtrl_ = function(treeCtrl) {
Expand Down Expand Up @@ -267,7 +267,7 @@ EditingSnappingService.prototype.unregisterAllTreeCtrl_ = function() {
/**
* Get the OGC server.
*
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl The layer tree controller
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl The layer tree controller
* @return {?import(gmf/themes.js).GmfOgcServers} The OGC server.
* @private
*/
Expand Down Expand Up @@ -307,7 +307,7 @@ EditingSnappingService.prototype.getOGCServer_ = function(treeCtrl) {
* to `true`
* 4) the ogcServer defined in 3) has the `wfsSupport` property set to `true`.
*
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl The layer tree controller
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl The layer tree controller
* @return {?WFSConfig} The configuration object.
* @private
*/
Expand Down Expand Up @@ -357,7 +357,7 @@ EditingSnappingService.prototype.getWFSConfig_ = function(treeCtrl) {


/**
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl The layer tree controller
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl The layer tree controller
* @param {string|undefined} newVal New state value
* @private
*/
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/src/editing/editFeatureComponent.js
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ module.run(/* @ngInject */ ($templateCache) => {
* @htmlAttribute {boolean} gmf-editfeature-dirty Flag that is toggled as soon
* as the feature changes, i.e. if any of its properties change, which
* includes the geometry.
* @htmlAttribute {import("ngeo/layertree/Controller.js").default} gmf-editfeature-editabletreectrl
* @htmlAttribute {import("ngeo/layertree/Controller.js").LayertreeController} gmf-editfeature-editabletreectrl
* A reference to the editable Layertree controller, which contains a
* a reference to the node and WMS layer.
* @htmlAttribute {import("ol/Map.js").default} gmf-editfeature-map The map.
Expand Down Expand Up @@ -204,7 +204,7 @@ function Controller($element, $q, $scope, $timeout,
this.dirty;

/**
* @type {import("ngeo/layertree/Controller.js").default}
* @type {import("ngeo/layertree/Controller.js").LayertreeController}
* @export
*/
this.editableTreeCtrl;
Expand Down
6 changes: 3 additions & 3 deletions contribs/gmf/src/editing/editFeatureSelectorComponent.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ function Controller($scope, $timeout, gmfThemes, gmfTreeManager) {
this.gmfTreeManager_ = gmfTreeManager;

/**
* @param {Array.<import("ngeo/layertree/Controller.js").default>} value First level controllers.
* @param {Array.<import("ngeo/layertree/Controller.js").LayertreeController>} value First level controllers.
*/
const updateEditableTreeCtrls = function(value) {
// Timeout required, because the collection event is fired before the
Expand Down Expand Up @@ -180,14 +180,14 @@ function Controller($scope, $timeout, gmfThemes, gmfTreeManager) {

/**
* List of editable Layertree controllers.
* @type {Array.<import("ngeo/layertree/Controller.js").default>}
* @type {Array.<import("ngeo/layertree/Controller.js").LayertreeController>}
* @export
*/
this.editableTreeCtrls = [];

/**
* The currently selected Layertree controller.
* @type {?import("ngeo/layertree/Controller.js").default}
* @type {?import("ngeo/layertree/Controller.js").LayertreeController}
* @export
*/
this.selectedEditableTreeCtrl = null;
Expand Down
24 changes: 12 additions & 12 deletions contribs/gmf/src/layertree/SyncLayertreeMap.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export function SyncLayertreeMap($rootScope, ngeoLayerHelper, ngeoWMSTime, gmfTh
/**
* Create, insert (or update) and return a layer from the GmfGroup or the
* GmfLayer of the given treeCtrl.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @param {import("ol/Map.js").default} map A map that contains the group to insert the not first
* level group layer.
* @param {import("ol/layer/Group.js").default} dataLayerGroup the layer group to insert the first
Expand Down Expand Up @@ -95,7 +95,7 @@ SyncLayertreeMap.prototype.createLayer = function(treeCtrl, map, dataLayerGroup,
* Synchronise the state of each layers corresponding to the given tree and
* all its children.
* @param {import("ol/Map.js").default} map A map that contains the layers.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @private
*/
SyncLayertreeMap.prototype.sync_ = function(map, treeCtrl) {
Expand All @@ -110,7 +110,7 @@ SyncLayertreeMap.prototype.sync_ = function(map, treeCtrl) {
/**
* Set the active state of a layer based on its treeCtrl state.
* @param {import("ol/layer/Tile.js").default|import("ol/layer/Image.js").default} layer A layer.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @private
*/
SyncLayertreeMap.prototype.updateLayerState_ = function(layer, treeCtrl) {
Expand Down Expand Up @@ -151,7 +151,7 @@ SyncLayertreeMap.prototype.updateLayerState_ = function(layer, treeCtrl) {
* Create insert and return a layer group (for not mixed case) or a wmsLayer (for
* mixed case). Take care about the insertion order in the map in case of first
* level group.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @param {import("ol/Map.js").default} map A map that contains the group to insert the not first
* level group layer.
* @param {import("ol/layer/Group.js").default} dataLayerGroup the layer group to insert the first
Expand Down Expand Up @@ -196,7 +196,7 @@ SyncLayertreeMap.prototype.createGroup_ = function(treeCtrl, map,
/**
* Create, insert and return a layer group (for not mixed case) or a wmsLayer
* for mixed case).
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @param {boolean} mixed True for a group layer, false for a WMS layer.
* @return {import("ol/layer/Image.js").default|import("ol/layer/Group.js").default} a new layer.
* @private
Expand Down Expand Up @@ -242,7 +242,7 @@ SyncLayertreeMap.prototype.createLayerFromGroup_ = function(treeCtrl,

/**
* Create and insert a layer from a leaf in a mixed group.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @param {import("ol/Map.js").default} map A map that contains the group to insert the layer.
* @return {import("ol/layer/Tile.js").default|import("ol/layer/Image.js").default} a new layer.
* @private
Expand Down Expand Up @@ -295,7 +295,7 @@ SyncLayertreeMap.prototype.createLeafInAMixedGroup_ = function(treeCtrl, map) {
* Update a WMS layer with the given treeCtrl node information. Assumes that
* the first parent with ogcServer information is linked to the layer to update
* and that this treeCtrl node is a leafNode.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @param {import("ol/Map.js").default} map A map that contains the layer to update.
* @private
*/
Expand Down Expand Up @@ -360,7 +360,7 @@ SyncLayertreeMap.prototype.updateLayerReferences_ = function(leafNode, layer) {
/**
* Get the time parameter for a WMS Layer. If it's a group and it doesn't have
* time, get the first time parameter available in any child.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @return {string|undefined} A wms time param.
* @private
*/
Expand Down Expand Up @@ -391,7 +391,7 @@ SyncLayertreeMap.prototype.getTimeParam_ = function(treeCtrl) {

/**
* Return true if a parent tree is mixed, based on its node.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @return {boolean} True is any parent is mixed. False Otherwise.
* @private
*/
Expand All @@ -409,8 +409,8 @@ SyncLayertreeMap.prototype.isOneParentNotMixed_ = function(treeCtrl) {

/**
* Return the first parent, from the root parent, that is not mixed.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @return {import("ngeo/layertree/Controller.js").default} The first not mixed parent.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @return {import("ngeo/layertree/Controller.js").LayertreeController} The first not mixed parent.
* @private
*/
SyncLayertreeMap.prototype.getFirstLevelGroupCtrl_ = function(
Expand All @@ -425,7 +425,7 @@ SyncLayertreeMap.prototype.getFirstLevelGroupCtrl_ = function(

/**
* Return the layer used by the given treeCtrl.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller.
* @return {import("ol/layer/Base.js").default} The layer.
* @public
*/
Expand Down
8 changes: 4 additions & 4 deletions contribs/gmf/src/layertree/TreeManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export function LayertreeTreeManager($timeout, $injector, gettextCatalog, ngeoLa
* The controller of the (unique) root layer tree.
* The array of top level layer trees is available through `rootCtrl.children`.
* The order doesn't match with the ordre of the displayed layertree.
* @type {import("ngeo/layertree/Controller.js").default}
* @type {import("ngeo/layertree/Controller.js").LayertreeController}
* @export
*/
this.rootCtrl = null;
Expand Down Expand Up @@ -462,7 +462,7 @@ LayertreeTreeManager.prototype.notifyCantAddGroups_ = function(groups) {
/**
* Get a treeCtrl based on it's node id.
* @param {number} id the id of a GMFThemesGroup or a GMFThemesLeaf.
* @return {import("ngeo/layertree/Controller.js").default?} treeCtrl The associated controller or null.
* @return {import("ngeo/layertree/Controller.js").LayertreeController?} treeCtrl The associated controller or null.
* @public
*/
LayertreeTreeManager.prototype.getTreeCtrlByNodeId = function(id) {
Expand All @@ -481,7 +481,7 @@ LayertreeTreeManager.prototype.getTreeCtrlByNodeId = function(id) {

/**
* Get the OGC server.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @return {import(gmf/themes.js).GmfOgcServer} The OGC server.
*/
Expand Down Expand Up @@ -551,7 +551,7 @@ LayertreeTreeManager.prototype.refreshFirstLevelGroups_ = function(themes) {
/**
* Return a TreeManagerFullState that keeps the state of the given
* treeCtrl including the state of its children.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl the ngeo layertree controller to
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl the ngeo layertree controller to
* save.
* @return {TreeManagerFullState!} the fullState object.
* @private
Expand Down
28 changes: 14 additions & 14 deletions contribs/gmf/src/layertree/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ Controller.prototype.$onInit = function() {


/**
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl Layer tree controller.
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl Layer tree controller.
* @private
*/
Controller.prototype.updateDimensions_ = function(treeCtrl) {
Expand Down Expand Up @@ -366,7 +366,7 @@ Controller.prototype.updateLayerDimensions_ = function(layer, node) {
* treeCtrl. The layer will be inserted into the map. The layer can be null
* if the treeCtrl is based on a node inside a mixed node. It this case, the
* layer will be in the first parent declared as a mixed node.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl tree controller of the node
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl tree controller of the node
* @return {import("ol/layer/Base.js").default|import("ol/layer/Group.js").default|null} The OpenLayers layer or group
* for the node.
* @export
Expand Down Expand Up @@ -396,7 +396,7 @@ Controller.prototype.getLayer = function(treeCtrl) {
* Remove layer from this component's layergroup (and then, from the map) on
* a ngeo layertree destroy event.
* @param {angular.IScope} scope treeCtrl scope.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @export
*/
Expand All @@ -410,7 +410,7 @@ Controller.prototype.listeners = function(scope, treeCtrl) {

/**
* Toggle the state of treeCtrl's node.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @export
*/
Expand All @@ -429,7 +429,7 @@ Controller.prototype.toggleActive = function(treeCtrl) {
/**
* Return the current state of the given treeCtrl's node.
* Return a class name that match with the current node activation state.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @return {string} 'on' or 'off' or 'indeterminate'.
* @export
Expand All @@ -449,7 +449,7 @@ Controller.prototype.getNodeState = function(treeCtrl) {
* `gmf.datasource.Manager` service
*
* LayertreeController.prototype.updateWMSTimeLayerState - description
* @param {import("ngeo/layertree/Controller.js").default} layertreeCtrl ngeo layertree controller
* @param {import("ngeo/layertree/Controller.js").LayertreeController} layertreeCtrl ngeo layertree controller
* @param {{start : number, end : number}} time The start
* and optionally the end datetime (for time range selection) selected by user
* @export
Expand All @@ -473,7 +473,7 @@ Controller.prototype.updateWMSTimeLayerState = function(layertreeCtrl, time) {
/**
* Get the icon image URL for the given treeCtrl's layer. It can only return a
* string for internal WMS layers without multiple childlayers in the node.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @return {string|undefined} The icon legend URL or undefined.
* @export
Expand Down Expand Up @@ -514,7 +514,7 @@ Controller.prototype.getLegendIconURL = function(treeCtrl) {

/**
* Get the legends object (<LayerName: url> for each layer) for the given treeCtrl.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @return {Object.<string, string>} A <layerName: url> object that provides a
* layer for each layer.
Expand Down Expand Up @@ -561,7 +561,7 @@ Controller.prototype.getLegendsObject = function(treeCtrl) {

/**
* Get the number of legends object for this layertree controller.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @return {number} The number of Legends object.
* @export
Expand All @@ -588,7 +588,7 @@ Controller.prototype.getScale_ = function() {

/**
* Opens a openIframePopup with the content of the metadata url of a node.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @export
*/
Expand Down Expand Up @@ -690,7 +690,7 @@ Controller.prototype.getResolutionStyle = function(gmfLayer) {

/**
* Set the resolution of the map with the max or min resolution of the node.
* @param {import("ngeo/layertree/Controller.js").default} treeCtrl ngeo layertree controller, from
* @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl ngeo layertree controller, from
* the current node.
* @export
*/
Expand Down Expand Up @@ -754,7 +754,7 @@ Controller.prototype.isNodeLegendVisible = function(legendNodeId) {
* - it supports legend
* - it supports having the layer opacity being changed
*
* @param {!import("ngeo/layertree/Controller.js").default} treeCtrl Ngeo tree controller.
* @param {!import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl Ngeo tree controller.
* @return {boolean} Whether the layer tree controller supports being
* "customized" or not.
* @export
Expand All @@ -769,7 +769,7 @@ Controller.prototype.supportsCustomization = function(treeCtrl) {


/**
* @param {!import("ngeo/layertree/Controller.js").default} treeCtrl Ngeo tree controller.
* @param {!import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl Ngeo tree controller.
* @return {boolean} Whether the layer tree controller supports having a
* legend being shown.
* @export
Expand All @@ -783,7 +783,7 @@ Controller.prototype.supportsLegend = function(treeCtrl) {


/**
* @param {!import("ngeo/layertree/Controller.js").default} treeCtrl Ngeo tree controller.
* @param {!import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl Ngeo tree controller.
* @return {boolean} Whether the layer tree controller supports having its
* layer opacity being changed or not.
* @export
Expand Down
Loading

0 comments on commit eea63d8

Please sign in to comment.