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:39
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:90
Atom count

type

{Integer}

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

Parameters
- value: number
Returns void

atomEnd

get atomEnd(): number

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

atomOffset

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

- Defined in src/proxy/residue-proxy.ts:79
Returns number
- Defined in src/proxy/residue-proxy.ts:82
Parameters
- value: number
Returns void

backboneEndAtomIndex

get backboneEndAtomIndex(): number

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

backboneEndType

get backboneEndType(): number

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

backboneStartAtomIndex

get backboneStartAtomIndex(): number

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

backboneStartType

get backboneStartType(): number

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

backboneType

get backboneType(): number

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

chain

get chain(): ChainProxy

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

type

{ChainProxy}

Returns ChainProxy

chainIndex

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

- Defined in src/proxy/residue-proxy.ts:72
Returns number
- Defined in src/proxy/residue-proxy.ts:75
Parameters
- value: number
Returns void

chainid

get chainid(): string

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

type

{String}

Returns string

chainname

get chainname(): string

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

type

{String}

Returns string

direction1AtomIndex

get direction1AtomIndex(): number

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

direction2AtomIndex

get direction2AtomIndex(): number

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

entity

get entity(): Entity

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

type

{Entity}

Returns Entity

entityIndex

get entityIndex(): number

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

hetero

get hetero(): number

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

type

{Boolean}

Returns number

inscode

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

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

type

{String}

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

Parameters
- value: string
Returns void

modelIndex

get modelIndex(): number

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

moleculeType

get moleculeType(): number

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

residueType

get residueType(): ResidueType

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

resname

get resname(): string

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

type

{String}

Returns string

resno

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

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

type

{Integer}

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

Parameters
- value: number
Returns void

rungEndAtomIndex

get rungEndAtomIndex(): number

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

sstruc

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

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

type

{String}

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

Parameters
- value: string
Returns void

traceAtomIndex

get traceAtomIndex(): number

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

x

get x(): number

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

y

get y(): number

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

z

get z(): number

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

Methods

clone

clone(): ResidueProxy

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

Returns ResidueProxy

cloned residue

connectedTo

connectedTo(rNext: ResidueProxy): boolean

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

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

eachAtom

eachAtom(callback: function, selection?: Selection): void

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

Parameters
- callback: function
  
  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:511
Returns undefined | number[][]

getAtomIndexByName

getAtomIndexByName(atomname: string): undefined | number

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

getAtomType

getAtomType(index: number): AtomType

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

getAtomnameList

getAtomnameList(): any[]

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

getBackboneType

getBackboneType(position: number): number

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

getBonds

getBonds(): ResidueBonds

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

getNextConnectedResidue

getNextConnectedResidue(): undefined | ResidueProxy

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

getPreviousConnectedResidue

getPreviousConnectedResidue(residueProxy?: ResidueProxy): any

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

getResname1

getResname1(): string

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

getRings

getRings(): undefined | RingData

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

hasAtomWithName

hasAtomWithName(atomname: string): boolean

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

isCg

isCg(): boolean

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

Returns boolean

flag

isDna

isDna(): boolean

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

Returns boolean

flag

isHelix

isHelix(): boolean

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

Returns boolean

flag

isHetero

isHetero(): boolean

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

Returns boolean

flag

isIon

isIon(): boolean

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

Returns boolean

flag

isNucleic

isNucleic(): boolean

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

Returns boolean

flag

isPolymer

isPolymer(): boolean

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

Returns boolean

flag

isProtein

isProtein(): boolean

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

Returns boolean

flag

isRna

isRna(): boolean

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

Returns boolean

flag

isSaccharide

isSaccharide(): boolean

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

Returns boolean

flag

isSheet

isSheet(): boolean

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

Returns boolean

flag

isStandardAminoacid

isStandardAminoacid(): boolean

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

isStandardBase

isStandardBase(): boolean

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

isTurn

isTurn(): boolean

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

Returns boolean

flag

isWater

isWater(): boolean

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

Returns boolean

flag

positionToArray

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

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

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

target array

qualifiedName

qualifiedName(noResname?: boolean): string

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

toObject

toObject(): object

- Defined in src/proxy/residue-proxy.ts:533
Returns object
- atomCount: number
- atomOffset: number
- chainIndex: number
- index: number
- resname: string
- resno: number
- sstruc: string

Generated using TypeDoc