Fix types in interaction

camptocamp · Jan 28, 2019 · d64b0ae · d64b0ae
1 parent eea63d8
commit d64b0ae
Show file tree

Hide file tree

Showing 36 changed files with 342 additions and 345 deletions.
diff --git a/contribs/gmf/src/editing/editFeatureComponent.js b/contribs/gmf/src/editing/editFeatureComponent.js
@@ -527,7 +527,7 @@ Controller.prototype.$onInit = function() {
   this.dirty = this.dirty === true;
   this.editableNode_ = /** @type {import(gmf/themes.js).GmfLayer} */ (
     this.editableTreeCtrl.node);
-  this.features = this.vectorLayer.getSource().getFeaturesCollection();
+  this.features = /** @type {olSourceVector} */(this.vectorLayer.getSource()).getFeaturesCollection();
   this.tolerance = this.tolerance !== undefined ? this.tolerance : 10;
 
   // (1.1) Set editable WMS layer

diff --git a/contribs/gmf/src/import/importdatasourceComponent.js b/contribs/gmf/src/import/importdatasourceComponent.js
@@ -183,10 +183,10 @@ class Controller {
     this.pending = false;
 
     /**
-     * @type {!unitPrefix}
+     * @type {!import('ngeo/misc/filters.js').unitPrefix}
      * @private
      */
-    this.unitPrefixFormat_ = /** @type {unitPrefix} */ (
+    this.unitPrefixFormat_ = /** @type {import('ngeo/misc/filters.js').unitPrefix} */ (
       $filter('ngeoUnitPrefix'));
 
     /**

diff --git a/contribs/gmf/src/lidarprofile/Manager.js b/contribs/gmf/src/lidarprofile/Manager.js
@@ -152,7 +152,7 @@ export class LidarprofileManager {
    */
   clearBuffer() {
     if (this.lidarBuffer) {
-      this.lidarBuffer.getSource().clear();
+      /** @type {olSourceVector} */(this.lidarBuffer.getSource()).clear();
     }
   }
 
@@ -461,8 +461,8 @@ export class LidarprofileManager {
     const clip = this.utils.clipLineByMeasure(this.config, map_resolution,
       this.line_, domainX[0], domainX[1]);
 
-    this.lidarBuffer.getSource().clear();
-    this.lidarBuffer.getSource().addFeature(clip.bufferGeom);
+    /** @type {olSourceVector} */(this.lidarBuffer.getSource()).clear();
+    /** @type {olSourceVector} */(this.lidarBuffer.getSource()).addFeature(clip.bufferGeom);
     this.lidarBuffer.setStyle(clip.bufferStyle);
 
     const span = domainX[1] - domainX[0];

diff --git a/contribs/gmf/src/lidarprofile/Plot.js b/contribs/gmf/src/lidarprofile/Plot.js
@@ -343,7 +343,7 @@ export default class {
 
       this.manager_.cartoHighlight.setElement(el);
       this.manager_.cartoHighlight.setPosition([p.coords[0], p.coords[1]]);
-      this.manager_.lidarPointHighlight.getSource().clear();
+      /** @type {olSourceVector} */(this.manager_.lidarPointHighlight.getSource()).clear();
       const lidarPointGeom = new olGeomPoint([p.coords[0], p.coords[1]]);
       const lidarPointFeature = new olFeature(lidarPointGeom);
       if (typeof (pointClassification.color) !== undefined) {
@@ -358,9 +358,9 @@ export default class {
         }));
       }
 
-      this.manager_.lidarPointHighlight.getSource().addFeature(lidarPointFeature);
+      /** @type {olSourceVector} */(this.manager_.lidarPointHighlight.getSource()).addFeature(lidarPointFeature);
     } else {
-      this.manager_.lidarPointHighlight.getSource().clear();
+      /** @type {olSourceVector} */(this.manager_.lidarPointHighlight.getSource()).clear();
       svg.select('#highlightCircle').remove();
       lidarInfo.html('');
       this.manager_.cartoHighlight.setPosition(undefined);

diff --git a/contribs/gmf/src/mobile/measure/areaComponent.js b/contribs/gmf/src/mobile/measure/areaComponent.js
@@ -40,7 +40,7 @@ module.run(/* @ngInject */ ($templateCache) => {
  * or deactivate the component.
  * @htmlAttribute {number=} gmf-mobile-measurearea-precision the number of significant digits to display.
  * @htmlAttribute {import("ol/Map.js").default} gmf-mobile-measurearea-map The map.
- * @htmlAttribute {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction=}
+ * @htmlAttribute {import("ol/style/Style.js").StyleLike=}
  *     gmf-mobile-measurearea-sketchstyle A style for the measure area.
  * @param {string|function(!JQuery=, !angular.IAttributes=)}
  *     gmfMobileMeasureAreaTemplateUrl Template URL for the directive.

diff --git a/contribs/gmf/src/mobile/measure/baseComponent.js b/contribs/gmf/src/mobile/measure/baseComponent.js
@@ -66,7 +66,7 @@ export function MeasueMobileBaseController($scope, $filter, gettextCatalog) {
   this.precision;
 
   /**
-   * @type {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction}
+   * @type {import("ol/style/Style.js").StyleLike}
    * @export
    */
   this.sketchStyle = new olStyleStyle({

diff --git a/contribs/gmf/src/mobile/measure/lengthComponent.js b/contribs/gmf/src/mobile/measure/lengthComponent.js
@@ -40,7 +40,7 @@ module.run(/* @ngInject */ ($templateCache) => {
  * or deactivate the component.
  * @htmlAttribute {number=} gmf-mobile-measurelength-precision the number of significant digits to display.
  * @htmlAttribute {import("ol/Map.js").default} gmf-mobile-measurelength-map The map.
- * @htmlAttribute {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction=}
+ * @htmlAttribute {import("ol/style/Style.js").StyleLike=}
  *     gmf-mobile-measurelength-sketchstyle A style for the measure length.
  * @param {string|function(!JQuery=, !angular.IAttributes=)}
  *     gmfMobileMeasureLengthTemplateUrl Template URL for the directive.

diff --git a/contribs/gmf/src/mobile/measure/pointComponent.js b/contribs/gmf/src/mobile/measure/pointComponent.js
@@ -61,7 +61,7 @@ module.run(/* @ngInject */ ($templateCache) => {
  *     gmf-mobile-measurepoint-layersconfig Raster elevation layers to get
  *     information under the point and its configuaration.
  * @htmlAttribute {import("ol/Map.js").default} gmf-mobile-measurepoint-map The map.
- * @htmlAttribute {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction=}
+ * @htmlAttribute {import("ol/style/Style.js").StyleLike=}
  *     gmf-mobile-measurepoint-sketchstyle A style for the measure point.
  * @param {string|function(!JQuery=, !angular.IAttributes=)}
  *     gmfMobileMeasurePointTemplateUrl Template URL for the directive.
@@ -170,7 +170,7 @@ function Controller(gettextCatalog, $scope, $filter, gmfRaster, ngeoDebounce) {
   this.layersConfig;
 
   /**
-   * @type {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction}
+   * @type {import("ol/style/Style.js").StyleLike}
    * @export
    */
   this.sketchStyle;
@@ -229,7 +229,7 @@ function Controller(gettextCatalog, $scope, $filter, gmfRaster, ngeoDebounce) {
  */
 Controller.prototype.init = function() {
   this.measure = new ngeoInteractionMeasurePointMobile(
-    /** @type {numberCoordinates} */ (this.$filter_('ngeoNumberCoordinates')),
+    /** @type {import('ngeo/misc/filters.js').numberCoordinates} */ (this.$filter_('ngeoNumberCoordinates')),
     this.format || '{x}, {y}',
     {
       decimals: this.coordinateDecimals,

diff --git a/examples/elevationProfile.js b/examples/elevationProfile.js
@@ -81,7 +81,7 @@ function MainController($http, $scope) {
   });
 
   this.snappedPoint_ = new olFeature();
-  vectorLayer.getSource().addFeature(this.snappedPoint_);
+  /** @type {olSourceVector} */(vectorLayer.getSource()).addFeature(this.snappedPoint_);
 
   // Use vectorLayer.setMap(map) rather than map.addLayer(vectorLayer). This
   // makes the vector layer "unmanaged", meaning that it is always on top.

diff --git a/examples/modifycircle.js b/examples/modifycircle.js
@@ -85,7 +85,7 @@ function MainController() {
    * @export
    */
   this.interaction = new ngeoInteractionModifyCircle(
-    /** @type {olx.interaction.ModifyOptions} */({
+    /** @type {import('ol/interaction/Modify.js').Options} */({
       features: this.features
     }));
 

diff --git a/examples/modifyrectangle.js b/examples/modifyrectangle.js
@@ -127,7 +127,7 @@ function MainController() {
    * @export
    */
   this.interaction = new ngeoInteractionModifyRectangle(
-    /** @type {olx.interaction.ModifyOptions} */({
+    /** @type {import('ol/interaction/Modify.js').Options} */({
       features: this.features,
       style: style
     }));

diff --git a/examples/permalink.js b/examples/permalink.js
@@ -178,7 +178,7 @@ function DrawComponentController($scope, ngeoLocation) {
 }
 
 DrawComponentController.prototype.$onInit = function() {
-  const vectorSource = this.layer.getSource();
+  const vectorSource = /** @type {olSourceVector} */(this.layer.getSource());
 
   this.interaction = new olInteractionDraw({
     type: /** @type {import("ol/geom/GeometryType.js").default} */ ('LineString'),
@@ -226,7 +226,7 @@ DrawComponentController.prototype.$onInit = function() {
  * @export
  */
 DrawComponentController.prototype.clearLayer = function() {
-  this.layer.getSource().clear(true);
+  /** @type {olSourceVector} */(this.layer.getSource()).clear(true);
   this.featureSeq_ = 0;
   this.ngeoLocation_.deleteParam('features');
 };

diff --git a/examples/rotate.js b/examples/rotate.js
@@ -127,7 +127,7 @@ function MainController() {
    * @export
    */
   this.interaction = new ngeoInteractionRotate(
-    /** @type {olx.interaction.ModifyOptions} */({
+    /** @type {import('ol/interaction/Modify.js').Options} */({
       features: this.features,
       layers: [vectorLayer],
       style: style

diff --git a/src/draw/Controller.js b/src/draw/Controller.js
@@ -169,7 +169,7 @@ DrawController.prototype.handleActiveChange = function(event) {
  * Called when a feature is finished being drawn. Set the default properties
  * for its style, then set its style and add it to the features collection.
  * @param {string} type Type of geometry being drawn.
- * @param {import("ol/interaction/Draw/Event.js").default|MeasureEvent} event Event.
+ * @param {import('ol/events/Event.js').default|MeasureEvent} event Event.
  * @export
  */
 DrawController.prototype.handleDrawEnd = function(type, event) {

diff --git a/src/editing/createfeatureComponent.js b/src/editing/createfeatureComponent.js
@@ -254,7 +254,7 @@ Controller.prototype.$onInit = function() {
 /**
  * Called when a feature is finished being drawn. Add the feature to the
  * collection.
- * @param {import("ol/interaction/Draw/Event.js").default|MeasureEvent} event Event.
+ * @param {import('ol/events/Event.js').default|MeasureEvent} event Event.
  * @export
  */
 Controller.prototype.handleDrawEnd_ = function(event) {

diff --git a/src/editing/createregularpolygonfromclickComponent.js b/src/editing/createregularpolygonfromclickComponent.js
@@ -172,7 +172,7 @@ Controller.prototype.$onInit = function() {
 /**
  * Called when a feature is finished being drawn. Add the feature to the
  * collection.
- * @param {import("ol/interaction/Draw/Event.js").default} evt Event.
+ * @param {import('ol/events/Event.js').default} evt Event.
  * @private
  */
 Controller.prototype.handleDrawEnd_ = function(evt) {

diff --git a/src/geolocation/desktop.js b/src/geolocation/desktop.js
@@ -12,9 +12,9 @@ import olGeomPoint from 'ol/geom/Point.js';
  * Options for the mobile geolocations directive.
  *
  * @typedef {Object} DesktopGeolocationDirectiveOptions
- * @property {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction} [accuracyFeatureStyle] The style to
+ * @property {import("ol/style/Style.js").StyleLike} [accuracyFeatureStyle] The style to
  * use to sketch the accuracy feature, which is a regular polygon.
- * @property {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction} [positionFeatureStyle] The style to
+ * @property {import("ol/style/Style.js").StyleLike} [positionFeatureStyle] The style to
  * use to sketch the position feature, which is a point.
  * @property {number} [zoom] If set, in addition to recentering the map view at the location, determines
  * the zoom level to set when obtaining a new position.

diff --git a/src/geolocation/mobile.js b/src/geolocation/mobile.js
@@ -13,9 +13,9 @@ import olGeomPoint from 'ol/geom/Point.js';
  * Options for the mobile geolocations directive.
  *
  * @typedef {Object} MobileGeolocationDirectiveOptions
- * @property {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction} [accuracyFeatureStyle] The style to
+ * @property {import("ol/style/Style.js").StyleLike} [accuracyFeatureStyle] The style to
  * use to sketch the accuracy feature, which is a regular polygon.
- * @property {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|import('ol/style/Style.js').StyleFunction} [positionFeatureStyle] The style to
+ * @property {import("ol/style/Style.js").StyleLike} [positionFeatureStyle] The style to
  * use to sketch the position feature, which is a point.
  * @property {number} [zoom] If set, in addition to recentering the map view at the location, determines
  * the zoom level to set when obtaining a new position

diff --git a/src/googlestreetview/component.js b/src/googlestreetview/component.js
@@ -74,8 +74,7 @@ class Controller {
 
     /**
      * Style for the feature.
-     * @type {import("ol/style/Style.js").default|Array.<import("ol/style/Style.js").default>|
-     *     ol.FeatureStyleFunction|ol.StyleFunction|undefined}
+     * @type {import("ol/style/Style.js").StyleLike|undefined}
      * @export
      */
     this.featureStyle;