Add CombinedOnSignature.

This commit is contained in:
Simon Seyock
2021-06-23 17:29:33 +02:00
committed by Andreas Hocevar
parent 25a095e489
commit 1870a64984
25 changed files with 85 additions and 32 deletions

View File

@@ -74,7 +74,8 @@ class Collection extends BaseObject {
/*** /***
* @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> & * @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> &
* import("./Observable").OnSignature<import("./ObjectEventType").Types|'change:length', import("./Object").ObjectEvent> & * import("./Observable").OnSignature<import("./ObjectEventType").Types|'change:length', import("./Object").ObjectEvent> &
* import("./Observable").OnSignature<'add'|'remove', CollectionEvent>} * import("./Observable").OnSignature<'add'|'remove', CollectionEvent> &
* import("./Observable").CombinedOnSignature<import("./Observable").EventTypes|import("./ObjectEventType").Types|'change:length'|'add'|'remove'>}
*/ */
this.on; this.on;

View File

@@ -71,7 +71,8 @@ class Feature extends BaseObject {
/*** /***
* @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> & * @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> &
* import("./Observable").OnSignature<import("./ObjectEventType").Types|'change:geometry', import("./Object").ObjectEvent>} * import("./Observable").OnSignature<import("./ObjectEventType").Types|'change:geometry', import("./Object").ObjectEvent> &
* import("./Observable").CombinedOnSignature<import("./Observable").EventTypes|import("./ObjectEventType").Types|'change:geometry'>}
*/ */
this.on; this.on;

View File

@@ -61,6 +61,12 @@ class GeolocationError extends BaseEvent {
* is reported in. * 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 * @classdesc
* Helper class for providing HTML5 Geolocation capabilities. * Helper class for providing HTML5 Geolocation capabilities.
@@ -92,10 +98,10 @@ class Geolocation extends BaseObject {
super(); super();
/*** /***
* @type {import("./Observable").OnSignature<import("./ObjectEventType").Types| * @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> &
* 'change:accuracy'|'change:accuracyGeometry'|'change:altitude'|'change:altitudeAccuracy'|'change:heading'| * import("./Observable").OnSignature<GeolocationObjectEventTypes, import("./Object").ObjectEvent> &
* 'change:position'|'change:projection'|'change:speed'|'change:tracking'|'change:trackingOptions', import("./Object").ObjectEvent> & * import("./Observable").OnSignature<'error', GeolocationError> &
* import("./Observable").OnSignature<'error', GeolocationError>} * import("./Observable").CombinedOnSignature<import("./Observable").EventTypes|GeolocationObjectEventTypes|'error'>}
*/ */
this.on; this.on;

View File

@@ -89,7 +89,8 @@ class BaseObject extends Observable {
/*** /***
* @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> & * @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> &
* import("./Observable").OnSignature<import("./ObjectEventType").Types, ObjectEvent>} * import("./Observable").OnSignature<import("./ObjectEventType").Types, ObjectEvent> &
* import("./Observable").CombinedOnSignature<import("./Observable").EventTypes|import("./ObjectEventType").Types>}
*/ */
this.on; this.on;

View File

@@ -7,7 +7,7 @@ import {listen, listenOnce, unlistenByKey} from './events.js';
/*** /***
* @template {string} Type * @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<import("./events").EventsKey>} OnSignature * @typedef {(type: Type|Type[], listener: (event: EventClass) => (void|boolean)) => import("./events").EventsKey|Array<import("./events").EventsKey>} OnSignature
*/ */

View File

@@ -83,6 +83,11 @@ const Property = {
POSITIONING: 'positioning', POSITIONING: 'positioning',
}; };
/**
* @typedef {import("./ObjectEventType").Types|'change:element'|'change:map'|'change:offset'|'change:position'|
* 'change:positioning'} OverlayObjectEventTypes
*/
/** /**
* @classdesc * @classdesc
* An element to be displayed over the map and attached to a single map * 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").EventTypes, import("./events/Event.js").default> & * @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> &
* import("./Observable").OnSignature<import("./ObjectEventType").Types| * import("./Observable").OnSignature<OverlayObjectEventTypes, import("./Object").ObjectEvent> &
* 'change:element'|'change:map'|'change:offset'|'change:position'|'change:positioning', import("./Object").ObjectEvent>} * import("./Observable").CombinedOnSignature<import("./Observable").EventTypes|OverlayObjectEventTypes>}
*/ */
this.on; this.on;

View File

@@ -86,6 +86,10 @@ import {removeNode} from './dom.js';
* @property {Object<string, *>} values Values. * @property {Object<string, *>} values Values.
*/ */
/**
* @typedef {import("./ObjectEventType").Types|'change:layergroup'|'change:size'|'change:target'|'change:view'} MapObjectEventTypes
*/
/** /**
* Object literal with config options for the map. * Object literal with config options for the map.
* @typedef {Object} MapOptions * @typedef {Object} MapOptions
@@ -138,11 +142,12 @@ class PluggableMap extends BaseObject {
/*** /***
* @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> & * @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> &
* import("./Observable").OnSignature<import("./ObjectEventType").Types| * import("./Observable").OnSignature<MapObjectEventTypes, import("./Object").ObjectEvent> &
* 'change:layergroup'|'change:size'|'change:target'|'change:view', import("./Object").ObjectEvent> &
* import("./Observable").OnSignature<import("./MapBrowserEventType").Types, import("./MapBrowserEvent").default> & * import("./Observable").OnSignature<import("./MapBrowserEventType").Types, import("./MapBrowserEvent").default> &
* import("./Observable").OnSignature<import("./MapEventType").Types, import("./MapEvent").default> & * import("./Observable").OnSignature<import("./MapEventType").Types, import("./MapEvent").default> &
* import("./Observable").OnSignature<import("./render/EventType").MapRenderEventTypes, import("./render/Event").default>} * import("./Observable").OnSignature<import("./render/EventType").MapRenderEventTypes, import("./render/Event").default> &
* import("./Observable").CombinedOnSignature<import("./Observable").EventTypes|MapObjectEventTypes|
* import("./MapBrowserEventType").Types|import("./MapEventType").Types|import("./render/EventType").MapRenderEventTypes>}
*/ */
this.on; this.on;

View File

@@ -218,6 +218,10 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js';
*/ */
const DEFAULT_MIN_ZOOM = 0; const DEFAULT_MIN_ZOOM = 0;
/**
* @typedef {import("./ObjectEventType").Types|'change:center'|'change:resolution'|'change:rotation'} ViewObjectEventTypes
*/
/** /**
* @classdesc * @classdesc
* A View object represents a simple 2D view of the map. * 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").EventTypes, import("./events/Event.js").default> & * @type {import("./Observable").OnSignature<import("./Observable").EventTypes, import("./events/Event.js").default> &
* import("./Observable").OnSignature<import("./ObjectEventType").Types| * import("./Observable").OnSignature<ViewObjectEventTypes, import("./Object").ObjectEvent> &
* 'change:center'|'change:resolution'|'change:rotation', import("./Object").ObjectEvent>} * import("./Observable").CombinedOnSignature<import("./Observable").EventTypes|ViewObjectEventTypes>}
*/ */
this.on; this.on;

View File

@@ -83,7 +83,9 @@ class FullScreen extends Control {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes| * @type {import("../Observable").OnSignature<import("../Observable").EventTypes|
* 'enterfullscreen'|'leavefullscreen', import("../events/Event.js").default> & * 'enterfullscreen'|'leavefullscreen', import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent>} * import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|
* 'enterfullscreen'|'leavefullscreen'|import("../ObjectEventType").Types>}
*/ */
this.on; this.on;

View File

@@ -71,7 +71,9 @@ class MousePosition extends Control {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:coordinateFormat'|'change:projection', import("../Object").ObjectEvent>} * 'change:coordinateFormat'|'change:projection', import("../Object").ObjectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:coordinateFormat'|'change:projection'>}
*/ */
this.on; this.on;

View File

@@ -93,7 +93,8 @@ class ScaleLine extends Control {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:units', import("../Object").ObjectEvent>} * 'change:units', import("../Object").ObjectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|'change:units'>}
*/ */
this.on; this.on;

View File

@@ -116,7 +116,9 @@ class DragBox extends PointerInteraction {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> & * 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'boxcancel'|'boxdrag'|'boxend', DragBoxEvent>} * import("../Observable").OnSignature<'boxcancel'|'boxdrag'|'boxend', DragBoxEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'boxcancel'|'boxdrag'|'boxend'>}
*/ */
this.on; this.on;

View File

@@ -197,7 +197,9 @@ class Draw extends PointerInteraction {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> & * 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'drawabort'|'drawend'|'drawstart', DrawEvent>} * import("../Observable").OnSignature<'drawabort'|'drawend'|'drawstart', DrawEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'drawabort'|'drawend'|'drawstart'>}
*/ */
this.on; this.on;

View File

@@ -96,7 +96,9 @@ class Extent extends PointerInteraction {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> & * 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'extentchanged', ExtentEvent>} * import("../Observable").OnSignature<'extentchanged', ExtentEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'extentchanged'>}
*/ */
this.on; this.on;

View File

@@ -39,7 +39,8 @@ class Interaction extends BaseObject {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent>} * 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|'change:active'>}
*/ */
this.on; this.on;

View File

@@ -196,7 +196,9 @@ class Modify extends PointerInteraction {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> & * 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'modifyend'|'modifystart', ModifyEvent>} * import("../Observable").OnSignature<'modifyend'|'modifystart', ModifyEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'modifyend'|'modifystart'>}
*/ */
this.on; this.on;

