Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

protvista-variation

ebi-webcomponents357MIT3.8.22TypeScript support: included

Variation viewer for the ProtVista tool

nightingale, webcomponents, customelements, variation

readme

protvista-variation

Published on NPM

This custom element displays a matrix of amino-acid changes at a given position on the protein sequence. The advantage of a matrix-based approach is that even with a large number of variants (every single amino-acid change per location) the space taken by the visualisation on the screen doesn't change.

Demo

Usage

<protvista-variation length="270"></protvista-variation>

Setting the data through property

const track = document.querySelector('#my-track-id');
track.data = myDataObject

Setting data through <data-loader>

<protvista-variation length="770">
    <protvista-variation-adapter>
        <data-loader>
          <source src="https://www.ebi.ac.uk/proteins/api/variation/P05067" />
        </data-loader>
    </protvista-variation-adapter>
</protvista-variation>

API Reference

Properties

data: Object

{
      sequence: string,
      variants: [{
          accession: String,
          start: Number,
          end: Number,
          color?: String,
          tooltipContent?: String
      }]
}

height?: number (default 430)

The height of the visualisation (in px).

also see protvista-track