ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add signatures for once.

Browse Source
This commit is contained in:
Simon Seyock
2021-06-23 18:47:14 +02:00
committed by Andreas Hocevar
parent 1870a64984
commit d914006d51
25 changed files with 364 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/interaction/DragBox.js
+15 -6
View File
@@ -93,6 +93,15 @@ export class DragBoxEvent extends Event {
}
}
/***
* @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'boxcancel'|'boxdrag'|'boxend', DragBoxEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'boxcancel'|'boxdrag'|'boxend'>} DragBoxOnSignature
*/
/**
* @classdesc
* Allows the user to draw a vector box by clicking and dragging on the map,
@@ -113,15 +122,15 @@ class DragBox extends PointerInteraction {
super();
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'boxcancel'|'boxdrag'|'boxend', DragBoxEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'boxcancel'|'boxdrag'|'boxend'>}
* @type {DragBoxOnSignature}
*/
this.on;
/***
* @type {DragBoxOnSignature}
*/
this.once;
const options = opt_options ? opt_options : {};
/**
src/ol/interaction/Draw.js
+15 -6
View File
@@ -172,6 +172,15 @@ export class DrawEvent extends Event {
}
}
/***
* @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'drawabort'|'drawend'|'drawstart', DrawEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'drawabort'|'drawend'|'drawstart'>} DrawOnSignature
*/
/**
* @classdesc
* Interaction for drawing feature geometries.
@@ -194,15 +203,15 @@ class Draw extends PointerInteraction {
super(pointerOptions);
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'drawabort'|'drawend'|'drawstart', DrawEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'drawabort'|'drawend'|'drawstart'>}
* @type {DrawOnSignature}
*/
this.on;
/***
* @type {DrawOnSignature}
*/
this.once;
/**
* @type {boolean}
* @private
src/ol/interaction/Extent.js
+15 -6
View File
@@ -74,6 +74,15 @@ export class ExtentEvent extends Event {
}
}
/***
* @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'extentchanged', ExtentEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'extentchanged'>} ExtentOnSignature
*/
/**
* @classdesc
* Allows the user to draw a vector box by clicking and dragging on the map.
@@ -93,15 +102,15 @@ class Extent extends PointerInteraction {
super(/** @type {import("./Pointer.js").Options} */ (options));
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'extentchanged', ExtentEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'extentchanged'>}
* @type {ExtentOnSignature}
*/
this.on;
/***
* @type {ExtentOnSignature}
*/
this.once;
/**
* Condition
* @type {import("../events/condition.js").Condition}
src/ol/interaction/Interaction.js
+14 -4
View File
@@ -5,6 +5,14 @@ import BaseObject from '../Object.js';
import InteractionProperty from './Property.js';
import {easeOut, linear} from '../easing.js';
/***
* @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'>} InteractionOnSignature
*/
/**
* Object literal with config options for interactions.
* @typedef {Object} InteractionOptions
@@ -37,13 +45,15 @@ class Interaction extends BaseObject {
super();
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|'change:active'>}
* @type {InteractionOnSignature}
*/
this.on;
/***
* @type {InteractionOnSignature}
*/
this.once;
if (opt_options && opt_options.handleEvent) {
this.handleEvent = opt_options.handleEvent;
}
src/ol/interaction/Modify.js
+15 -6
View File
@@ -164,6 +164,15 @@ export class ModifyEvent extends Event {
}
}
/***
* @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'modifyend'|'modifystart', ModifyEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'modifyend'|'modifystart'>} ModifyOnSignature
*/
/**
* @classdesc
* Interaction for modifying feature geometries. To modify features that have
@@ -193,15 +202,15 @@ class Modify extends PointerInteraction {
super(/** @type {import("./Pointer.js").Options} */ (options));
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'modifyend'|'modifystart', ModifyEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'modifyend'|'modifystart'>}
* @type {ModifyOnSignature}
*/
this.on;
/***
* @type {ModifyOnSignature}
*/
this.once;
/** @private */
this.boundHandleFeatureChange_ = this.handleFeatureChange_.bind(this);
src/ol/interaction/Select.js
+15 -6
View File
@@ -134,6 +134,15 @@ export class SelectEvent extends Event {
*/
const originalFeatureStyles = {};
/***
* @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'select', SelectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'select'>} SelectOnSignature
*/
/**
* @classdesc
* Interaction for selecting vector features. By default, selected features are
@@ -157,15 +166,15 @@ class Select extends Interaction {
super();
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'select', SelectEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'select'>}
* @type {SelectOnSignature}
*/
this.on;
/***
* @type {SelectOnSignature}
*/
this.once;
const options = opt_options ? opt_options : {};
/**
src/ol/interaction/Translate.js
+15 -6
View File
@@ -110,6 +110,15 @@ export class TranslateEvent extends Event {
}
}
/***
* @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'translateend'|'translatestart'|'translating', TranslateEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'translateend'|'translatestart'|'translating'>} TranslateOnSignature
*/
/**
* @classdesc
* Interaction for translating (moving) features.
@@ -127,15 +136,15 @@ class Translate extends PointerInteraction {
super(/** @type {import("./Pointer.js").Options} */ (options));
/***
* @type {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default> &
* import("../Observable").OnSignature<import("../ObjectEventType").Types|
* 'change:active', import("../Object").ObjectEvent> &
* import("../Observable").OnSignature<'translateend'|'translatestart'|'translating', TranslateEvent> &
* import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
* 'change:active'|'translateend'|'translatestart'|'translating'>}
* @type {TranslateOnSignature}
*/
this.on;
/***
* @type {TranslateOnSignature}
*/
this.once;
/**
* The last position we translated to.
* @type {import("../coordinate.js").Coordinate}