example: deep zoom image support

The DZI (Deep Zoom Image) format is an xml specification maintained by Microsoft and described here.

OpenSeadragon has added supports for DZI format via AJAX ( XML/JSON ), JSONP, and as inline configuration ( using the json format ). The DZI specification does not officially describe a JSON format however the examples below illustrate how DZI xml is mapped to json following some simple conventions.

Inline Configuration for DZI

Inline configuration is convenient as well because it avoids a potentially complicated JSON/XML Ajax request over the network. Just plop the equivalent json directly into 'tileSources' option.

Example Inline Configuration for DZI

Configuration is done via the 'tileSources' option ( or programatically ).

Note however the non-standard dzi property 'Url' which we must supply explicitly since this is normally inferred by the path specified for the dzi XML/JSON/JSONP.

OpenSeadragon({
    ...
    tileSources:   {
        Image: {
            xmlns:    "http://schemas.microsoft.com/deepzoom/2008",
            Url:      "/openseadragon/examples/images/highsmith/highsmith_files/",
            Format:   "jpg", 
            Overlap:  "2", 
            TileSize: "256",
            Size: {
                Height: "9221",
                Width:  "7026"
            }
        }
    }
    ...
});