NGL@0.10.4 Home Manual Reference Source GalleryRepository
import ResidueProxy from 'ngl/src/proxy/residue-proxy.js'
public class | source

ResidueProxy

Residue proxy

Constructor Summary

Public Constructor
public

constructor(structure: Structure, index: Integer)

Member Summary

Public Members
public get

Atom count

public

atomMap: AtomMap

public
public get

Chain

public
public get

Chain id

public get

Chain name

public get

Entity

public get

Hetero flag

public
public get

Insertion code

public

residueMap: ResidueMap

public
public get

Residue name

public get

Residue number/label

public get

Secondary structure code

public

Method Summary

Public Methods
public

Clone object

public

If residue is connected to another

public

eachAtom(callback: function(atom: AtomProxy), selection: Selection): undefined

Atom iterator

public

If residue is coarse-grain

public

If residue is dna

public

If residue is part of a helix

public

If residue is hetero

public

If residue is an ion

public

If residue is nucleic

public

If residue is from a polymer

public

If residue is from a protein

public

If residue is rna

public

If residue is a saccharide

public

If residue is part of a sheet

public

If residue is part of a turn

public

If residue is a water molecule

Public Constructors

public constructor(structure: Structure, index: Integer) source

Params:

NameTypeAttributeDescription
structure Structure

the structure

index Integer

the index

Public Members

public get atomCount: Integer source

Atom count

public atomMap: AtomMap source

public atomStore: AtomStore source

public get chain: ChainProxy source

Chain

public chainStore: ChainStore source

public get chainid: String source

Chain id

public get chainname: String source

Chain name

public get entity: Entity source

Entity

public get hetero: Boolean source

Hetero flag

public index: Integer source

public get inscode: String source

Insertion code

public residueMap: ResidueMap source

public residueStore: ResidueStore source

public get resname: String source

Residue name

public get resno: Integer source

Residue number/label

public get sstruc: String source

Secondary structure code

public structure: Structure source

Public Methods

public clone(): ResidueProxy source

Clone object

Return:

ResidueProxy

cloned residue

public connectedTo(rNext: ResidueProxy): Boolean source

If residue is connected to another

Params:

NameTypeAttributeDescription
rNext ResidueProxy

the other residue

Return:

Boolean

flag

public eachAtom(callback: function(atom: AtomProxy), selection: Selection): undefined source

Atom iterator

Params:

NameTypeAttributeDescription
callback function(atom: AtomProxy)

the callback

selection Selection
  • optional

the selection

Return:

undefined

public isCg(): Boolean source

If residue is coarse-grain

Return:

Boolean

flag

public isDna(): Boolean source

If residue is dna

Return:

Boolean

flag

public isHelix(): Boolean source

If residue is part of a helix

Return:

Boolean

flag

public isHetero(): Boolean source

If residue is hetero

Return:

Boolean

flag

public isIon(): Boolean source

If residue is an ion

Return:

Boolean

flag

public isNucleic(): Boolean source

If residue is nucleic

Return:

Boolean

flag

public isPolymer(): Boolean source

If residue is from a polymer

Return:

Boolean

flag

public isProtein(): Boolean source

If residue is from a protein

Return:

Boolean

flag

public isRna(): Boolean source

If residue is rna

Return:

Boolean

flag

public isSaccharide(): Boolean source

If residue is a saccharide

Return:

Boolean

flag

public isSheet(): Boolean source

If residue is part of a sheet

Return:

Boolean

flag

public isTurn(): Boolean source

If residue is part of a turn

Return:

Boolean

flag

public isWater(): Boolean source

If residue is a water molecule

Return:

Boolean

flag