Revert "Merge pull request #12416 from ahocevar/eventtype-generics"

This reverts commit b6c143deb2, reversing
changes made to 7777821df5.
This commit is contained in:
Simon Seyock
2021-06-21 17:20:04 +02:00
committed by Andreas Hocevar
parent a2f441715b
commit c8f43050c4
30 changed files with 7 additions and 49 deletions

View File

@@ -59,7 +59,7 @@ export class CollectionEvent extends Event {
* Collection as a whole.
*
* @fires CollectionEvent
* @extends BaseObject<'add'|'remove'|'change:length'>
*
* @template T
* @api
*/

View File

@@ -58,7 +58,6 @@ import {listen, unlistenByKey} from './events.js';
*
* @api
* @template {import("./geom/Geometry.js").default} Geometry
* @extends BaseObject<'change:geometry'>
*/
class Feature extends BaseObject {
/**

View File

@@ -82,7 +82,6 @@ class GeolocationError extends BaseEvent {
* });
*
* @fires module:ol/events/Event~BaseEvent#event:error
* @extends BaseObject<'change:accuracy'|'change:accuracyGeometry'|'change:altitude'|'change:altitudeAccuracy'|'change:heading'|'change:position'|'change:projection'|'change:speed'|'change:tracking'|'change:trackingOptions'>
* @api
*/
class Geolocation extends BaseObject {

View File

@@ -78,8 +78,6 @@ export class ObjectEvent extends Event {
* object.unset('foo').
*
* @fires ObjectEvent
* @template {string} EventTypes
* @extends Observable<'propertychange'|EventTypes>
* @api
*/
class BaseObject extends Observable {

View File

@@ -5,11 +5,6 @@ import EventTarget from './events/Target.js';
import EventType from './events/EventType.js';
import {listen, listenOnce, unlistenByKey} from './events.js';
/**
* @template ChildTypes
* @typedef {ChildTypes|'change'|'error'|Array<ChildTypes|'change'|'error'>} EventTypes
*/
/**
* @classdesc
* Abstract base class; normally only used for creating subclasses and not
@@ -19,7 +14,6 @@ import {listen, listenOnce, unlistenByKey} from './events.js';
* {@link module:ol/Observable~Observable#changed}.
*
* @fires import("./events/Event.js").default
* @template {string} ChildTypes
* @api
*/
class Observable extends EventTarget {
@@ -54,7 +48,7 @@ class Observable extends EventTarget {
/**
* Listen for a certain type of event.
* @param {EventTypes<ChildTypes>} type The event type or array of event types.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {import("./events.js").EventsKey|Array<import("./events.js").EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
@@ -76,7 +70,7 @@ class Observable extends EventTarget {
/**
* Listen once for a certain type of event.
* @param {EventTypes<ChildTypes>} type The event type or array of event types.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {import("./events.js").EventsKey|Array<import("./events.js").EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
@@ -100,7 +94,7 @@ class Observable extends EventTarget {
/**
* Unlisten for a certain type of event.
* @param {EventTypes<ChildTypes>} type The event type or array of event types.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @api
*/

View File

@@ -101,7 +101,6 @@ const Property = {
* popup.setPosition(coordinate);
* map.addOverlay(popup);
*
* @extends BaseObject<'change:element'|'change:map'|'change:offset'|'change:position'|'change:positioning'>
* @api
*/
class Overlay extends BaseObject {

View File

@@ -132,7 +132,6 @@ import {removeNode} from './dom.js';
* @fires import("./render/Event.js").default#precompose
* @fires import("./render/Event.js").default#postcompose
* @fires import("./render/Event.js").default#rendercomplete
* @extends BaseObject<'change:layergroup'|'change:size'|'change:target'|'change:view'|'precompose'|'singleclick'|'click'|'dblclick'|'pointerdrag'|'pointermove'|'postrender'|'movestart'|'moveend'|'postcompose'|'rendercomplete'>
* @api
*/
class PluggableMap extends BaseObject {

View File

@@ -288,7 +288,6 @@ const DEFAULT_MIN_ZOOM = 0;
* the snap angle is 0), an animation will be triggered at the interaction end to
* put back the view to a stable state;
*
* @extends BaseObject<'change:center'|'change:resolution'|'change:rotation'>
* @api
*/
class View extends BaseObject {

View File

@@ -41,8 +41,6 @@ import {removeNode} from '../dom.js';
* You can also extend this base for your own control class. See
* examples/custom-controls for an example of how to do this.
*
* @template {string} EventTypes
* @extends BaseObject<EventTypes>
* @api
*/
class Control extends BaseObject {

View File

@@ -66,7 +66,6 @@ const FullScreenEventType = {
*
* @fires FullScreenEventType#enterfullscreen
* @fires FullScreenEventType#leavefullscreen
* @extends Control<'enterfullscreen'|'leavefullscreen'>
* @api
*/
class FullScreen extends Control {

View File

@@ -49,7 +49,6 @@ const COORDINATE_FORMAT = 'coordinateFormat';
* On touch devices, which usually do not have a mouse cursor, the coordinates
* of the currently touched position are shown.
*
* @extends Control<'change:coordinaetFormat'|'change:projection'>
* @api
*/
class MousePosition extends Control {

View File

@@ -68,7 +68,6 @@ const DEFAULT_DPI = 25.4 / 0.28;
* When specifying `bar` as `true`, a scalebar will be rendered instead
* of a scaleline.
*
* @extends Control<'change:units'>
* @api
*/
class ScaleLine extends Control {

View File

@@ -82,7 +82,6 @@ export class DragAndDropEvent extends Event {
* combinnation of formats read both text string and ArrayBuffer sources. Older browsers such
* as IE which do not support this will need a TextDecoder polyfill to be loaded before use.
*
* @extends Interaction<'addfeatures'>
* @api
*
* @fires DragAndDropEvent

View File

@@ -103,7 +103,6 @@ export class DragBoxEvent extends Event {
* {@link module:ol/interaction/DragRotateAndZoom}).
*
* @fires DragBoxEvent
* @extends PointerInteraction<'boxcancel'|'boxdrag'|'boxend'>
* @api
*/
class DragBox extends PointerInteraction {

View File

@@ -177,7 +177,6 @@ export class DrawEvent extends Event {
* Interaction for drawing feature geometries.
*
* @fires DrawEvent
* @extends PointerInteraction<'drawabort'|'drawend'|'drawstart'>
* @api
*/
class Draw extends PointerInteraction {

View File

@@ -81,7 +81,6 @@ export class ExtentEvent extends Event {
* This interaction is only supported for mouse devices.
*
* @fires ExtentEvent
* @extends PointerInteraction<'extentchanged'>
* @api
*/
class Extent extends PointerInteraction {

View File

@@ -27,9 +27,6 @@ import {easeOut, linear} from '../easing.js';
* by a keyboard event not a button element event.
* Although interactions do not have a DOM element, some of them do render
* vectors and so are visible on the screen.
*
* @template {string} EventTypes
* @extends BaseObject<EventTypes|'change:active'>
* @api
*/
class Interaction extends BaseObject {

View File

@@ -183,7 +183,6 @@ export class ModifyEvent extends Event {
* key is pressed. To configure the interaction with a different condition
* for deletion, use the `deleteCondition` option.
* @fires ModifyEvent
* @extends PointerInteraction<'modifyend'|'modifystart'>
* @api
*/
class Modify extends PointerInteraction {

View File

@@ -41,9 +41,6 @@ import {getValues} from '../obj.js';
* started. During a drag sequence the `handleDragEvent` user function is
* called on `move` events. The drag sequence ends when the `handleUpEvent`
* user function is called and returns `false`.
*
* @template {string} EventTypes
* @extends Interaction<EventTypes>
* @api
*/
class PointerInteraction extends Interaction {

View File

@@ -147,7 +147,6 @@ const originalFeatureStyles = {};
* Selected features are added to an internal unmanaged layer.
*
* @fires SelectEvent
* @extends Interaction<'select'>
* @api
*/
class Select extends Interaction {

View File

@@ -115,7 +115,6 @@ export class TranslateEvent extends Event {
* Interaction for translating (moving) features.
*
* @fires TranslateEvent
* @extends PointerInteraction<'translateend'|'translatestart'|'translating'>
* @api
*/
class Translate extends PointerInteraction {

View File

@@ -38,8 +38,6 @@ import {clamp} from '../math.js';
* the options is set as a {@link module:ol/Object} property on the layer object, so
* is observable, and has get/set accessors.
*
* @template {string} EventTypes
* @extends BaseObject<EventTypes|'change:extent'|'change:maxResolution'|'change:maxZoom'|'change:minResolution'|'change:minZoom'|'change:opacity'|'change:visible'|'change:zIndex'>
* @api
*/
class BaseLayer extends BaseObject {

View File

@@ -45,7 +45,7 @@ import {assign} from '../obj.js';
* options means that `title` is observable, and has get/set accessors.
*
* @template {import("../source/Tile.js").default} TileSourceType
* @extends Layer<TileSourceType,'preload'|'useInterimTilesOnError'>
* @extends {Layer<TileSourceType>}
* @api
*/
class BaseTileLayer extends Layer {

View File

@@ -73,8 +73,7 @@ const Property = {
* options means that `title` is observable, and has get/set accessors.
*
* @template {import("../source/Vector.js").default|import("../source/VectorTile.js").default} VectorSourceType
* @template {string} EventTypes
* @extends Layer<VectorSourceType,EventTypes>
* @extends {Layer<VectorSourceType>}
* @api
*/
class BaseVectorLayer extends Layer {

View File

@@ -84,8 +84,6 @@ import {listen, unlistenByKey} from '../events.js';
* @fires import("../render/Event.js").RenderEvent#postrender
*
* @template {import("../source/Source.js").default} SourceType
* @template {string} EventTypes
* @extends BaseLayer<EventTypes|'postrender'|'prerender'>
* @api
*/
class Layer extends BaseLayer {

View File

@@ -75,7 +75,7 @@ import {assign} from '../obj.js';
* options means that `title` is observable, and has get/set accessors.
*
* @param {Options} [opt_options] Options.
* @extends BaseVectorLayer<import("../source/VectorTile.js").default,'change:preload'|'change:useInterimTilesOnError'>
* @extends {BaseVectorLayer<import("../source/VectorTile.js").default>}
* @api
*/
class VectorTileLayer extends BaseVectorLayer {

View File

@@ -76,7 +76,6 @@ export class ImageSourceEvent extends Event {
* Base class for sources providing a single image.
* @abstract
* @fires module:ol/source/Image.ImageSourceEvent
* @extends Source<'imageloadend'|'imageloaderror'|'imageloadstart'>
* @api
*/
class ImageSource extends Source {

View File

@@ -40,8 +40,6 @@ import {get as getProjection} from '../proj.js';
* Base class for {@link module:ol/layer/Layer~Layer} sources.
*
* A generic `change` event is triggered when the state of the source changes.
* @template {string} EventTypes
* @extends BaseObject<EventTypes>
* @abstract
* @api
*/

View File

@@ -36,8 +36,6 @@ import {scale as scaleSize, toSize} from '../size.js';
* Abstract base class; normally only used for creating subclasses and not
* instantiated in apps.
* Base class for sources providing images divided into a tile grid.
* @template {string} EventTypes
* @extends Source<EventTypes>
* @abstract
* @api
*/

View File

@@ -33,7 +33,6 @@ import {getUid} from '../util.js';
* Base class for sources providing tiles divided into a tile grid over http.
*
* @fires import("./Tile.js").TileSourceEvent
* @extends TileSource<'tileloadend'|'tileloaderror'|'tileloadstart'>
*/
class UrlTile extends TileSource {
/**