Skip to content
Snippets Groups Projects
Commit f701abb1 authored by Lukas Pravda's avatar Lukas Pravda
Browse files

improve readme and changelog

parent 918c1b39
No related branches found
No related tags found
No related merge requests found
Pipeline #151274 passed with stages
in 51 seconds
## RELEASE 1.0 - 28 April 2021
* Support to display atom names
* Use `pdbeccdutils=0.6` data
* Minor bug fixes
## RELEASE 0.2 - 24 February 2020
Component rembranded to `pdb-ligand-env`
Component rebranded to `pdb-ligand-env`
### Features
......
# PDB ligand environment component
This is a web-component to display ligand structure in 2D along with its interactions. Ligand can be perceived as a set of covalently linked pdb residues (refered to as bound molecule) or a single pdb residue. This depiction can be enriched with a substructure highlight and binding site interactions.
This is a web-component to display ligand structure in 2D along with its interactions. Ligand can be perceived as a set of covalently linked pdb residues (refered to as bound molecule) or a single pdb residue. This depiction can be enriched with a substructure highlight, atom names, and binding site interactions.
## Step after cloning (use local server to see demo pages)
......@@ -133,6 +133,8 @@ let uiParams = {
help: false, // allow help option from the component menu
residueLabel: true, // show residue label
tooltip: true // show residue tooltip on mouse hover
menu: true // allow menu to be (not) available
names: true // allow ligand depiction with atom names
};
this.display = new Visualization(this, uiParams, environment);
......@@ -144,8 +146,8 @@ this.display.initCarbohydratePolymerInteractions('5e98', 'bm1','3');
// to display ligand interactions
this.display.initLigandInteractions('1cbs', 200, 'A');
// to display chemical component only
this.display.initLigandDisplay('HEM');
// to display chemical component with atom names only
this.display.initLigandDisplay('HEM', true);
````
## Parameters
......@@ -160,4 +162,5 @@ this.display.initLigandDisplay('HEM');
| substructure | string[] | No | List of atom names to be highlighted on the ligand structure |
| color | string | No | HEX representation of the color highlight. `(Default: #D3D3D3)` |
| zoom-on | boolean | No | Allow zoom functionality on the component level. |
| names-on | boolean | No | Allow ligand depiction to be displayed with atom names. |
| environment | string | No | What data should be used: one of `production`, `development`, `internal` or a shorthand `prod`, `dev`, `int`. |
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment