diva.js 6.0.1 → 7.2.3

package/source/js/grid-handler.js

@@ -1,122 +0,0 @@
-import maxBy from 'lodash.maxby';
-
-export default class GridHandler
-{
-    constructor (viewerCore)
-    {
-        this._viewerCore = viewerCore;
-    }
-
-    // USER EVENTS
-    onDoubleClick (event, coords)
-    {
-        const position = this._viewerCore.getPagePositionAtViewportOffset(coords);
-
-        const layout = this._viewerCore.getCurrentLayout();
-        const viewport = this._viewerCore.getViewport();
-        const pageToViewportCenterOffset = layout.getPageToViewportCenterOffset(position.anchorPage, viewport);
-
-        this._viewerCore.reload({
-            inGrid: false,
-            goDirectlyTo: position.anchorPage,
-            horizontalOffset: pageToViewportCenterOffset.x + position.offset.left,
-            verticalOffset: pageToViewportCenterOffset.y + position.offset.top
-        });
-    }
-
-    onPinch ()
-    {
-        this._viewerCore.reload({inGrid: false});
-    }
-
-    // VIEW EVENTS
-    onViewWillLoad ()
-    {
-        // FIXME(wabain): Should something happen here?
-        /* No-op */
-    }
-
-    onViewDidLoad ()
-    {
-        // FIXME(wabain): Should something happen here?
-        /* No-op */
-    }
-
-    onViewDidUpdate (renderedPages, targetPage)
-    {
-        // return early if there are no rendered pages in view.
-        if (renderedPages.length === 0) return;
-
-        // calculate the visible pages from the rendered pages
-        let temp = this._viewerCore.viewerState.viewport.intersectionTolerance;
-        // without setting to 0, isPageVisible returns true for pages out of viewport by intersectionTolerance
-        this._viewerCore.viewerState.viewport.intersectionTolerance = 0;
-        let visiblePages = renderedPages.filter(index => this._viewerCore.viewerState.renderer.isPageVisible(index));
-        // reset back to original value after getting true visible pages
-        this._viewerCore.viewerState.viewport.intersectionTolerance = temp;
-
-        if (targetPage !== null)
-        {
-            this._viewerCore.setCurrentPages(targetPage, visiblePages);
-            return;
-        }
-
-        // Select the current page from the first row if it is fully visible, or from
-        // the second row if it is fully visible, or from the centermost row otherwise.
-        // If the current page is in that group then don't change it. Otherwise, set
-        // the current page to the group's first page.
-
-        const layout = this._viewerCore.getCurrentLayout();
-        const groups = [];
-
-        renderedPages.forEach(pageIndex =>
-        {
-            const group = layout.getPageInfo(pageIndex).group;
-            if (groups.length === 0 || group !== groups[groups.length - 1])
-            {
-                groups.push(group);
-            }
-        });
-
-        const viewport = this._viewerCore.getViewport();
-        let chosenGroup;
-
-        if (groups.length === 1 || groups[0].region.top >= viewport.top)
-        {
-            chosenGroup = groups[0];
-        }
-        else if (groups[1].region.bottom <= viewport.bottom)
-        {
-            chosenGroup = groups[1];
-        }
-        else
-        {
-            chosenGroup = getCentermostGroup(groups, viewport);
-        }
-
-        const currentPage = this._viewerCore.getSettings().activePageIndex;
-
-        const hasCurrentPage = chosenGroup.pages.some(page => page.index === currentPage);
-
-        if (!hasCurrentPage)
-        {
-            this._viewerCore.setCurrentPages(chosenGroup.pages[0].index, visiblePages);
-        }
-    }
-
-    destroy ()
-    {
-        // No-op
-    }
-}
-
-function getCentermostGroup (groups, viewport)
-{
-    const viewportMiddle = viewport.top + viewport.height / 2;
-
-    return maxBy(groups, group =>
-    {
-        const groupMiddle = group.region.top + group.dimensions.height / 2;
-        return -Math.abs(viewportMiddle - groupMiddle);
-    });
-}

package/source/js/iiif-source-adapter.js