View File

@@ -160,7 +160,9 @@ class Select extends Interaction {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> & * 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'select', SelectEvent>} * import("../Observable").OnSignature<'select', SelectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'select'>}
*/ */
this.on; this.on;

View File

@@ -130,7 +130,9 @@ class Translate extends PointerInteraction {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types| * import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> & * 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'translateend'|'translatestart'|'translating', TranslateEvent>} * import("../Observable").OnSignature<'translateend'|'translatestart'|'translating', TranslateEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'translateend'|'translatestart'|'translating'>}
*/ */
this.on; this.on;

View File

@@ -54,7 +54,8 @@ class BaseLayer extends BaseObject {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<BaseLayerObjectEventTypes, import("../Object").ObjectEvent>} * import("../Observable").OnSignature<BaseLayerObjectEventTypes, import("../Object").ObjectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|BaseLayerObjectEventTypes>}
*/ */
this.on; this.on;

View File

@@ -65,7 +65,9 @@ class BaseTileLayer extends Layer {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes| * import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes|
* 'change:source'|'change:preload'|'change:useInterimTilesOnError', import("../Object").ObjectEvent> & * 'change:source'|'change:preload'|'change:useInterimTilesOnError', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default>} * import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("./Base").BaseLayerObjectEventTypes|
* 'change:source'|'change:preload'|'change:useInterimTilesOnError'|import("../render/EventType").LayerRenderEventTypes>}
*/ */
this.on; this.on;

