Fork me on GitHub

OpenSeadragon 6.0.0

Example: Iris TileSource Support

The IrisTileSource is an OpenSeadragon tilesource implementation for viewing images served by an Iris-compatible tile server. It is designed to efficiently display large, high-resolution images, with digital pathology as the primary use case.

The Iris API provides endpoints for retrieving image metadata and individual image tiles. OpenSeadragon's IrisTileSource fetches the metadata to determine the image's dimensions, available zoom levels, and tile layout, then requests tiles as needed while you pan and zoom.

IrisTileSource Configuration

To use the IrisTileSource, specify the type as iris and provide the serverUrl (the base URL of your Iris server) and slideId (the image identifier).

Example Inline Configuration for Iris TileSource

Below is a minimal inline configuration which pulls tiles from an Iris-compatible tile server using the IrisTileSource. The type, serverUrl, and slideId are required to specify the image source. 

OpenSeadragon({
    id:                 "example-custom-tilesource",
    prefixUrl:          "/openseadragon/images/",
    navigatorSizeRatio: 0.25,
    wrapHorizontal:     true,
    tileSources:   {
        type:              "iris",
        serverUrl:         "https://examples.restful.irisdigitalpathology.org",
        slideId:           "cervix_2x_jpeg",
        crossOriginPolicy: "Anonymous"
    }
});

Iris API Information

For more information about the Iris API and its endpoints, please see the Iris API documentation.