From 3365576548c997cc3cd9f25a31f0908524c73b35 Mon Sep 17 00:00:00 2001 From: Simon Seyock Date: Wed, 23 Jun 2021 12:57:20 +0200 Subject: [PATCH] Add `PluggableMap`. --- src/ol/MapBrowserEventType.js | 4 ++++ src/ol/MapEventType.js | 4 ++++ src/ol/PluggableMap.js | 15 ++++++++++----- src/ol/render/EventType.js | 8 ++++++++ 4 files changed, 26 insertions(+), 5 deletions(-) diff --git a/src/ol/MapBrowserEventType.js b/src/ol/MapBrowserEventType.js index d345607821..c5f4d1053e 100644 --- a/src/ol/MapBrowserEventType.js +++ b/src/ol/MapBrowserEventType.js @@ -53,3 +53,7 @@ export default { POINTERLEAVE: 'pointerleave', POINTERCANCEL: 'pointercancel', }; + +/*** + * @typedef {'singleclick'|'click'|'dblclick'|'pointerdrag'|'pointermove'} Types + */ diff --git a/src/ol/MapEventType.js b/src/ol/MapEventType.js index 1f919c3e38..08ac0645c2 100644 --- a/src/ol/MapEventType.js +++ b/src/ol/MapEventType.js @@ -27,3 +27,7 @@ export default { */ MOVEEND: 'moveend', }; + +/*** + * @typedef {'postrender'|'movestart'|'moveend'} Types + */ diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 9c3b94320d..ba99bf7cf7 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -127,11 +127,6 @@ import {removeNode} from './dom.js'; */ /** - * @fires import("./MapBrowserEvent.js").MapBrowserEvent - * @fires import("./MapEvent.js").MapEvent - * @fires import("./render/Event.js").default#precompose - * @fires import("./render/Event.js").default#postcompose - * @fires import("./render/Event.js").default#rendercomplete * @api */ class PluggableMap extends BaseObject { @@ -141,6 +136,16 @@ class PluggableMap extends BaseObject { constructor(options) { super(); + /*** + * @type {import("./Observable").OnSignature & + * import("./Observable").OnSignature & + * import("./Observable").OnSignature & + * import("./Observable").OnSignature & + * import("./Observable").OnSignature} + */ + this.on; + const optionsInternal = createOptionsInternal(options); /** @private */ diff --git a/src/ol/render/EventType.js b/src/ol/render/EventType.js index 691e4eb222..adf099b50e 100644 --- a/src/ol/render/EventType.js +++ b/src/ol/render/EventType.js @@ -45,3 +45,11 @@ export default { */ RENDERCOMPLETE: 'rendercomplete', }; + +/** + * @typedef {'postrender'|'precompose'|'postcompose'|'rendercomplete'} MapRenderEventTypes + */ + +/** + * @typedef {MapRenderEventTypes|'prerender'} RenderEventTypes + */