mirror of
https://github.com/openseadragon/openseadragon.git
synced 2024-11-25 06:36:11 +03:00
Update documentation to be more explicit about post data string parameter format.
This commit is contained in:
parent
bd6ec09458
commit
63ecaafa51
@ -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 - data for the post request 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.
|
||||
*/
|
||||
|
@ -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 - data for the post request or null
|
||||
* @param {String} postData - HTTP POST data in k=v&k2=v2... form; or null;
|
||||
* @example <caption>IIIF 1.1 Info Looks like this</caption>
|
||||
* {
|
||||
* "@context" : "http://library.stanford.edu/iiif/image-api/1.1/context.json",
|
||||
|
@ -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] - POST parameters 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.
|
||||
|
@ -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 - data for the post request 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.
|
||||
*/
|
||||
|
@ -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 - data for the post request 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.
|
||||
*/
|
||||
|
@ -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 - data for the post request 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.
|
||||
*/
|
||||
|
@ -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 post parameters 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
|
||||
* @member {String} postData HTTP POST data in k=v&k2=v2... form; or null
|
||||
* @memberof OpenSeadragon.Tile#
|
||||
*/
|
||||
this.postData = postData;
|
||||
|
@ -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 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,8 @@ $.TileSource.prototype = {
|
||||
* @param {String|Object|Array|Document} data
|
||||
* @param {String} url - the url the data was loaded
|
||||
* from if any.
|
||||
* @param {String} postData value obtained from the url after '#' sign or null
|
||||
* @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
|
||||
* instantiate the TileSource subclass with - what _options_ object should contain).
|
||||
|
@ -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 - data for the post request 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.
|
||||
*/
|
||||
|
@ -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 - data for the post request 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.
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user