From a9f0523b628c05ab76fc2597d6f10b991efd0a9d Mon Sep 17 00:00:00 2001 From: Haris Ghauri Date: Wed, 11 Jan 2023 23:15:24 -0500 Subject: [PATCH] issues/2192 fix. --- src/viewer.js | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/viewer.js b/src/viewer.js index 562c9df4..33f5d22d 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -2808,8 +2808,20 @@ function onCanvasKeyPress( event ) { preventHorizontalPan: event.preventHorizontalPan || !this.panHorizontal }; - // This event is documented in onCanvasKeyDown - this.raiseEvent('canvas-key', canvasKeyPressEventArgs); + /** + * Raised when a keyboard key is pressed and the focus is on the {@link OpenSeadragon.Viewer#canvas} element. + * + * @event canvas-key-press + * @memberof OpenSeadragon.Viewer + * @type {object} + * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. + * @property {Object} originalEvent - The original DOM event. + * @property {Boolean} preventDefaultAction - Set to true to prevent default keyboard behaviour. Default: false. + * @property {Boolean} preventVerticalPan - Set to true to prevent keyboard vertical panning. Default: false. + * @property {Boolean} preventHorizontalPan - Set to true to prevent keyboard horizontal panning. Default: false. + * @property {?Object} userData - Arbitrary subscriber-defined object. + */ + this.raiseEvent('canvas-key-press', canvasKeyPressEventArgs); if ( !canvasKeyPressEventArgs.preventDefaultAction && !event.ctrl && !event.alt && !event.meta ) { switch( event.keyCode ){