Document existing error event type

This commit is contained in:
Tim Schaub
2019-05-14 14:28:00 -06:00
parent 3a1d927c41
commit 811e5f60eb
2 changed files with 8 additions and 8 deletions
+1 -7
View File
@@ -83,7 +83,7 @@ class GeolocationError extends Event {
* window.console.log(geolocation.getPosition()); * window.console.log(geolocation.getPosition());
* }); * });
* *
* @fires error * @fires module:ol/events/Event~Event#event:error
* @api * @api
*/ */
class Geolocation extends BaseObject { class Geolocation extends BaseObject {
@@ -204,12 +204,6 @@ class Geolocation extends BaseObject {
this.changed(); this.changed();
} }
/**
* Triggered when the Geolocation returns an error.
* @event error
* @api
*/
/** /**
* @private * @private
* @param {PositionError} error error object. * @param {PositionError} error error object.
+7 -1
View File
@@ -14,6 +14,13 @@ export default {
*/ */
CHANGE: 'change', CHANGE: 'change',
/**
* Generic error event. Triggered when an error occurs.
* @event module:ol/events/Event~Event#error
* @api
*/
ERROR: 'error',
CLEAR: 'clear', CLEAR: 'clear',
CONTEXTMENU: 'contextmenu', CONTEXTMENU: 'contextmenu',
CLICK: 'click', CLICK: 'click',
@@ -21,7 +28,6 @@ export default {
DRAGENTER: 'dragenter', DRAGENTER: 'dragenter',
DRAGOVER: 'dragover', DRAGOVER: 'dragover',
DROP: 'drop', DROP: 'drop',
ERROR: 'error',
KEYDOWN: 'keydown', KEYDOWN: 'keydown',
KEYPRESS: 'keypress', KEYPRESS: 'keypress',
LOAD: 'load', LOAD: 'load',