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 set	atomCount
public get	atomCount: Integer Atom count
public get	atomEnd
public	atomMap: AtomMap
public set	atomOffset
public get	atomOffset
public	atomStore: AtomStore
public get	backboneEndAtomIndex
public get	backboneEndType
public get	backboneStartAtomIndex
public get	backboneStartType
public get	backboneType
public get	chain: ChainProxy Chain
public set	chainIndex
public get	chainIndex
public	chainStore: ChainStore
public get	chainid: String Chain id
public get	chainname: String Chain name
public get	direction1AtomIndex
public get	direction2AtomIndex
public get	entity: Entity Entity
public get	entityIndex
public get	hetero: Boolean Hetero flag
public	index: Integer
public get	inscode: String Insertion code
public set	inscode
public get	modelIndex
public get	moleculeType
public	residueMap: ResidueMap
public	residueStore: ResidueStore
public get	residueType
public get	resname: String Residue name
public get	resno: Integer Residue number/label
public set	resno
public get	rungEndAtomIndex
public set	sstruc
public get	sstruc: String Secondary structure code
public	structure: Structure
public get	traceAtomIndex

Method Summary

Public Methods
public	clone(): ResidueProxy Clone object
public	connectedTo(rNext: ResidueProxy): Boolean If residue is connected to another
public	eachAtom(callback: function(atom: AtomProxy), selection: Selection): undefined Atom iterator
public	getAtomByName()
public	getAtomIndexByName()
public	getAtomType()
public	getAtomnameList()
public	getBackboneType()
public	getBonds()
public	getNextConnectedResidue()
public	getPreviousConnectedResidue()
public	getResname1()
public	getRings()
public	hasAtomWithName()
public	isCg(): Boolean If residue is coarse-grain
public	isDna(): Boolean If residue is dna
public	isHelix(): Boolean If residue is part of a helix
public	isHetero(): Boolean If residue is hetero
public	isIon(): Boolean If residue is an ion
public	isNucleic(): Boolean If residue is nucleic
public	isPolymer(): Boolean If residue is from a polymer
public	isProtein(): Boolean If residue is from a protein
public	isRna(): Boolean If residue is rna
public	isSaccharide(): Boolean If residue is a saccharide
public	isSheet(): Boolean If residue is part of a sheet
public	isTurn(): Boolean If residue is part of a turn
public	isWater(): Boolean If residue is a water molecule
public	qualifiedName()
public	toObject()

Public Constructors

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

Params:

Name	Type	Attribute	Description
structure	Structure		the structure
index	Integer		the index

Public Members

public set atomCount source

public get atomCount: Integer source

Atom count

public get atomEnd source

public atomMap: AtomMap source

public set atomOffset source

public get atomOffset source

public atomStore: AtomStore source

public get backboneEndAtomIndex source

public get backboneEndType source

public get backboneStartAtomIndex source

public get backboneStartType source

public get backboneType source

public get chain: ChainProxy source

Chain

public set chainIndex source

public get chainIndex source

public chainStore: ChainStore source

public get chainid: String source

Chain id

public get chainname: String source

Chain name

public get direction1AtomIndex source

public get direction2AtomIndex source

public get entity: Entity source

Entity

public get entityIndex source

public get hetero: Boolean source

Hetero flag

public index: Integer source

public get inscode: String source

Insertion code

public set inscode source

public get modelIndex source

public get moleculeType source

public residueMap: ResidueMap source

public residueStore: ResidueStore source

public get residueType source

public get resname: String source

Residue name

public get resno: Integer source

Residue number/label

public set resno source

public get rungEndAtomIndex source

public set sstruc source

public get sstruc: String source

Secondary structure code

public structure: Structure source

public get traceAtomIndex 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:

Name	Type	Attribute	Description
rNext	ResidueProxy		the other residue

Return:

Boolean

flag

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

Atom iterator

Params:

Name	Type	Attribute	Description
callback	function(atom: AtomProxy)		the callback
selection	Selection	optional	the selection

Return:

undefined

public getAtomByName() source

public getAtomIndexByName() source

public getAtomType() source

public getAtomnameList() source

public getBackboneType() source

public getBonds() source

public getNextConnectedResidue() source

public getPreviousConnectedResidue() source

public getResname1() source

public getRings() source

public hasAtomWithName() source

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