@@ -1,63 +0,0 @@
-export default class IIIFSourceAdapter
-{
-    getPageImageURL (manifest, pageIndex, size)
-    {
-        let dimens;
-
-        if (!size || (size.width == null && size.height == null))
-        {
-            dimens = 'full';
-        }
-        else
-        {
-            dimens = (size.width == null ? '' : size.width) + ',' + (size.height == null ? '' : size.height);
-        }
-
-        const page = manifest.pages[pageIndex];
-        const quality = (page.api > 1.1) ? 'default' : 'native';
-
-        return encodeURI(page.url + 'full/' + dimens + '/0/' + quality + '.jpg');
-    }
-
-    getTileImageURL (manifest, pageIndex, params)
-    {
-        const page = manifest.pages[pageIndex];
-
-        let height, width;
-
-        if (params.row === params.rowCount - 1)
-        {
-            height = page.d[params.zoomLevel].h - (params.rowCount - 1) * params.tileDimensions.height;
-        }
-        else
-        {
-            height = params.tileDimensions.height;
-        }
-
-        if (params.col === params.colCount - 1)
-        {
-            width = page.d[params.zoomLevel].w - (params.colCount - 1) * params.tileDimensions.width;
-        }
-        else
-        {
-            width = params.tileDimensions.width;
-        }
-
-        const zoomDifference = Math.pow(2, manifest.maxZoom - params.zoomLevel);
-
-        let x = params.col * params.tileDimensions.width * zoomDifference;
-        let y = params.row * params.tileDimensions.height * zoomDifference;
-
-        if (page.hasOwnProperty('xoffset'))
-        {
-            x += page.xoffset;
-            y += page.yoffset;
-        }
-
-        const region = [x, y, width * zoomDifference, height * zoomDifference].join(',');
-
-        const quality = (page.api > 1.1) ? 'default' : 'native';
-
-        return encodeURI(page.url + region + '/' + width + ',' + height + '/0/' + quality + '.jpg');
-    }
-}

package/source/js/image-cache.js

@@ -1,113 +0,0 @@
-const debug = require('debug')('diva:ImageCache');
-
-/* FIXME(wabain): The caching strategy here is completely
- * arbitrary and the implementation isn't especially efficient.
- */
-const DEFAULT_MAX_KEYS = 100;
-
-export default class ImageCache
-{
-    constructor (options)
-    {
-        options = options || { maxKeys: DEFAULT_MAX_KEYS };
-        this.maxKeys = options.maxKeys || DEFAULT_MAX_KEYS;
-
-        this._held = {};
-        this._urls = {};
-        this._lru = [];
-    }
-
-    get (url)
-    {
-        const record = this._urls[url];
-        return record ? record.img : null;
-    }
-
-    has (url)
-    {
-        return !!this._urls[url];
-    }
-
-    put (url, img)
-    {
-        let record = this._urls[url];
-        if (record)
-        {
-            // FIXME: Does this make sense for this use case?
-            record.img = img;
-            this._promote(record);
-        }
-        else
-        {
-            record = {
-                img: img,
-                url: url
-            };
-
-            this._urls[url] = record;
-            this._tryEvict(1);
-            this._lru.unshift(record);
-        }
-    }
-
-    _promote (record)
-    {
-        const index = this._lru.indexOf(record);
-        this._lru.splice(index, 1);
-        this._lru.unshift(record);
-    }
-
-    _tryEvict (extraCapacity)
-    {
-        const allowedEntryCount = this.maxKeys - extraCapacity;
-
-        if (this._lru.length <= allowedEntryCount)
-            return;
-
-        let evictionIndex = this._lru.length - 1;
-
-        for (;;)
-        {
-            const target = this._lru[evictionIndex];
-
-            if (!this._held[target.url])
-            {
-                debug('Evicting image %s', target.url);
-                this._lru.splice(evictionIndex, 1);
-                delete this._urls[target.url];
-
-                if (this._lru.length <= allowedEntryCount)
-                    break;
-            }
-
-            if (evictionIndex === 0)
-            {
-                /* istanbul ignore next */
-                debug.enabled && debug('Cache overfull by %s (all entries are being held)',
-                    this._lru.length - allowedEntryCount);
-
-                break;
-            }
-
-            evictionIndex--;
-        }
-    }
-
-    acquire (url)
-    {
-        this._held[url] = (this._held[url] || 0) + 1;
-        this._promote(this._urls[url]);
-    }
-
-    release (url)
-    {
-        const count = this._held[url];
-
-        if (count > 1)
-            this._held[url]--;
-        else
-            delete this._held[url];
-
-        this._tryEvict(0);
-    }
-}

package/source/js/image-manifest.js

