From 1870a649843ae61e4643ffabb0771d48ca56d53a Mon Sep 17 00:00:00 2001 From: Simon Seyock Date: Wed, 23 Jun 2021 17:29:33 +0200 Subject: [PATCH] Add `CombinedOnSignature`. --- src/ol/Collection.js | 3 ++- src/ol/Feature.js | 3 ++- src/ol/Geolocation.js | 14 ++++++++++---- src/ol/Object.js | 3 ++- src/ol/Observable.js | 2 +- src/ol/Overlay.js | 9 +++++++-- src/ol/PluggableMap.js | 11 ++++++++--- src/ol/View.js | 8 ++++++-- src/ol/control/FullScreen.js | 4 +++- src/ol/control/MousePosition.js | 4 +++- src/ol/control/ScaleLine.js | 3 ++- src/ol/interaction/DragBox.js | 4 +++- src/ol/interaction/Draw.js | 4 +++- src/ol/interaction/Extent.js | 4 +++- src/ol/interaction/Interaction.js | 3 ++- src/ol/interaction/Modify.js | 4 +++- src/ol/interaction/Select.js | 4 +++- src/ol/interaction/Translate.js | 4 +++- src/ol/layer/Base.js | 3 ++- src/ol/layer/BaseTile.js | 4 +++- src/ol/layer/Layer.js | 4 +++- src/ol/layer/VectorTile.js | 4 +++- src/ol/source/Image.js | 3 ++- src/ol/source/Tile.js | 4 +++- src/ol/source/Vector.js | 4 +++- 25 files changed, 85 insertions(+), 32 deletions(-) diff --git a/src/ol/Collection.js b/src/ol/Collection.js index 5b01dfb1a7..194b6d321b 100644 --- a/src/ol/Collection.js +++ b/src/ol/Collection.js @@ -74,7 +74,8 @@ class Collection extends BaseObject { /*** * @type {import("./Observable").OnSignature & * import("./Observable").OnSignature & - * import("./Observable").OnSignature<'add'|'remove', CollectionEvent>} + * import("./Observable").OnSignature<'add'|'remove', CollectionEvent> & + * import("./Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/Feature.js b/src/ol/Feature.js index b56ab71ca7..281b8a45df 100644 --- a/src/ol/Feature.js +++ b/src/ol/Feature.js @@ -71,7 +71,8 @@ class Feature extends BaseObject { /*** * @type {import("./Observable").OnSignature & - * import("./Observable").OnSignature} + * import("./Observable").OnSignature & + * import("./Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/Geolocation.js b/src/ol/Geolocation.js index 470a6362e7..3f497fae2c 100644 --- a/src/ol/Geolocation.js +++ b/src/ol/Geolocation.js @@ -61,6 +61,12 @@ class GeolocationError extends BaseEvent { * is reported in. */ +/** + * @typedef {import("./ObjectEventType").Types|'change:accuracy'|'change:accuracyGeometry'|'change:altitude'| + * 'change:altitudeAccuracy'|'change:heading'|'change:position'|'change:projection'|'change:speed'|'change:tracking'| + * 'change:trackingOptions'} GeolocationObjectEventTypes + */ + /** * @classdesc * Helper class for providing HTML5 Geolocation capabilities. @@ -92,10 +98,10 @@ class Geolocation extends BaseObject { super(); /*** - * @type {import("./Observable").OnSignature & - * import("./Observable").OnSignature<'error', GeolocationError>} + * @type {import("./Observable").OnSignature & + * import("./Observable").OnSignature & + * import("./Observable").OnSignature<'error', GeolocationError> & + * import("./Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/Object.js b/src/ol/Object.js index 72113a10c0..59946fcf0e 100644 --- a/src/ol/Object.js +++ b/src/ol/Object.js @@ -89,7 +89,8 @@ class BaseObject extends Observable { /*** * @type {import("./Observable").OnSignature & - * import("./Observable").OnSignature} + * import("./Observable").OnSignature & + * import("./Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/Observable.js b/src/ol/Observable.js index a95197e441..01a8cc5fa4 100644 --- a/src/ol/Observable.js +++ b/src/ol/Observable.js @@ -7,7 +7,7 @@ import {listen, listenOnce, unlistenByKey} from './events.js'; /*** * @template {string} Type - * @template {import("./events/Event.js").default} EventClass + * @template {Event|import("./events/Event.js").default} EventClass * @typedef {(type: Type|Type[], listener: (event: EventClass) => (void|boolean)) => import("./events").EventsKey|Array} OnSignature */ diff --git a/src/ol/Overlay.js b/src/ol/Overlay.js index 50a0c3b51d..5e9bb5fa17 100644 --- a/src/ol/Overlay.js +++ b/src/ol/Overlay.js @@ -83,6 +83,11 @@ const Property = { POSITIONING: 'positioning', }; +/** + * @typedef {import("./ObjectEventType").Types|'change:element'|'change:map'|'change:offset'|'change:position'| + * 'change:positioning'} OverlayObjectEventTypes + */ + /** * @classdesc * An element to be displayed over the map and attached to a single map @@ -112,8 +117,8 @@ class Overlay extends BaseObject { /*** * @type {import("./Observable").OnSignature & - * import("./Observable").OnSignature} + * import("./Observable").OnSignature & + * import("./Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index ba99bf7cf7..12a55626b4 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -86,6 +86,10 @@ import {removeNode} from './dom.js'; * @property {Object} values Values. */ +/** + * @typedef {import("./ObjectEventType").Types|'change:layergroup'|'change:size'|'change:target'|'change:view'} MapObjectEventTypes + */ + /** * Object literal with config options for the map. * @typedef {Object} MapOptions @@ -138,11 +142,12 @@ class PluggableMap extends BaseObject { /*** * @type {import("./Observable").OnSignature & - * import("./Observable").OnSignature & + * import("./Observable").OnSignature & * import("./Observable").OnSignature & * import("./Observable").OnSignature & - * import("./Observable").OnSignature} + * import("./Observable").OnSignature & + * import("./Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/View.js b/src/ol/View.js index 5d60eb1f52..ca538080de 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -218,6 +218,10 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js'; */ const DEFAULT_MIN_ZOOM = 0; +/** + * @typedef {import("./ObjectEventType").Types|'change:center'|'change:resolution'|'change:rotation'} ViewObjectEventTypes + */ + /** * @classdesc * A View object represents a simple 2D view of the map. @@ -299,8 +303,8 @@ class View extends BaseObject { /*** * @type {import("./Observable").OnSignature & - * import("./Observable").OnSignature} + * import("./Observable").OnSignature & + * import("./Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/control/FullScreen.js b/src/ol/control/FullScreen.js index ec61dadc56..69f6626c6b 100644 --- a/src/ol/control/FullScreen.js +++ b/src/ol/control/FullScreen.js @@ -83,7 +83,9 @@ class FullScreen extends Control { /*** * @type {import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/control/MousePosition.js b/src/ol/control/MousePosition.js index 6da0741a9c..9e059730a2 100644 --- a/src/ol/control/MousePosition.js +++ b/src/ol/control/MousePosition.js @@ -71,7 +71,9 @@ class MousePosition extends Control { /*** * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature} + * 'change:coordinateFormat'|'change:projection', import("../Object").ObjectEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/control/ScaleLine.js b/src/ol/control/ScaleLine.js index 151ee230db..500824ebfd 100644 --- a/src/ol/control/ScaleLine.js +++ b/src/ol/control/ScaleLine.js @@ -93,7 +93,8 @@ class ScaleLine extends Control { /*** * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature} + * 'change:units', import("../Object").ObjectEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/interaction/DragBox.js b/src/ol/interaction/DragBox.js index 1b758a27cc..f4d9448741 100644 --- a/src/ol/interaction/DragBox.js +++ b/src/ol/interaction/DragBox.js @@ -116,7 +116,9 @@ class DragBox extends PointerInteraction { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature<'boxcancel'|'boxdrag'|'boxend', DragBoxEvent>} + * import("../Observable").OnSignature<'boxcancel'|'boxdrag'|'boxend', DragBoxEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/interaction/Draw.js b/src/ol/interaction/Draw.js index 81e9ec4a4e..efff5a60b7 100644 --- a/src/ol/interaction/Draw.js +++ b/src/ol/interaction/Draw.js @@ -197,7 +197,9 @@ class Draw extends PointerInteraction { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature<'drawabort'|'drawend'|'drawstart', DrawEvent>} + * import("../Observable").OnSignature<'drawabort'|'drawend'|'drawstart', DrawEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/interaction/Extent.js b/src/ol/interaction/Extent.js index 1b7301e360..12bfa3f48c 100644 --- a/src/ol/interaction/Extent.js +++ b/src/ol/interaction/Extent.js @@ -96,7 +96,9 @@ class Extent extends PointerInteraction { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature<'extentchanged', ExtentEvent>} + * import("../Observable").OnSignature<'extentchanged', ExtentEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/interaction/Interaction.js b/src/ol/interaction/Interaction.js index caaa0c22b8..14018d73ee 100644 --- a/src/ol/interaction/Interaction.js +++ b/src/ol/interaction/Interaction.js @@ -39,7 +39,8 @@ class Interaction extends BaseObject { /*** * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature} + * 'change:active', import("../Object").ObjectEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/interaction/Modify.js b/src/ol/interaction/Modify.js index 8a5239e504..ae2f25890c 100644 --- a/src/ol/interaction/Modify.js +++ b/src/ol/interaction/Modify.js @@ -196,7 +196,9 @@ class Modify extends PointerInteraction { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature<'modifyend'|'modifystart', ModifyEvent>} + * import("../Observable").OnSignature<'modifyend'|'modifystart', ModifyEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/interaction/Select.js b/src/ol/interaction/Select.js index 77ef66c194..2b08c999f8 100644 --- a/src/ol/interaction/Select.js +++ b/src/ol/interaction/Select.js @@ -160,7 +160,9 @@ class Select extends Interaction { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature<'select', SelectEvent>} + * import("../Observable").OnSignature<'select', SelectEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/interaction/Translate.js b/src/ol/interaction/Translate.js index 9df11cb02d..ae24550198 100644 --- a/src/ol/interaction/Translate.js +++ b/src/ol/interaction/Translate.js @@ -130,7 +130,9 @@ class Translate extends PointerInteraction { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature<'translateend'|'translatestart'|'translating', TranslateEvent>} + * import("../Observable").OnSignature<'translateend'|'translatestart'|'translating', TranslateEvent> & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/layer/Base.js b/src/ol/layer/Base.js index c04d585552..0cb6b4c5aa 100644 --- a/src/ol/layer/Base.js +++ b/src/ol/layer/Base.js @@ -54,7 +54,8 @@ class BaseLayer extends BaseObject { /*** * @type {import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/layer/BaseTile.js b/src/ol/layer/BaseTile.js index ed0e238e7d..2ce0b5ca1a 100644 --- a/src/ol/layer/BaseTile.js +++ b/src/ol/layer/BaseTile.js @@ -65,7 +65,9 @@ class BaseTileLayer extends Layer { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/layer/Layer.js b/src/ol/layer/Layer.js index 3b3c4d89dc..0b2ae86643 100644 --- a/src/ol/layer/Layer.js +++ b/src/ol/layer/Layer.js @@ -100,7 +100,9 @@ class Layer extends BaseLayer { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/layer/VectorTile.js b/src/ol/layer/VectorTile.js index cbb0827623..e0e9f9a2e7 100644 --- a/src/ol/layer/VectorTile.js +++ b/src/ol/layer/VectorTile.js @@ -99,7 +99,9 @@ class VectorTileLayer extends BaseVectorLayer { * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/source/Image.js b/src/ol/source/Image.js index aa032d1a96..354baa9638 100644 --- a/src/ol/source/Image.js +++ b/src/ol/source/Image.js @@ -96,7 +96,8 @@ class ImageSource extends Source { /*** * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/source/Tile.js b/src/ol/source/Tile.js index 330c4929e9..868aa61b65 100644 --- a/src/ol/source/Tile.js +++ b/src/ol/source/Tile.js @@ -55,7 +55,9 @@ class TileSource extends Source { /*** * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on; diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 7172ad102a..346c459730 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -180,7 +180,9 @@ class VectorSource extends Source { /*** * @type {import("../Observable").OnSignature & * import("../Observable").OnSignature & - * import("../Observable").OnSignature} + * import("../Observable").OnSignature & + * import("../Observable").CombinedOnSignature} */ this.on;