OMEZarrTileSource

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

Prerequisites

OpenSeadragon 5 or newer

Installation

Using pnpm:

pnpm add omezarr-tilesource

Usage

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

const url = ...;

// configuration with URL (only works with zipped OME-Zarr URLs ending with .ozx)
const tileSource1 = url;

// inline configuration with options object (requires prior enabling, see below)
OMEZarrTileSource.enable(OpenSeadragon);
const tileSource2 = {
    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 URL (works with any OME-Zarr storage backend)
const tileSource3 = new OMEZarrTileSource(url);

// direct instantiation with options object (no prior enabling required)
const tileSource4 = new OMEZarrTileSource({
    url: url,
    // zip: undefined,  // undefined = OME-Zarr ZIP auto-detection based on .ozx suffix
    // t: undefined,
    // c: undefined,
    // z: undefined
});

const viewer = OpenSeadragon(
    ...
    tileSources: [
        tileSource1,
        tileSource2,
        tileSource3,
        tileSource4
    ]
);

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