New typedef syntax for EventsKey
This commit is contained in:
@@ -229,20 +229,6 @@ ol.DrawGeometryFunctionType;
|
|||||||
ol.EventsConditionType;
|
ol.EventsConditionType;
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Key to use with {@link ol.Observable#unByKey}.
|
|
||||||
*
|
|
||||||
* @typedef {{bindTo: (Object|undefined),
|
|
||||||
* boundListener: (ol.EventsListenerFunctionType|undefined),
|
|
||||||
* callOnce: boolean,
|
|
||||||
* deleteIndex: (number|undefined),
|
|
||||||
* listener: ol.EventsListenerFunctionType,
|
|
||||||
* target: (EventTarget|ol.events.EventTarget),
|
|
||||||
* type: string}}
|
|
||||||
*/
|
|
||||||
ol.EventsKey;
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Listener function. This function is called with an event object as argument.
|
* Listener function. This function is called with an event object as argument.
|
||||||
* When the function returns `false`, event propagation will stop.
|
* When the function returns `false`, event propagation will stop.
|
||||||
|
|||||||
@@ -9,3 +9,15 @@
|
|||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Key to use with {@link module:ol/Observable~Observable#unByKey}.
|
||||||
|
* @typedef {Object} EventsKey
|
||||||
|
* @property {Object} [bindTo]
|
||||||
|
* @property {ol.EventsListenerFunctionType} [boundListener]
|
||||||
|
* @property {boolean} callOnce
|
||||||
|
* @property {number} [deleteIndex]
|
||||||
|
* @property {ol.EventsListenerFunctionType} listener
|
||||||
|
* @property {EventTarget|ol.events.EventTarget} target
|
||||||
|
* @property {string} type
|
||||||
|
*/
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user