omezarr-tilesource 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +80 -0
- package/dist/blosc-D1xNXZJs.js +719 -0
- package/dist/chunk-INHXZS53-DiyuLb3Z.js +14 -0
- package/dist/lz4-1Ws5oVWR.js +640 -0
- package/dist/omezarr-tilesource.js +14531 -0
- package/dist/omezarr-tilesource.umd.cjs +45 -0
- package/dist/zstd-C4EcZnjq.js +603 -0
- package/package.json +42 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Jonas Windhager
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# OMEZarrTileSource
|
|
2
|
+
|
|
3
|
+
[](https://github.com/TissUUmaps/OMEZarrTileSource/releases)
|
|
4
|
+
[](https://github.com/TissUUmaps/OMEZarrTileSource/issues)
|
|
5
|
+
[](https://github.com/TissUUmaps/OMEZarrTileSource/pulls)
|
|
6
|
+
[](https://github.com/TissUUmaps/OMEZarrTileSource/actions/workflows/pages.yaml)
|
|
7
|
+
[](https://github.com/TissUUmaps/OMEZarrTileSource/actions/workflows/release.yaml)
|
|
8
|
+
[](https://www.npmjs.com/package/OMEZarrTileSource)
|
|
9
|
+
[](LICENSE)
|
|
10
|
+
|
|
11
|
+
An OpenSeadragon tile source for the OME-Zarr bioimage file format.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
Using npm:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npm install omezarr-tilesource
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```javascript
|
|
24
|
+
import OpenSeadragon from "openseadragon";
|
|
25
|
+
import { OMEZarrTileSource } from "omezarr-tilesource";
|
|
26
|
+
|
|
27
|
+
const url = ...;
|
|
28
|
+
|
|
29
|
+
// only necessary when using inline tile source configuration (see below)
|
|
30
|
+
OMEZarrTileSource.enable(OpenSeadragon);
|
|
31
|
+
|
|
32
|
+
const viewer = OpenSeadragon(
|
|
33
|
+
...
|
|
34
|
+
tileSources: [
|
|
35
|
+
// configuration with a URL string (only works with OME-Zarr ZIP URLs ending with .ozx)
|
|
36
|
+
url,
|
|
37
|
+
// inline configuration with an options object (requires prior enabling, see above)
|
|
38
|
+
{
|
|
39
|
+
type: "ome-zarr",
|
|
40
|
+
url: url,
|
|
41
|
+
// zip: undefined, // undefined = OME-Zarr ZIP auto-detection based on .ozx suffix
|
|
42
|
+
// t: undefined,
|
|
43
|
+
// c: undefined,
|
|
44
|
+
// z: undefined
|
|
45
|
+
}
|
|
46
|
+
// direct instantiation with a URL string (works with any OME-Zarr storage backend)
|
|
47
|
+
new OMEZarrTileSource(url),
|
|
48
|
+
// direct instantiation with an options object (no prior enabling required)
|
|
49
|
+
new OMEZarrTileSource({
|
|
50
|
+
url: url,
|
|
51
|
+
// zip: undefined, // undefined = OME-Zarr ZIP auto-detection based on .ozx suffix
|
|
52
|
+
// t: undefined,
|
|
53
|
+
// c: undefined,
|
|
54
|
+
// z: undefined
|
|
55
|
+
})
|
|
56
|
+
]
|
|
57
|
+
);
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Example
|
|
61
|
+
|
|
62
|
+
[Example](https://tissuumaps.github.io/OMEZarrTileSource)
|
|
63
|
+
|
|
64
|
+
[Source code](index.html)
|
|
65
|
+
|
|
66
|
+
## Authors
|
|
67
|
+
|
|
68
|
+
[Jonas Windhager](https://github.com/jwindhager)
|
|
69
|
+
|
|
70
|
+
## Contributing
|
|
71
|
+
|
|
72
|
+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
73
|
+
|
|
74
|
+
## Acknowledgments
|
|
75
|
+
|
|
76
|
+
This project was initially [started by Will Moore](https://github.com/BioNGFF/ome-zarr.js/pull/22) at the [2025 OME-NGFF Workflows Hackathon](https://biovisioncenter.notion.site/2025-OME-NGFF-Workflows-Hackathon-25662fc04eb38148885ec0fee3ff8539) in Zurich, Switzerland.
|
|
77
|
+
|
|
78
|
+
## License
|
|
79
|
+
|
|
80
|
+
[MIT](LICENSE)
|