View File

@@ -100,7 +100,9 @@ class Layer extends BaseLayer {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes| * import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes|
* 'change:source', import("../Object").ObjectEvent> & * 'change:source', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default>} * import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("./Base").BaseLayerObjectEventTypes|'change:source'|
* import("../render/EventType").LayerRenderEventTypes>}
*/ */
this.on; this.on;

View File

@@ -99,7 +99,9 @@ class VectorTileLayer extends BaseVectorLayer {
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes| * import("../Observable").OnSignature<import("./Base").BaseLayerObjectEventTypes|
* 'change:source'|'change:preload'|'change:useInterimTilesOnError', import("../Object").ObjectEvent> & * 'change:source'|'change:preload'|'change:useInterimTilesOnError', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default>} * import("../Observable").OnSignature<import("../render/EventType").LayerRenderEventTypes, import("../render/Event").default> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("./Base").BaseLayerObjectEventTypes|
* 'change:source'|'change:preload'|'change:useInterimTilesOnError'|import("../render/EventType").LayerRenderEventTypes>}
*/ */
this.on; this.on;

View File

@@ -96,7 +96,8 @@ class ImageSource extends Source {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> & * import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<ImageSourceEventTypes, ImageSourceEvent>} * import("../Observable").OnSignature<ImageSourceEventTypes, ImageSourceEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|ImageSourceEventTypes>}
*/ */
this.on; this.on;

View File

@@ -55,7 +55,9 @@ class TileSource extends Source {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> & * import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("./TileEventType").TileSourceEventTypes, TileSourceEvent>} * import("../Observable").OnSignature<import("./TileEventType").TileSourceEventTypes, TileSourceEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* import("./TileEventType").TileSourceEventTypes>}
*/ */
this.on; this.on;

View File

@@ -180,7 +180,9 @@ class VectorSource extends Source {
/*** /***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> & * @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> & * import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<import("./VectorEventType").VectorSourceEventTypes, VectorSourceEvent>} * import("../Observable").OnSignature<import("./VectorEventType").VectorSourceEventTypes, VectorSourceEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* import("./VectorEventType").VectorSourceEventTypes>}
*/ */
this.on; this.on;