From ff4f88dc645599ede3b793c17b3e96e21185365f Mon Sep 17 00:00:00 2001 From: Joachim de fourestier Date: Wed, 8 Jun 2022 20:05:43 -0400 Subject: [PATCH] add some documentation --- src/navigator.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/navigator.js b/src/navigator.js index 06a218ab..c5a4ceca 100644 --- a/src/navigator.js +++ b/src/navigator.js @@ -45,7 +45,9 @@ * @memberof OpenSeadragon * @extends OpenSeadragon.Viewer * @extends OpenSeadragon.EventSource - * @param {Object} options + * @param {Object} options - Navigator options + * @param {Element} [options.element] - An element to use for the navigator + * @param {String} [options.id] - Id of the element to use for the navigator. However, this is ignored if {@link options.element} is provided. */ $.Navigator = function( options ){