protvista-uniprot 3.0.7 → 3.0.8
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
CHANGED
|
@@ -4,8 +4,27 @@ A Web Component which uses [Nightingale](https://github.com/ebi-webcomponents/ni
|
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
|
|
7
|
+
## Compatibility
|
|
8
|
+
|
|
9
|
+
- [protvista-uniprot v3](https://github.com/ebi-webcomponents/protvista-uniprot) is compatible with [nightingale v5](https://github.com/ebi-webcomponents/nightingale)
|
|
10
|
+
- [protvista-uniprot v2](https://github.com/ebi-webcomponents/protvista-uniprot/tree/v2) is compatible with [nightingale v3](https://github.com/ebi-webcomponents/nightingale/tree/v3)
|
|
11
|
+
|
|
7
12
|
## Usage
|
|
8
13
|
|
|
14
|
+
### Use within an HTML file
|
|
15
|
+
|
|
16
|
+
Create an [es-module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) import within a static HTML file:
|
|
17
|
+
|
|
18
|
+
```html
|
|
19
|
+
<script type="module" src="./protvista-uniprot.mjs"></script>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
and then the component can be displayed with:
|
|
23
|
+
|
|
24
|
+
```html
|
|
25
|
+
<protvista-uniprot accession="P05067"></protvista-uniprot>
|
|
26
|
+
```
|
|
27
|
+
|
|
9
28
|
### Importing as a module
|
|
10
29
|
|
|
11
30
|
```
|
|
@@ -20,23 +39,10 @@ You can then use it like this:
|
|
|
20
39
|
<protvista-uniprot accession="P05067" />
|
|
21
40
|
```
|
|
22
41
|
|
|
23
|
-
#### Dependencies
|
|
24
|
-
|
|
25
|
-
The component relies on d3 which is set as a global variable and needs to be added to your project.
|
|
26
|
-
|
|
27
|
-
```
|
|
28
|
-
<script src="https://d3js.org/d3.v4.min.js" charset="utf-8" defer></script>
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### or via CDN
|
|
32
|
-
|
|
33
|
-
See [here](https://codepen.io/xwatkins/pen/rXpZXX)
|
|
34
|
-
|
|
35
42
|
### API
|
|
36
43
|
|
|
37
44
|
- accession: String
|
|
38
45
|
- config?: Array [see below](#configuration)
|
|
39
|
-
- notooltip?: Boolean(false)
|
|
40
46
|
- nostructure?: Boolean(false)
|
|
41
47
|
|
|
42
48
|
## Development
|
|
@@ -54,7 +60,7 @@ You can pass your own configuration to the component using the `config` attribut
|
|
|
54
60
|
"name": string,
|
|
55
61
|
"label": string,
|
|
56
62
|
"trackType": nightingale-track|nightingale-linegraph-track|nightingale-variation,
|
|
57
|
-
"adapter":
|
|
63
|
+
"adapter": feature-adapter|structure-adapter|proteomics-adapter|variation-adapter,
|
|
58
64
|
"url": string,
|
|
59
65
|
"tracks": [
|
|
60
66
|
{
|