Class ResidueProxy

Residue proxy

Hierarchy

ResidueProxy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ResidueProxy(structure: Structure, index?: number): ResidueProxy

- Defined in backend/src/proxy/residue-proxy.ts:47
Parameters
- structure: Structure
  
  the structure
- Default value index: number = 0
  
  the index
Returns ResidueProxy

Properties

atomMap

atomMap: AtomMap

atomStore

atomStore: AtomStore

chainStore

chainStore: ChainStore

index

index: number

residueMap

residueMap: ResidueMap

residueStore

residueStore: ResidueStore

Readonly structure

structure: Structure

the structure

Accessors

atomCount

get atomCount(): number
set atomCount(value: number): void

- Defined in backend/src/proxy/residue-proxy.ts:98
Atom count

Returns number
- Defined in backend/src/proxy/residue-proxy.ts:101
Atom count

Parameters
- value: number
Returns void

atomEnd

get atomEnd(): number

- Defined in backend/src/proxy/residue-proxy.ts:105
Returns number

atomOffset

get atomOffset(): number
set atomOffset(value: number): void

- Defined in backend/src/proxy/residue-proxy.ts:87
Returns number
- Defined in backend/src/proxy/residue-proxy.ts:90
Parameters
- value: number
Returns void

backboneEndAtomIndex

get backboneEndAtomIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:208
Returns number

backboneEndType

get backboneEndType(): number

- Defined in backend/src/proxy/residue-proxy.ts:193
Returns number

backboneStartAtomIndex

get backboneStartAtomIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:205
Returns number

backboneStartType

get backboneStartType(): number

- Defined in backend/src/proxy/residue-proxy.ts:190
Returns number

backboneType

get backboneType(): number

- Defined in backend/src/proxy/residue-proxy.ts:187
Returns number

chain

get chain(): ChainProxy

- Defined in backend/src/proxy/residue-proxy.ts:76
Chain

Returns ChainProxy

chainIndex

get chainIndex(): number
set chainIndex(value: number): void

- Defined in backend/src/proxy/residue-proxy.ts:80
Returns number
- Defined in backend/src/proxy/residue-proxy.ts:83
Parameters
- value: number
Returns void

chainid

get chainid(): string

- Defined in backend/src/proxy/residue-proxy.ts:125
Chain id

Returns string

chainname

get chainname(): string

- Defined in backend/src/proxy/residue-proxy.ts:118
Chain name

Returns string

direction1AtomIndex

get direction1AtomIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:199
Returns number

direction2AtomIndex

get direction2AtomIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:202
Returns number

entity

get entity(): Entity

- Defined in backend/src/proxy/residue-proxy.ts:66
Entity

Returns Entity

entityIndex

get entityIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:69
Returns number

hetero

get hetero(): number

- Defined in backend/src/proxy/residue-proxy.ts:181
Hetero flag

Returns number

inscode

get inscode(): string
set inscode(value: string): void

- Defined in backend/src/proxy/residue-proxy.ts:157
Insertion code

Returns string
- Defined in backend/src/proxy/residue-proxy.ts:160
Insertion code

Parameters
- value: string
Returns void

modelIndex

get modelIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:111
Returns number

moleculeType

get moleculeType(): number

- Defined in backend/src/proxy/residue-proxy.ts:184
Returns number

residueType

get residueType(): ResidueType

- Defined in backend/src/proxy/residue-proxy.ts:166
Returns ResidueType

resname

get resname(): string

- Defined in backend/src/proxy/residue-proxy.ts:174
Residue name

Returns string

resno

get resno(): number
set resno(value: number): void

- Defined in backend/src/proxy/residue-proxy.ts:135
Residue number/label

Returns number
- Defined in backend/src/proxy/residue-proxy.ts:138
Residue number/label

Parameters
- value: number
Returns void

rungEndAtomIndex

get rungEndAtomIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:211
Returns number

sstruc

get sstruc(): string
set sstruc(value: string): void

- Defined in backend/src/proxy/residue-proxy.ts:146
Secondary structure code

Returns string
- Defined in backend/src/proxy/residue-proxy.ts:149
Secondary structure code

Parameters
- value: string
Returns void

traceAtomIndex

get traceAtomIndex(): number

- Defined in backend/src/proxy/residue-proxy.ts:196
Returns number

x

get x(): number

- Defined in backend/src/proxy/residue-proxy.ts:217
Returns number

y

get y(): number

- Defined in backend/src/proxy/residue-proxy.ts:225
Returns number

z

get z(): number

- Defined in backend/src/proxy/residue-proxy.ts:233
Returns number

Methods

clone

clone(): ResidueProxy

- Defined in backend/src/proxy/residue-proxy.ts:543
Clone object

Returns ResidueProxy

cloned residue

connectedTo

connectedTo(rNext: ResidueProxy): boolean

- Defined in backend/src/proxy/residue-proxy.ts:469
If residue is connected to another

Parameters
- rNext: ResidueProxy
  
  the other residue
Returns boolean
- flag

eachAtom

eachAtom(callback: (ap: AtomProxy) => void, filter?: Filter): void

- Defined in backend/src/proxy/residue-proxy.ts:249
Atom iterator

Parameters
- callback: (ap: AtomProxy) => void
  
  the callback
  - - (ap: AtomProxy): void
    - Parameters
      - ap: AtomProxy
      Returns void
- Optional filter: Filter
Returns void

getAromaticRings

getAromaticRings(): undefined | number[][]

- Defined in backend/src/proxy/residue-proxy.ts:525
Returns undefined | number[][]

getAtomCentroid

