igv 3.7.3 → 3.8.1

package/README.md

@@ -18,19 +18,19 @@ Below are examples and a quickstart guide.  See the [developer documentation](ht
 
 # Examples
  
-***[Alignments](https://igv.org/web/release/3.7.3/examples/cram-vcf.html)***
+***[Alignments](https://igv.org/web/release/3.8.1/examples/cram-vcf.html)***
 
-***[Interactions](https://igv.org/web/release/3.7.3/examples/interact.html)***
+***[Interactions](https://igv.org/web/release/3.8.1/examples/interact.html)***
 
-***[Copy number](https://igv.org/web/release/3.7.3/examples/copyNumber.html)***
+***[Copy number](https://igv.org/web/release/3.8.1/examples/copyNumber.html)***
 
-***[Multiple regions](https://igv.org/web/release/3.7.3/examples/multi-locus.html)***
+***[Multiple regions](https://igv.org/web/release/3.8.1/examples/multi-locus.html)***
 
-***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.7.3/examples/maf-tcga.html)***
+***[Mutation Annotation Format (MAF)](https://igv.org/web/release/3.8.1/examples/maf-tcga.html)***
 
-***[Variant color options](https://igv.org/web/release/3.7.3/examples/variant-colors.html)***
+***[Variant color options](https://igv.org/web/release/3.8.1/examples/variant-colors.html)***
 
-***[More](https://igv.org/web/release/3.7.3/examples/)***
+***[More](https://igv.org/web/release/3.8.1/examples/)***
 
  
 # Quickstart
@@ -39,18 +39,18 @@ Below are examples and a quickstart guide.  See the [developer documentation](ht
 igv.js consists of a single javascript file with no external dependencies.  
 
 Pre-built files for script include, AMD, or CJS module systems (igv.min.js) and an ES6 module (igv.esm.min.js)
-can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.7.3/dist/](https://cdn.jsdelivr.net/npm/igv@3.7.3/dist/). 
+can be downloaded from [https://cdn.jsdelivr.net/npm/igv@3.8.1/dist/](https://cdn.jsdelivr.net/npm/igv@3.8.1/dist/). 
 
 To import igv as an ES6 module
 
 ```javascript
-import igv from "https://cdn.jsdelivr.net/npm/igv@3.7.3/dist/igv.esm.min.js"
+import igv from "https://cdn.jsdelivr.net/npm/igv@3.8.1/dist/igv.esm.min.js"
 ``` 
 
 Or as a script include (defines the "igv" global)
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/igv@3.7.3/dist/igv.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/igv@3.8.1/dist/igv.min.js"></script>
 ```   
  
 Alternatively you can install with npm  
@@ -121,6 +121,14 @@ npm install
 npm run build
 ```
 
+**Note**: igv.js has a large history with many commits which can make cloning and building the entire history time consuming.  
+To clone just the latest commit, use the ```--depth``` option, for example
+
+```
+git clone --depth 1 https://github.com/igvteam/igv.js.git
+```
+
+
 This creates a dist folder with the following files
 
 * igv.js - UMDS file for script include, AMD, or CJS modules.  A script include will define an "igv" global.
@@ -131,7 +139,6 @@ This creates a dist folder with the following files
 Additionally the file ```embedCSS.js``` is created in the ```js``` folder.  This contains the CSS required for igv.js,
 which is injected into a shadow root containing igv.js.
 
-
 ### Tests
 
 To run the tests from the command line
@@ -140,20 +147,6 @@ To run the tests from the command line
 npm run test
 ```
 
-
-### Examples
-
-To run the examples install [http-server](https://www.npmjs.com/package/http-server).
-
-Start  http-server from the project root directory
-
-```bash
-npx http-server 
-```
-
-Then open [http://localhost:8080/examples](http://localhost:8080/examples) in a web browser.
-
-
 # Supported Browsers
 
 igv.js require a modern web browser with support for Javascript ECMAScript 2015 (ES6). 

package/dist/igv.d.ts

@@ -11,7 +11,7 @@ declare class Opaque<N extends string> {
 
 export type TrackType =
     "annotation" | "wig" | "alignment" | "variant" | "mut" | "seg" |
-    "gwas" | "interact" | 'interaction' | "qtl" | "junction" | "cnvpytor" | "merged" | "arc" |
+    "gwas" | "interact" | 'interaction' | "qtl" | "junction" | "cnvpytor" | "merged" | "arc" | "longrange" |
     /* undocumented options */
     "snp" | "eqtl";
 
@@ -384,7 +384,7 @@ export namespace Tracks {
     });
 
 
-    export type InteractFormat = "interact" | "bedpe" | "bigInteract" | "bb" | "hic";
+    export type InteractFormat = "interact" | "bedpe" | "bigInteract" | "bb" | "hic" | "longrange";
 
     export type InteractTrackOptions = {
         arcType?: "nested" | "proportional" | "inView" | "partialInView";