From cf3bf91b8d44000190dbbace4153b89aa96b48ab Mon Sep 17 00:00:00 2001 From: Kevin Britten Date: Thu, 16 Feb 2023 14:51:30 -0500 Subject: [PATCH] add type Element to documentation for custom ui buttons --- src/openseadragon.js | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index f10769ae..4616062a 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -565,50 +565,50 @@ * viewing the first image and the 'next' button will wrap to the first * image when viewing the last image. * - * @property {String} zoomInButton - * Set the id of the custom 'Zoom in' button to use. + *@property {String|Element} zoomInButton + * Set the id or element of the custom 'Zoom in' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * - * @property {String} zoomOutButton - * Set the id of the custom 'Zoom out' button to use. + * @property {String|Element} zoomOutButton + * Set the id or element of the custom 'Zoom out' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * - * @property {String} homeButton - * Set the id of the custom 'Go home' button to use. + * @property {String|Element} homeButton + * Set the id or element of the custom 'Go home' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * - * @property {String} fullPageButton - * Set the id of the custom 'Toggle full page' button to use. + * @property {String|Element} fullPageButton + * Set the id or element of the custom 'Toggle full page' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * - * @property {String} rotateLeftButton - * Set the id of the custom 'Rotate left' button to use. + * @property {String|Element} rotateLeftButton + * Set the id or element of the custom 'Rotate left' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * - * @property {String} rotateRightButton - * Set the id of the custom 'Rotate right' button to use. + * @property {String|Element} rotateRightButton + * Set the id or element of the custom 'Rotate right' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * - * @property {String} previousButton - * Set the id of the custom 'Previous page' button to use. + * @property {String|Element} previousButton + * Set the id or element of the custom 'Previous page' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * - * @property {String} nextButton - * Set the id of the custom 'Next page' button to use. + * @property {String|Element} nextButton + * Set the id or element of the custom 'Next page' button to use. * This is useful to have a custom button anywhere in the web page.
* To only change the button images, consider using * {@link OpenSeadragon.Options.navImages}