@@ -1,157 +0,0 @@
-import parseIIIFManifest from './parse-iiif-manifest';
-import IIIFSourceAdapter from "./iiif-source-adapter";
-
-
-export default class ImageManifest
-{
-    constructor (data, urlAdapter)
-    {
-        // Save all the data we need
-        this.pages = data.pgs;
-        this.maxZoom = data.max_zoom;
-        this.maxRatio = data.dims.max_ratio;
-        this.minRatio = data.dims.min_ratio;
-        this.itemTitle = data.item_title;
-        this.metadata = data.metadata;
-
-        // Only given for IIIF manifests
-        this.paged = !!data.paged;
-
-        // These are arrays, the index corresponding to the zoom level
-        this._maxWidths = data.dims.max_w;
-        this._maxHeights = data.dims.max_h;
-        this._averageWidths = data.dims.a_wid;
-        this._averageHeights = data.dims.a_hei;
-        this._totalHeights = data.dims.t_hei;
-        this._totalWidths = data.dims.t_wid;
-
-        this._urlAdapter = urlAdapter;
-    }
-
-    static fromIIIF (iiifManifest)
-    {
-        const data = parseIIIFManifest(iiifManifest);
-        return new ImageManifest(data, new IIIFSourceAdapter());
-    }
-
-    isPageValid (pageIndex, showNonPagedPages)
-    {
-        if (!showNonPagedPages && this.paged && !this.pages[pageIndex].paged)
-        {
-            return false;
-        }
-
-        return pageIndex >= 0 && pageIndex < this.pages.length;
-    }
-
-    getMaxPageDimensions (pageIndex)
-    {
-        const maxDims = this.pages[pageIndex].d[this.maxZoom];
-
-        return {
-            height: maxDims.h,
-            width: maxDims.w
-        };
-    }
-
-    getPageDimensionsAtZoomLevel (pageIndex, zoomLevel)
-    {
-        const maxDims = this.pages[pageIndex].d[this.maxZoom];
-
-        const scaleRatio = getScaleRatio(this.maxZoom, zoomLevel);
-
-        return {
-            height: maxDims.h * scaleRatio,
-            width: maxDims.w * scaleRatio
-        };
-    }
-
-    /**
-     * Returns a URL for the image of the given page. The optional size
-     * parameter supports setting the image width or height (default is
-     * full-sized).
-     */
-    getPageImageURL (pageIndex, size)
-    {
-        return this._urlAdapter.getPageImageURL(this, pageIndex, size);
-    }
-
-    /**
-     * Return an array of tile objects for the specified page and integer zoom level
-     */
-    getPageImageTiles (pageIndex, zoomLevel, tileDimensions)
-    {
-        const page = this.pages[pageIndex];
-
-        if (!isFinite(zoomLevel) || zoomLevel % 1 !== 0)
-        {
-            throw new TypeError('Zoom level must be an integer: ' + zoomLevel);
-        }
-
-        const rows = Math.ceil(page.d[zoomLevel].h / tileDimensions.height);
-        const cols = Math.ceil(page.d[zoomLevel].w / tileDimensions.width);
-
-        const tiles = [];
-
-        let row, col, url;
-
-        for (row = 0; row < rows; row++)
-        {
-            for (col = 0; col < cols; col++)
-            {
-                url = this._urlAdapter.getTileImageURL(this, pageIndex, {
-                    row: row,
-                    col: col,
-                    rowCount: rows,
-                    colCount: cols,
-                    zoomLevel: zoomLevel,
-                    tileDimensions: tileDimensions
-                });
-
-                // FIXME: Dimensions should account for partial tiles (e.g. the
-                // last row and column in a tiled image)
-                tiles.push({
-                    row: row,
-                    col: col,
-                    zoomLevel: zoomLevel,
-                    dimensions: {
-                        height: tileDimensions.height,
-                        width: tileDimensions.width
-                    },
-                    offset: {
-                        top: row * tileDimensions.height,
-                        left: col * tileDimensions.width
-                    },
-                    url: url
-                });
-            }
-        }
-
-        return {
-            zoomLevel: zoomLevel,
-            rows: rows,
-            cols: cols,
-            tiles: tiles
-        };
-    }
-}
-
-ImageManifest.prototype.getMaxWidth = zoomedPropertyGetter('_maxWidths');
-ImageManifest.prototype.getMaxHeight = zoomedPropertyGetter('_maxHeights');
-ImageManifest.prototype.getAverageWidth = zoomedPropertyGetter('_averageWidths');
-ImageManifest.prototype.getAverageHeight = zoomedPropertyGetter('_averageHeights');
-ImageManifest.prototype.getTotalWidth = zoomedPropertyGetter('_totalWidths');
-ImageManifest.prototype.getTotalHeight = zoomedPropertyGetter('_totalHeights');
-
-function zoomedPropertyGetter (privateName)
-{
-    return function (zoomLevel)
-    {
-        return this[privateName][zoomLevel];
-    };
-}
-
-function getScaleRatio (sourceZoomLevel, targetZoomLevel)
-{
-    return 1 / Math.pow(2, sourceZoomLevel - targetZoomLevel);
-}

package/source/js/image-request-handler.js

