Class ChainProxy

Chain proxy

Hierarchy

ChainProxy

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

- Defined in src/proxy/chain-proxy.ts:28
Parameters
- structure: Structure
  
  the structure
- Default value index: number = 0
  
  the index
Returns ChainProxy

Properties

chainStore

chainStore: ChainStore

index

index: number

residueStore

residueStore: ResidueStore

structure

structure: Structure

the structure

Accessors

atomCount

get atomCount(): number

- Defined in src/proxy/chain-proxy.ts:104
Atom count

Returns number

atomEnd

get atomEnd(): number

- Defined in src/proxy/chain-proxy.ts:94
Returns number

atomOffset

get atomOffset(): number

- Defined in src/proxy/chain-proxy.ts:91
Returns number

chainid

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

- Defined in src/proxy/chain-proxy.ts:129
Chain id

Returns string
- Defined in src/proxy/chain-proxy.ts:132
Chain id

Parameters
- value: string
Returns void

chainname

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

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

Returns string
- Defined in src/proxy/chain-proxy.ts:121
Chain name

Parameters
- value: string
Returns void

entity

get entity(): Entity

- Defined in src/proxy/chain-proxy.ts:44
Entity

Returns Entity

entityIndex

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

- Defined in src/proxy/chain-proxy.ts:55
Returns number
- Defined in src/proxy/chain-proxy.ts:58
Parameters
- value: number
Returns void

model

get model(): ModelProxy

- Defined in src/proxy/chain-proxy.ts:51
Model

Returns ModelProxy

modelIndex

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

- Defined in src/proxy/chain-proxy.ts:62
Returns number
- Defined in src/proxy/chain-proxy.ts:65
Parameters
- value: number
Returns void

residueCount

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

- Defined in src/proxy/chain-proxy.ts:80
Residue count

Returns number
- Defined in src/proxy/chain-proxy.ts:83
Residue count

Parameters
- value: number
Returns void

residueEnd

get residueEnd(): number

- Defined in src/proxy/chain-proxy.ts:87
Returns number

residueOffset

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

- Defined in src/proxy/chain-proxy.ts:69
Returns number
- Defined in src/proxy/chain-proxy.ts:72
Parameters
- value: number
Returns void

Methods

clone

clone(): ChainProxy

- Defined in src/proxy/chain-proxy.ts:293
Clone object

Returns ChainProxy

cloned chain

eachAtom

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

- Defined in src/proxy/chain-proxy.ts:144
Atom iterator

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

eachPolymer

eachPolymer(callback: (p: Polymer) => void, selection?: Selection): void

- Defined in src/proxy/chain-proxy.ts:217
Polymer iterator

Parameters
- callback: (p: Polymer) => void
  
  the callback
  - - (p: Polymer): void
    - Parameters
      - p: Polymer
      Returns void
- Optional selection: Selection
Returns void

eachResidue

eachResidue(callback: (rp: ResidueProxy) => void, selection?: Selection): void

- Defined in src/proxy/chain-proxy.ts:156
Residue iterator

Parameters
- callback: (rp: ResidueProxy) => void
  
  the callback
  - - (rp: ResidueProxy): void
    - Parameters
      - rp: ResidueProxy
      Returns void
- Optional selection: Selection
Returns void

eachResidueN

eachResidueN(n: number, callback: (...rpArray: ResidueProxy[]) => void): void

- Defined in src/proxy/chain-proxy.ts:191
Multi-residue iterator

Parameters
- n: number
  
  window size
- callback: (...rpArray: ResidueProxy[]) => void
  
  the callback
  - - (...rpArray: ResidueProxy[]): void
    - Parameters
      - Rest ...rpArray: ResidueProxy[]
      Returns void
Returns void

qualifiedName

qualifiedName(): string

- Defined in src/proxy/chain-proxy.ts:284
Returns string

toObject

toObject(): { chainname: string; index: number; residueCount: number; residueOffset: number }

- Defined in src/proxy/chain-proxy.ts:297
Returns { chainname: string; index: number; residueCount: number; residueOffset: number }
- chainname: string
- index: number
- residueCount: number
- residueOffset: number

Generated using TypeDoc