mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-25 14:46:10 +03:00
Code Issues Projects Releases Wiki Activity

Fixed: normalize ID property for IIIF tile source

Browse Source 
This commit attempts to normalize all possible values of the "id" property for IIIF tile sources
into a single internal _id property.
This commit is contained in:
Andrew Hankinson 2022-06-16 12:55:21 +02:00
parent 6eeccb530b
commit 820564dd3e
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/iiiftilesource.js
View File

@ -51,8 +51,11 @@ $.IIIFTileSource = function( options ){
$.extend( true, this, options ); $.extend( true, this, options );
if ( !( this.height && this.width && (this['@id'] || this['id']) ) ) { /* Normalizes v3-style 'id' keys to an "_id" internal property */
throw new Error( 'IIIF required parameters not provided.' ); this._id = this["@id"] || this["id"] || this['identifier'] || null;
if ( !( this.height && this.width && this._id) ) {
throw new Error( 'IIIF required parameters (width, height, or id) not provided.' );
} }
options.tileSizePerScaleFactor = {}; options.tileSizePerScaleFactor = {};
@ -204,13 +207,15 @@ $.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, /** @lends OpenSea
if ( !$.isPlainObject(data) ) { if ( !$.isPlainObject(data) ) {
var options = configureFromXml10( data ); var options = configureFromXml10( data );
options['@context'] = "http://iiif.io/api/image/1.0/context.json"; options['@context'] = "http://iiif.io/api/image/1.0/context.json";
options['@id'] = url.replace('/info.xml', ''); options._id = url.replace('/info.xml', '');
options.version = 1; options.version = 1;
return options; return options;
} else { } else {
if ( !data['@context'] ) { if ( !data['@context'] ) {
data['@context'] = 'http://iiif.io/api/image/1.0/context.json'; data['@context'] = 'http://iiif.io/api/image/1.0/context.json';
data['@id'] = url.replace('/info.json', ''); data["@id"] = url.replace('/info.json', '');
// ensure the '@id' property is aliased to the internal "_id" property.
data._id = data["@id"];
data.version = 1; data.version = 1;
} else { } else {
var context = data['@context']; var context = data['@context'];
@ -239,10 +244,15 @@ $.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, /** @lends OpenSea
$.console.error('Data has a @context property which contains no known IIIF context URI.'); $.console.error('Data has a @context property which contains no known IIIF context URI.');
} }
} }
if ( !data['@id'] && data['id'] ) {
data['@id'] = data['id']; // normalize the various possible id properties to an internal one
data._id = data["@id"] || data["id"] || data['identifier'] || null;
if (!data._id) {
throw new Error( 'Could not determine a property for the tile source ID.' );
} }
if(data.preferredFormats) {
if (data.preferredFormats) {
for (var f = 0; f < data.preferredFormats.length; f++ ) { for (var f = 0; f < data.preferredFormats.length; f++ ) {
if ( OpenSeadragon.imageFormatSupported(data.preferredFormats[f]) ) { if ( OpenSeadragon.imageFormatSupported(data.preferredFormats[f]) ) {
data.tileFormat = data.preferredFormats[f]; data.tileFormat = data.preferredFormats[f];
@ -431,7 +441,7 @@ $.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, /** @lends OpenSea
iiifSize = iiifSizeW + ","; iiifSize = iiifSizeW + ",";
} }
} }
uri = [ this['@id'], iiifRegion, iiifSize, IIIF_ROTATION, iiifQuality ].join( '/' ); uri = [ this._id, iiifRegion, iiifSize, IIIF_ROTATION, iiifQuality ].join( '/' );
return uri; return uri;
}, },
@ -482,7 +492,7 @@ $.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, /** @lends OpenSea
var levels = []; var levels = [];
for(var i = 0; i < options.sizes.length; i++) { for(var i = 0; i < options.sizes.length; i++) {
levels.push({ levels.push({
url: options['@id'] + '/full/' + options.sizes[i].width + ',' + url: options._id + '/full/' + options.sizes[i].width + ',' +
(options.version === 3 ? options.sizes[i].height : '') + (options.version === 3 ? options.sizes[i].height : '') +
'/0/default.' + options.tileFormat, '/0/default.' + options.tileFormat,
width: options.sizes[i].width, width: options.sizes[i].width,