@@ -1,76 +0,0 @@
-/**
- * Handler for the request for an image tile
- *
- * @param url
- * @param callback
- * @constructor
- */
-export default class ImageRequestHandler
-{
-    constructor (options)
-    {
-        this._url = options.url;
-        this._callback = options.load;
-        this._errorCallback = options.error;
-        this.timeoutTime = options.timeoutTime || 0;
-        this._aborted = this._complete = false;
-
-        //Use a timeout to allow the requests to be debounced (as they are in renderer)
-        this.timeout = setTimeout(() => {
-            // Initiate the request
-            this._image = new Image();
-            this._image.crossOrigin = "anonymous";
-            this._image.onload = this._handleLoad.bind(this);
-            this._image.onerror = this._handleError.bind(this);
-            this._image.src = options.url;
-
-        }, this.timeoutTime);
-    }
-
-    abort ()
-    {
-        clearTimeout(this.timeout);
-
-        // FIXME
-        // People on the Internet say that doing this {{should/should not}} abort the request. I believe
-        // it corresponds to what the WHATWG HTML spec says should happen when the UA
-        // updates the image data if selected source is null.
-        //
-        // Sources:
-        //
-        // https://html.spec.whatwg.org/multipage/embedded-content.html#the-img-element
-        // http://stackoverflow.com/questions/7390888/does-changing-the-src-attribute-of-an-image-stop-the-image-from-downloading
-        if (this._image)
-        {
-            this._image.onload = this._image.onerror = null;
-
-            this._image.src = '';
-        }
-
-        this._aborted = true;
-    }
-
-    _handleLoad ()
-    {
-        if (this._aborted)
-        {
-            console.error('ImageRequestHandler invoked on cancelled request for ' + this._url);
-            return;
-        }
-
-        if (this._complete)
-        {
-            console.error('ImageRequestHandler invoked on completed request for ' + this._url);
-            return;
-        }
-
-        this._complete = true;
-
-        this._callback(this._image);
-    }
-
-    _handleError ()
-    {
-        this._errorCallback(this._image);
-    }
-}

package/source/js/interpolate-animation.js

@@ -1,122 +0,0 @@
-// TODO: requestAnimationFrame fallback
-
-export default {
-    animate,
-    easing: {
-        linear: linearEasing,
-        cubic: inOutCubicEasing
-    }
-};
-
-let now;
-
-if (typeof performance !== 'undefined' && performance.now)
-{
-    now = () => { return performance.now(); };
-}
-else
-{
-    now = () => { return Date.now(); };
-}
-
-
-function animate (options)
-{
-    const durationMs = options.duration;
-    const parameters = options.parameters;
-    const onUpdate = options.onUpdate;
-    const onEnd = options.onEnd;
-
-    // Setup
-    // Times are in milliseconds from a basically arbitrary start
-    const start = now();
-    const end = start + durationMs;
-
-    const tweenFns = {};
-    const values = {};
-    const paramKeys = Object.keys(parameters);
-
-    paramKeys.forEach(key => {
-        const config = parameters[key];
-        tweenFns[key] = interpolate(config.from, config.to, config.easing || inOutCubicEasing);
-    });
-
-    // Run it!
-    let requestId = requestAnimationFrame(update);
-
-    return {
-        cancel()
-        {
-            if (requestId !== null)
-            {
-                cancelAnimationFrame(requestId);
-                handleAnimationCompletion({
-                    interrupted: true
-                });
-            }
-        }
-    };
-
-    function update()
-    {
-        const current = now();
-        const elapsed = Math.min((current - start) / durationMs, 1);
-
-        updateValues(elapsed);
-        onUpdate(values);
-
-        if (current < end)
-        {
-            requestId = requestAnimationFrame(update);
-        }
-        else
-        {
-            handleAnimationCompletion({
-                interrupted: false
-            });
-        }
-    }
-
-    function updateValues(elapsed)
-    {
-        paramKeys.forEach(key => {
-            values[key] = tweenFns[key](elapsed);
-        });
-    }
-
-    function handleAnimationCompletion(info)
-    {
-        requestId = null;
-
-        if (onEnd)
-            onEnd(info);
-    }
-}
-
-function interpolate(start, end, easing)
-{
-    return (elapsed) => { return start + (end - start) * easing(elapsed); };
-}
-
-/**
- * Easing functions. inOutCubicEasing is the default, but
- * others are given for convenience.
- *
- **/
-function linearEasing(e)
-{
-    return e;
-}
-
-/* jshint ignore:start */
-function inOutQuadEasing (e)
-{
-    return e < .5 ? 2 * e * e : -1+(4-2 * e) * e
-}
-/* jshint ignore:end */
-
-
-function inOutCubicEasing (t)
-{
-    return t < 0.5 ? 4 * t * t * t : ( t - 1 ) * ( 2 * t - 2 ) * ( 2 * t - 2 ) + 1;
-}