igv 3.4.0 → 3.5.0
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 +1 -1
- package/README.md +20 -11
- package/dist/igv.d.ts +1 -1
- package/dist/igv.esm.js +20907 -21727
- package/dist/igv.esm.min.js +9 -9
- package/dist/igv.esm.min.js.map +1 -1
- package/dist/igv.js +20907 -21727
- package/dist/igv.min.js +9 -9
- package/dist/igv.min.js.map +1 -1
- package/package.json +4 -4
package/LICENSE
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
The MIT License (MIT)
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2014-
|
|
3
|
+
Copyright (c) 2014-2025 Broad Institute of MIT and Harvard, Regents of the University of California
|
|
4
4
|
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
6
|
of this software and associated documentation files (the "Software"), to deal
|
package/README.md
CHANGED
|
@@ -18,19 +18,19 @@ Below are examples and a quickstart guide. See the [developer documentation](ht
|
|
|
18
18
|
|
|
19
19
|
# Examples
|
|
20
20
|
|
|
21
|
-
***[Alignments](https://igv.org/web/release/3.
|
|
21
|
+
***[Alignments](https://igv.org/web/release/3.5.0/examples/cram-vcf.html)***
|
|
22
22
|
|
|
23
|
-
***[Interactions](https://igv.org/web/release/3.
|
|
23
|
+
***[Interactions](https://igv.org/web/release/3.5.0/examples/interact.html)***
|
|
24
24
|
|
|
25
|
-
***[Copy number](https://igv.org/web/release/3.
|
|
25
|
+
***[Copy number](https://igv.org/web/release/3.5.0/examples/copyNumber.html)***
|
|
26
26
|
|
|
27
|
-
***[Multiple regions](https://igv.org/web/release/3.
|
|
27
|
+
***[Multiple regions](https://igv.org/web/release/3.5.0/examples/multi-locus.html)***
|
|
28
28
|
|
|
29
|
-
***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.
|
|
29
|
+
***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.5.0/examples/maf-tcga.html)***
|
|
30
30
|
|
|
31
|
-
***[Variant color options](https://igv.org/web/release/3.
|
|
31
|
+
***[Variant color options](https://igv.org/web/release/3.5.0/examples/variant-colors.html)***
|
|
32
32
|
|
|
33
|
-
***[More](https://igv.org/web/release/3.
|
|
33
|
+
***[More](https://igv.org/web/release/3.5.0/examples/)***
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
# Quickstart
|
|
@@ -39,18 +39,18 @@ Below are examples and a quickstart guide. See the [developer documentation](ht
|
|
|
39
39
|
igv.js consists of a single javascript file with no external dependencies.
|
|
40
40
|
|
|
41
41
|
Pre-built files for script include, AMD, or CJS module systems (igv.min.js) and an ES6 module (igv.esm.min.js)
|
|
42
|
-
can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.
|
|
42
|
+
can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.5.0/dist/](https://cdn.jsdelivr.net/npm/igv@3.5.0/dist/).
|
|
43
43
|
|
|
44
44
|
To import igv as an ES6 module
|
|
45
45
|
|
|
46
46
|
```javascript
|
|
47
|
-
import igv from "https://cdn.jsdelivr.net/npm/igv@3.
|
|
47
|
+
import igv from "https://cdn.jsdelivr.net/npm/igv@3.5.0/dist/igv.esm.min.js"
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
Or as a script include (defines the "igv" global)
|
|
51
51
|
|
|
52
52
|
```html
|
|
53
|
-
<script src="https://cdn.jsdelivr.net/npm/igv@3.
|
|
53
|
+
<script src="https://cdn.jsdelivr.net/npm/igv@3.5.0/dist/igv.min.js"></script>
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
Alternatively you can install with npm
|
|
@@ -106,7 +106,12 @@ Windows users can use [Windows Subsystem for Linux](https://docs.microsoft.com/e
|
|
|
106
106
|
|
|
107
107
|
### Building
|
|
108
108
|
|
|
109
|
-
Building igv.js and running the examples requires [node.js](https://nodejs.org/).
|
|
109
|
+
Building igv.js and running the examples requires [node.js](https://nodejs.org/).
|
|
110
|
+
|
|
111
|
+
Development can be done directly from the source files by importing igv.js from ```js/index.js```.
|
|
112
|
+
See the html files in the ```dev``` folder for examples of how to import igv.js from the source
|
|
113
|
+
directory. The ```dist```files are not required for development, however you must build at least
|
|
114
|
+
once to compile the CSS and create the required file ```js/embedCss.js```.
|
|
110
115
|
|
|
111
116
|
|
|
112
117
|
```
|
|
@@ -123,6 +128,10 @@ This creates a dist folder with the following files
|
|
|
123
128
|
* igv.esm.js -- ES6 module
|
|
124
129
|
* igv.esm.min.js -- minified version of igv.esm.js
|
|
125
130
|
|
|
131
|
+
Additionally the file ```embedCSS.js``` is created in the ```js``` folder. This contains the CSS required for igv.js,
|
|
132
|
+
which is injected into a shadow root containing igv.js.
|
|
133
|
+
|
|
134
|
+
|
|
126
135
|
### Tests
|
|
127
136
|
|
|
128
137
|
To run the tests from the command line
|
package/dist/igv.d.ts
CHANGED
|
@@ -216,7 +216,7 @@ export namespace Tracks {
|
|
|
216
216
|
color?: string,
|
|
217
217
|
altColor?: string,
|
|
218
218
|
guidelines?: { color: string, y: number, dotted: boolean }[];
|
|
219
|
-
graphType?: "points" | "bar"
|
|
219
|
+
graphType?: "points" | "bar" | "line" | "heatmap" | "dynseq"
|
|
220
220
|
flipAxis?: boolean;
|
|
221
221
|
windowFunction?: "mean" | "max" | "min";
|
|
222
222
|
|