@knopkem/dicomview 0.2.3 → 0.2.4
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/README.md +37 -12
- package/package.json +1 -1
- package/wasm/dicomview_wasm_bg.wasm +0 -0
package/README.md
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
|
-
# @dicomview
|
|
1
|
+
# @knopkem/dicomview
|
|
2
2
|
|
|
3
|
-
`@dicomview
|
|
3
|
+
`@knopkem/dicomview` is the browser package for `dicomview-rs`. It wraps the Rust/WASM viewer, handles wasm initialization, and provides a DICOMweb loader with optional worker-based decode.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @knopkem/dicomview
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Build (from source)
|
|
6
12
|
|
|
7
13
|
```bash
|
|
8
14
|
npm install
|
|
@@ -16,25 +22,44 @@ npm run build
|
|
|
16
22
|
|
|
17
23
|
The wasm-pack output is emitted into `js/wasm/`, which is the directory shipped in the npm tarball.
|
|
18
24
|
|
|
19
|
-
## Publish
|
|
25
|
+
## Publish
|
|
26
|
+
|
|
27
|
+
Use the top-level publish script from the repo root:
|
|
20
28
|
|
|
21
29
|
```bash
|
|
22
|
-
npm
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
30
|
+
# Full publish (Rust tests → WASM → TS → crates.io → npm)
|
|
31
|
+
./publish.sh
|
|
32
|
+
|
|
33
|
+
# Dry-run (builds everything, publishes nothing)
|
|
34
|
+
./publish.sh --dry-run
|
|
35
|
+
|
|
36
|
+
# npm only (skip crates.io)
|
|
37
|
+
./publish.sh --skip-crates
|
|
26
38
|
```
|
|
27
39
|
|
|
40
|
+
Or publish manually:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm run build
|
|
44
|
+
npm pack --dry-run # inspect contents
|
|
45
|
+
npm publish --access public
|
|
46
|
+
```
|
|
28
47
|
|
|
29
48
|
## Public API
|
|
30
49
|
|
|
31
50
|
```ts
|
|
32
|
-
import {
|
|
51
|
+
import {
|
|
52
|
+
DICOMwebLoader,
|
|
53
|
+
Presets,
|
|
54
|
+
Viewer,
|
|
55
|
+
StackViewer,
|
|
56
|
+
} from "@knopkem/dicomview";
|
|
33
57
|
```
|
|
34
58
|
|
|
35
|
-
- `Viewer.create(...)`
|
|
36
|
-
- `
|
|
37
|
-
- `
|
|
59
|
+
- `Viewer.create(...)` — four-canvas MPR + volume renderer (axial, coronal, sagittal, volume)
|
|
60
|
+
- `StackViewer.create(...)` — single-canvas 2D stack viewer with scroll, window/level, and thick-slab
|
|
61
|
+
- `DICOMwebLoader` — streams a DICOMweb series into either viewer type
|
|
62
|
+
- `Presets` — built-in CT/MR transfer-function identifiers
|
|
38
63
|
|
|
39
64
|
## Notes
|
|
40
65
|
|
package/package.json
CHANGED
|
Binary file
|