OMEZarrTileSource

An OpenSeadragon tile source for the OME-Zarr bioimage file format

Prerequisites

OpenSeadragon 5 or newer

Installation

Using npm:

npm install omezarr-tilesource

Usage

import OpenSeadragon from "openseadragon";
import { OMEZarrTileSource } from "omezarr-tilesource";

const url = ...;

// only necessary when using inline tile source configuration (see below)
OMEZarrTileSource.enable(OpenSeadragon);

const viewer = OpenSeadragon(
    ...
    tileSources: [
        // configuration with a URL string (only works with OME-Zarr ZIP URLs ending with .ozx)
        url,
        // inline configuration with an options object (requires prior enabling, see above)
        {
            type: "ome-zarr",
            url: url,
            // zip: undefined,  // undefined = OME-Zarr ZIP auto-detection based on .ozx suffix
            // t: undefined,
            // c: undefined,
            // z: undefined
        },
        // direct instantiation with a URL string (works with any OME-Zarr storage backend)
        new OMEZarrTileSource(url),
        // direct instantiation with an options object (no prior enabling required)
        new OMEZarrTileSource({
            url: url,
            // zip: undefined,  // undefined = OME-Zarr ZIP auto-detection based on .ozx suffix
            // t: undefined,
            // c: undefined,
            // z: undefined
        })
    ]
);

Example

Example

Source code

Authors

Jonas Windhager

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Acknowledgments

This project was initially started by Will Moore at the 2025 OME-NGFF Workflows Hackathon in Zurich, Switzerland.

License

MIT