Class ResidueProxy

Residue proxy

Hierarchy

ResidueProxy

Index

Constructors

constructor

Properties

Constructors

constructor

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

- Defined in src/proxy/residue-proxy.ts:44
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

structure

structure: Structure

the structure

Accessors

atomCount

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

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

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

Parameters
- value: number
Returns void

atomEnd

get atomEnd(): number

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

atomOffset

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

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

backboneEndAtomIndex

get backboneEndAtomIndex(): number

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

backboneEndType

get backboneEndType(): number

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

backboneStartAtomIndex

get backboneStartAtomIndex(): number

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

backboneStartType

get backboneStartType(): number

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

backboneType

get backboneType(): number

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

chain

get chain(): ChainProxy

- Defined in src/proxy/residue-proxy.ts:73
Chain

Returns ChainProxy

chainIndex

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

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

chainid

get chainid(): string

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

Returns string

chainname

get chainname(): string

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

Returns string

direction1AtomIndex

get direction1AtomIndex(): number

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

direction2AtomIndex

get direction2AtomIndex(): number

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

entity

get entity(): Entity

- Defined in src/proxy/residue-proxy.ts:63
Entity

Returns Entity

entityIndex

get entityIndex(): number

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

hetero

get hetero(): number

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

Returns number

inscode

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

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

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

Parameters
- value: string
Returns void

modelIndex

get modelIndex(): number

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

moleculeType

get moleculeType(): number

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

residueType

get residueType(): ResidueType

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

resname

get resname(): string

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

Returns string

resno

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

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

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

Parameters
- value: number
Returns void

rungEndAtomIndex

get rungEndAtomIndex(): number

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

sstruc

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

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

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

Parameters
- value: string
Returns void

traceAtomIndex

get traceAtomIndex(): number

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

x

get x(): number

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

y

get y(): number

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

z

get z(): number

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

Methods

clone

clone(): ResidueProxy

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

Returns ResidueProxy

cloned residue

connectedTo

connectedTo(rNext: ResidueProxy): boolean

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

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

eachAtom

eachAtom(callback: (ap: AtomProxy) => void, selection?: Selection): void

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

Parameters
- callback: (ap: AtomProxy) => void
  
  the callback
  - - (ap: AtomProxy): void
    - Parameters
      - ap: AtomProxy
      Returns void
- Optional selection: Selection
Returns void

getAromaticRings

getAromaticRings(): undefined | number[][]

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

getAtomIndexByName

getAtomIndexByName(atomname: string): undefined | number

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

getAtomType

getAtomType(index: number): AtomType

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

getAtomnameList

getAtomnameList(): any[]

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

getBackboneType

getBackboneType(position: number): number

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

getBonds

getBonds(): ResidueBonds

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

getNextConnectedResidue

getNextConnectedResidue(): undefined | ResidueProxy

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

getPreviousConnectedResidue

getPreviousConnectedResidue(residueProxy?: ResidueProxy): any

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

getResname1

getResname1(): string

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

getRings

getRings(): RingData | undefined

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

hasAtomWithName

hasAtomWithName(atomname: string): boolean

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

isCg

isCg(): boolean

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

Returns boolean

flag

isDna

isDna(): boolean

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

Returns boolean

flag

isHelix

isHelix(): boolean

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

Returns boolean

flag

isHetero

isHetero(): boolean

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

Returns boolean

flag

isIon

isIon(): boolean

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

Returns boolean

flag

isNucleic

isNucleic(): boolean

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

Returns boolean

flag

isPolymer

isPolymer(): boolean

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

Returns boolean

flag

isProtein

isProtein(): boolean

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

Returns boolean

flag

isRna

isRna(): boolean

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

Returns boolean

flag

isSaccharide

isSaccharide(): boolean

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

Returns boolean

flag

isSheet

isSheet(): boolean

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

Returns boolean

flag

isStandardAminoacid

isStandardAminoacid(): boolean

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

isStandardBase

isStandardBase(): boolean

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

isTurn

isTurn(): boolean

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

Returns boolean

flag

isWater

isWater(): boolean

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

Returns boolean

flag

positionToArray

positionToArray(array?: NumberArray, offset?: number): Uint8Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Float32Array | Uint8ClampedArray | Float64Array | number[]

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

Parameters
- Default value array: NumberArray = []
- Default value offset: number = 0
Returns Uint8Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Float32Array | Uint8ClampedArray | Float64Array | number[]

target array

qualifiedName

qualifiedName(noResname?: boolean): string

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

toObject

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

- Defined in src/proxy/residue-proxy.ts:538
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