Images App

photograph of the images appphotograph of the images app

This app supports the display of images using the OVE framework. It is based on OpenSeadragon and supports high resolution zoomable images. These images can be of any format OpenSeadragon supports such as Deep Zoom Image (DZI) or Simple Image.

This app does not support animated GIFs, and only the first frame of an animated GIF will be displayed; however, if the URL of an animated GIF is provided directly to the HTML App, then it will play correctly.

Seen above is an image of the images app displaying the In2White Mont Blanc HD panorama DZI photographed at the Imperial College Data Science Institute’s Data Observatory.

Application State

The state of this app has a format similar to:

    "tileSources": ""

The tileSources property points to a DZI file and could be of an XML or JSON format as explained in the OpenSeadragon documentation.

Optionally, a url property can be set instead of the tileSources property. If it had an extension of .dzi, .xml or .json the tileSources property will be set to point to this URL. If the URL had any other extension or had no extension at all, it will be assumed to be a simple image.

The app also supports alternative types of content using other types of tile sources supported by OpenSeadragon.

Launching the App

All OVE applications can be launched using the Launcher UI, the Python Client Library, and the OVE APIs. The API used to launch an application is the same for all applications, but the data that is passed into it is application-specific.

To launch the images app and display an image using the OVE APIs:


curl --header "Content-Type: application/json" --request POST --data '{"app": {"url": "http://OVE_CORE_HOST:PORT/app/images","states": {"load": {"tileSources": ""}}}, "space": "OVE_SPACE", "h": 500, "w": 500, "y": 0, "x": 0}' http://OVE_CORE_HOST:PORT/section


curl --header "Content-Type: application/json" --request POST --data "{\"app\": {\"url\": \"http://OVE_CORE_HOST:PORT/app/images\", \"states\": {\"load\": {\"tileSources\": \"\"}}}, \"space\": \"OVE_SPACE\", \"h\": 500, \"w\": 500, \"y\": 0, \"x\": 0}" http://OVE_CORE_HOST:PORT/section

The images app has a transparent background. If required, a background colour of choice can be set using the Background Utility provided by OVE.

Controlling the App

The controller of the app can be loaded by accessing the URL http://OVE_CORE_HOST:PORT/app/images/control.html?oveSectionId=0. The controller supports panning and zooming of images.