getAtomCentroid(predicate?: undefined | ((a: AtomProxy) => boolean)): Vector3

- Defined in backend/src/proxy/residue-proxy.ts:575
Computes the centroid of the atoms for whose predicate returns true.

Parameters
- Optional predicate: undefined | ((a: AtomProxy) => boolean)
Returns Vector3

getAtomIndexByName

getAtomIndexByName(atomname: string): undefined | number

- Defined in backend/src/proxy/residue-proxy.ts:440
Parameters
- atomname: string
Returns undefined | number

getAtomType

getAtomType(index: number): AtomType

- Defined in backend/src/proxy/residue-proxy.ts:420
Parameters
- index: number
Returns AtomType

getAtomnameList

getAtomnameList(): any[]

- Defined in backend/src/proxy/residue-proxy.ts:452
Returns any[]

getBackboneCentroid

getBackboneCentroid(): Vector3

- Defined in backend/src/proxy/residue-proxy.ts:564
Returns Vector3

getBackboneType

getBackboneType(position: number): number

- Defined in backend/src/proxy/residue-proxy.ts:429
Parameters
- position: number
Returns number

getBonds

getBonds(): ResidueBonds

- Defined in backend/src/proxy/residue-proxy.ts:517
Returns ResidueBonds

getNextConnectedResidue

getNextConnectedResidue(): undefined | ResidueProxy

- Defined in backend/src/proxy/residue-proxy.ts:479
Returns undefined | ResidueProxy

getPreviousConnectedResidue

getPreviousConnectedResidue(residueProxy?: ResidueProxy): any

- Defined in backend/src/proxy/residue-proxy.ts:497
Parameters
- Optional residueProxy: ResidueProxy
Returns any

getResname1

getResname1(): string

- Defined in backend/src/proxy/residue-proxy.ts:424
Returns string

getRings

getRings(): RingData | undefined

- Defined in backend/src/proxy/residue-proxy.ts:521
Returns RingData | undefined

getSidechainCentroid

getSidechainCentroid(): Vector3

- Defined in backend/src/proxy/residue-proxy.ts:568
Returns Vector3

hasAtomWithName

hasAtomWithName(atomname: string): boolean

- Defined in backend/src/proxy/residue-proxy.ts:448
Parameters
- atomname: string
Returns boolean

isCg

isCg(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:324
If residue is coarse-grain

Returns boolean

flag

isDna

isDna(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:316
If residue is dna

Returns boolean

flag

isHelix

isHelix(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:394
If residue is part of a helix

Returns boolean

flag

isHetero

isHetero(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:354
If residue is hetero

Returns boolean

flag

isIon

isIon(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:370
If residue is an ion

Returns boolean

flag

isLigand

isLigand(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:416
Returns boolean

isNucleic

isNucleic(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:299
If residue is nucleic

Returns boolean

flag

isPolymer

isPolymer(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:337
If residue is from a polymer

Returns boolean

flag

isProtein

isProtein(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:291
If residue is from a protein

Returns boolean

flag

isRna

isRna(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:308
If residue is rna

Returns boolean

flag

isSaccharide

isSaccharide(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:378
If residue is a saccharide

Returns boolean

flag

isSheet

isSheet(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:402
If residue is part of a sheet

Returns boolean

flag

isStandardAminoacid

isStandardAminoacid(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:382
Returns boolean

isStandardBase

isStandardBase(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:386
Returns boolean

isTurn

isTurn(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:410
If residue is part of a turn

Returns boolean

flag

isWater

isWater(): boolean

- Defined in backend/src/proxy/residue-proxy.ts:362
If residue is a water molecule

Returns boolean

flag

positionToArray

positionToArray(array?: NumberArray, offset?: number): NumberArray

- Defined in backend/src/proxy/residue-proxy.ts:277
Write residue center position to array

Parameters
- Default value array: NumberArray = []
- Default value offset: number = 0
Returns NumberArray

target array

qualifiedName

qualifiedName(noResname?: boolean): string

- Defined in backend/src/proxy/residue-proxy.ts:529
Parameters
- Default value noResname: boolean = false
Returns string

removeAtomWhere

removeAtomWhere(predicate: (a: AtomProxy) => boolean): void

- Defined in backend/src/proxy/residue-proxy.ts:593
Parameters
- predicate: (a: AtomProxy) => boolean
  - - (a: AtomProxy): boolean
    - Parameters
      - a: AtomProxy
      Returns boolean
Returns void

removeAtomsWhere

removeAtomsWhere(predicate: (a: AtomProxy) => boolean): void

- Defined in backend/src/proxy/residue-proxy.ts:597
Parameters
- predicate: (a: AtomProxy) => boolean
  - - (a: AtomProxy): boolean
    - Parameters
      - a: AtomProxy
      Returns boolean
Returns void

removeHAtomFromNH2

removeHAtomFromNH2(): void

- Defined in backend/src/proxy/residue-proxy.ts:642
Returns void

removeOHAtomsfromCOOH

removeOHAtomsfromCOOH(): void

- Defined in backend/src/proxy/residue-proxy.ts:602
Returns void

toObject

toObject(): { atomCount: number; atomOffset: number; chainIndex: number; index: number; resname: string; resno: number; sstruc: string }

- Defined in backend/src/proxy/residue-proxy.ts:547
Returns { atomCount: number; atomOffset: number; chainIndex: number; index: number; resname: string; resno: number; sstruc: string }
- atomCount: number
- atomOffset: number
- chainIndex: number
- index: number
- resname: string
- resno: number
- sstruc: string

Generated using TypeDoc