From 51e3ea7fa08f10765be25f4c1f9ba7764ee6e79b Mon Sep 17 00:00:00 2001 From: Ian Gilman Date: Fri, 21 Jan 2022 11:57:14 -0800 Subject: [PATCH] Changelog for #2072 and minor comment style change --- changelog.txt | 1 + src/dzitilesource.js | 2 +- src/iiiftilesource.js | 2 +- src/imageloader.js | 2 +- src/imagetilesource.js | 2 +- src/legacytilesource.js | 2 +- src/osmtilesource.js | 2 +- src/tile.js | 4 ++-- src/tilesource.js | 4 ++-- src/tmstilesource.js | 2 +- src/zoomifytilesource.js | 2 +- 11 files changed, 13 insertions(+), 12 deletions(-) diff --git a/changelog.txt b/changelog.txt index ffaa8091..ecd5ac6c 100644 --- a/changelog.txt +++ b/changelog.txt @@ -9,6 +9,7 @@ OPENSEADRAGON CHANGELOG * Fixed an issue where turning off panVertical or panHorizontal would not affect the panning keyboard combos (#2069 @JachiOnuoha) * Cleaned up console.logs so that errors and warnings use console.error and console.warn as appropriate (#2073 @Abhishek-90) * Improved documentation (#2067 @JachiOnuoha) +* Added option to include POST data when loading files via Ajax (#2072 @Aiosa) 3.0.0: diff --git a/src/dzitilesource.js b/src/dzitilesource.js index daed1f80..ce9701f8 100644 --- a/src/dzitilesource.js +++ b/src/dzitilesource.js @@ -124,7 +124,7 @@ $.extend( $.DziTileSource.prototype, $.TileSource.prototype, /** @lends OpenSead * @function * @param {Object|XMLDocument} data - the raw configuration * @param {String} url - the url the data was retrieved from if any. - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null; + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null * @return {Object} options - A dictionary of keyword arguments sufficient * to configure this tile sources constructor. */ diff --git a/src/iiiftilesource.js b/src/iiiftilesource.js index dfa10c8e..b6797c5a 100644 --- a/src/iiiftilesource.js +++ b/src/iiiftilesource.js @@ -184,7 +184,7 @@ $.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, /** @lends OpenSea * @function * @param {Object} data - the raw configuration * @param {String} url - the url configuration was retrieved from - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null; + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null * @example IIIF 1.1 Info Looks like this * { * "@context" : "http://library.stanford.edu/iiif/image-api/1.1/context.json", diff --git a/src/imageloader.js b/src/imageloader.js index dc92e4ea..a120433a 100644 --- a/src/imageloader.js +++ b/src/imageloader.js @@ -43,7 +43,7 @@ * @param {String} [options.loadWithAjax] - Whether to load this image with AJAX. * @param {String} [options.ajaxHeaders] - Headers to add to the image request if using AJAX. * @param {String} [options.crossOriginPolicy] - CORS policy to use for downloads - * @param {String} [options.postData] - HTTP POST data in k=v&k2=v2... form; or null + * @param {String} [options.postData] - HTTP POST data in k=v&k2=v2... form or null * @param {Function} [options.callback] - Called once image has been downloaded. * @param {Function} [options.abort] - Called when this image job is aborted. * @param {Number} [options.timeout] - The max number of milliseconds that this image job may take to complete. diff --git a/src/imagetilesource.js b/src/imagetilesource.js index 462c33a4..cbea1ef0 100644 --- a/src/imagetilesource.js +++ b/src/imagetilesource.js @@ -89,7 +89,7 @@ * @function * @param {Object} options - the options * @param {String} dataUrl - the url the image was retrieved from, if any. - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null * @return {Object} options - A dictionary of keyword arguments sufficient * to configure this tile sources constructor. */ diff --git a/src/legacytilesource.js b/src/legacytilesource.js index ab544eb1..24ccc478 100644 --- a/src/legacytilesource.js +++ b/src/legacytilesource.js @@ -122,7 +122,7 @@ $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, /** @lends OpenS * @function * @param {Object|XMLDocument} configuration - the raw configuration * @param {String} dataUrl - the url the data was retrieved from if any. - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null * @return {Object} options - A dictionary of keyword arguments sufficient * to configure this tile sources constructor. */ diff --git a/src/osmtilesource.js b/src/osmtilesource.js index fcfe5c30..6915254e 100644 --- a/src/osmtilesource.js +++ b/src/osmtilesource.js @@ -122,7 +122,7 @@ $.extend( $.OsmTileSource.prototype, $.TileSource.prototype, /** @lends OpenSead * @function * @param {Object} data - the raw configuration * @param {String} url - the url the data was retrieved from if any. - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null * @return {Object} options - A dictionary of keyword arguments sufficient * to configure this tile sources constructor. */ diff --git a/src/tile.js b/src/tile.js index a427e137..8f2dfc1a 100644 --- a/src/tile.js +++ b/src/tile.js @@ -50,7 +50,7 @@ * @param {Boolean} loadWithAjax Whether this tile image should be loaded with an AJAX request . * @param {Object} ajaxHeaders The headers to send with this tile's AJAX request (if applicable). * @param {OpenSeadragon.Rect} sourceBounds The portion of the tile to use as the source of the - * @param {String} postData HTTP POST data in k=v&k2=v2... form; or null + * @param {String} postData HTTP POST data in k=v&k2=v2... form or null * drawing operation, in pixels. Note that this only works when drawing with canvas; when drawing * with HTML the entire tile is always used. */ @@ -101,7 +101,7 @@ $.Tile = function(level, x, y, bounds, exists, url, context2D, loadWithAjax, aja /** * Post parameters for this tile. Either it is an URL-encoded string * in k1=v1&k2=v2... format or null - * @member {String} postData HTTP POST data in k=v&k2=v2... form; or null + * @member {String} postData HTTP POST data in k=v&k2=v2... form or null * @memberof OpenSeadragon.Tile# */ this.postData = postData; diff --git a/src/tilesource.js b/src/tilesource.js index 60535eea..c1956ac5 100644 --- a/src/tilesource.js +++ b/src/tilesource.js @@ -550,7 +550,7 @@ $.TileSource.prototype = { * @property {OpenSeadragon.TileSource} eventSource - A reference to the TileSource which raised the event. * @property {String} message * @property {String} source - * @property {String} postData - HTTP POST data in k=v&k2=v2... form; or null + * @property {String} postData - HTTP POST data in k=v&k2=v2... form or null * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'open-failed', { @@ -593,7 +593,7 @@ $.TileSource.prototype = { * @param {String|Object|Array|Document} data * @param {String} url - the url the data was loaded * from if any. - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null; value obtained from + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null value obtained from * the protocol URL after '#' sign if flag splitHashDataForPost set to 'true' * @return {Object} options - A dictionary of keyword arguments sufficient * to configure the tile source constructor (include all values you want to diff --git a/src/tmstilesource.js b/src/tmstilesource.js index e9eef83b..beee8df5 100644 --- a/src/tmstilesource.js +++ b/src/tmstilesource.js @@ -111,7 +111,7 @@ $.extend( $.TmsTileSource.prototype, $.TileSource.prototype, /** @lends OpenSead * @function * @param {Object} data - the raw configuration * @param {String} url - the url the data was retrieved from if any. - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null * @return {Object} options - A dictionary of keyword arguments sufficient * to configure this tile sources constructor. */ diff --git a/src/zoomifytilesource.js b/src/zoomifytilesource.js index ce90aba8..c55b1948 100644 --- a/src/zoomifytilesource.js +++ b/src/zoomifytilesource.js @@ -122,7 +122,7 @@ * @function * @param {Object} data - the raw configuration * @param {String} url - the url the data was retrieved from if any. - * @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null + * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null * @return {Object} options - A dictionary of keyword arguments sufficient * to configure this tile sources constructor. */