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:26
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:102
Atom count

type

{Integer}

Returns number

atomEnd

get atomEnd(): number

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

atomOffset

get atomOffset(): number

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

chainid

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

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

type

{String}

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

Parameters
- value: string
Returns void

chainname

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

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

type

{String}

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

Parameters
- value: string
Returns void

entity

get entity(): Entity

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

type

{Entity}

Returns Entity

entityIndex

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

- Defined in src/proxy/chain-proxy.ts:53
Returns number
- Defined in src/proxy/chain-proxy.ts:56
Parameters
- value: number
Returns void

model

get model(): ModelProxy

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

type

{ModelProxy}

Returns ModelProxy

modelIndex

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

- Defined in src/proxy/chain-proxy.ts:60
Returns number
- Defined in src/proxy/chain-proxy.ts:63
Parameters
- value: number
Returns void

residueCount

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

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

type

{Integer}

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

Parameters
- value: number
Returns void

residueEnd

get residueEnd(): number

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

residueOffset

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

- Defined in src/proxy/chain-proxy.ts:67
Returns number
- Defined in src/proxy/chain-proxy.ts:70
Parameters
- value: number
Returns void

Methods

clone

clone(): ChainProxy

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

Returns ChainProxy

cloned chain

eachAtom

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

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

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

eachPolymer

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

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

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

eachResidue

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

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

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

eachResidueN

eachResidueN(n: number, callback: function): void

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

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

qualifiedName

qualifiedName(): string

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

toObject

toObject(): object

- Defined in src/proxy/chain-proxy.ts:295
Returns object
- chainname: string
- index: number
- residueCount: number
- residueOffset: number

Generated using TypeDoc